A.1.11 Проверка входных параметров в oct-файлах

Поскольку oct-файлы являются компилируемыми функциями, их вызов может привести к аварийному завершению Octave из-за неосторожных вызовов функций или ошибок памяти. Крайне важно, чтобы каждая функция выполняла достаточную проверку параметров, чтобы обеспечить корректную работу Octave.

Минимальное требование, как уже обсуждалось, — проверить количество входных аргументов перед их использованием, чтобы избежать обращения к несуществующему аргументу. Однако в некоторых случаях этого может быть недостаточно, поскольку нижележащий код накладывает дополнительные ограничения. Например, вызов внешней функции может быть не определён, если входные аргументы не являются целыми числами, если один из аргументов равен нулю или если входные данные являются комплексными, а ожидалось действительное значение. Поэтому для oct-файлов часто требуется дополнительная проверка входных параметров.

В Octave есть несколько функций, которые могут быть полезны для проверки параметров. К ним относятся методы класса octave_value, такие как is_real_matrix, is_numeric_type и т. д. (см. ov.h). Часто, зная язык m-файлов Octave, можно предположить, какая C++-процедура соответствует им. Кроме того, существуют и более специализированные функции проверки входных данных; некоторые из них показаны ниже.

#include <octave/oct.h>

DEFUN_DLD (paramdemo, args, nargout, "Parameter Check Demo")
{
  if (args.length () != 1)
    print_usage ();

  NDArray m = args(0).array_value ();

  double min_val = -10.0;
  double max_val = 10.0;

  octave_stdout << "Properties of input array:\n";

  if (m.any_element_is_negative ())
    octave_stdout << "  includes negative values\n";

  if (m.any_element_is_inf_or_nan ())
    octave_stdout << "  includes Inf or NaN values\n";

  if (m.any_element_not_one_or_zero ())
    octave_stdout << "  includes other values than 1 and 0\n";

  if (m.all_elements_are_int_or_inf_or_nan ())
    octave_stdout << "  includes only int, Inf or NaN values\n";

  if (m.all_integers (min_val, max_val))
    octave_stdout << "  includes only integers in [-10,10]\n";

  return octave_value_list ();
}

Пример использования:

paramdemo ([1, 2, NaN, Inf])
⇒ Properties of input array:
     includes Inf or NaN values
     includes other values than 1 and 0
     includes only int, Inf or NaN values