A.1.2 Матрицы и массивы в файлах Oct

Octave поддерживает ряд различных классов массивов и матриц, большинство из которых основаны на классе Array. Исключение составляют типы разреженных матриц, обсуждаемые отдельно ниже. Существует три основных типа матриц:

Matrix

Класс матриц двойной точности, определенный в dMatrix.h

ComplexMatrix

Класс матриц комплексного типа, определенный в CMatrix.h

BoolMatrix

Класс матриц булевого типа, определенный в boolMatrix.h

Это основные двумерные типы матриц Octave. Кроме того, существуют ряд многомерных типов массивов, включая

NDArray

Класс массивов двойной точности, определенный в dNDArray.h

ComplexNDarray

Класс комплексных массивов, определенный в CNDArray.h

boolNDArray

Класс булевых массивов, определенный в boolNDArray.h

int8NDArray

int16NDArray

int32NDArray

int64NDArray

Классы массивов со знаками 8, 16, 32 и 64-разрядной точностью, определённые в int8NDArray.h, int16NDArray.h и т.д.

uint8NDArray

uint16NDArray

uint32NDArray

uint64NDArray

Классы массивов без знаков 8, 16, 32 и 64-разрядной точностью, определённые в uint8NDArray.h, uint16NDArray.h и т.д.

Существует несколько основных способов построения матриц или многомерных массивов. Используя класс Matrix в качестве примера, можно

• Создать пустую матрицу или массив с помощью пустого конструктора. Например:

  Matrix a;

  Это можно использовать для всех типов матриц и массивов.

• Определить размерности матрицы или массива с помощью dim_vector, имеющей те же характеристики, что и вектор, возвращаемый из size. Например:

  dim_vector dv (2, 3);  // 2 rows, 3 columns
  Matrix a (dv);

  Это можно использовать для всех типов матриц и массивов.

• Определить количество строк и столбцов в матрице. Например:

  Matrix a (2, 2)

  Этот конструктор можно использовать только с типами матриц.

Все эти типы имеют ряд общих методов и операторов. Многие из них похожи на функции, существующие в интерпретаторе. К числу полезных методов относятся:

Метод: T& operator () (octave_idx_type)

Метод: T& elem (octave_idx_type)

Оператор () или метод elem позволяют читать или устанавливать значения матрицы или массива. Эти методы принимают один аргумент типа octave_idx_type, который является индексом в матрице или массиве. Кроме того, тип матрицы допускает версии оператора () и метода elem с двумя аргументами, предоставляя строковый и столбцовый индексы значения для получения или установки.

Обратите внимание, что эти функции выполняют значительную проверку ошибок, поэтому в некоторых случаях пользователь может предпочесть напрямую получить доступ к данным массива или матрицы с помощью метода fortran_vec, обсуждаемого ниже.

Метод: octave_idx_type numel (void) const

Общее количество элементов в матрице или массиве.

Метод: size_t byte_size (void) const

Количество байтов, используемых для хранения матрицы или массива.

Метод: dim_vector dims (void) const

Размерности матрицы или массива в значениях типа dim_vector.

Метод: int ndims (void) const

Количество измерений матрицы или массива. Матрицы всегда 2-мерные, а массивы могут быть N-мерными.

Метод: void resize (const dim_vector&)

Метод: void resize (nrows, ncols)

Метод, принимающий либо аргумент типа dim_vector, или, в случае матрицы, два аргумента типа octave_idx_type, определяющие количество строк и столбцов в матрице.

Метод: T* fortran_vec (void)

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

Операторы, такие как +, -, или *, могут использоваться для большинства типов матриц и массивов. Кроме того, есть ряд методов, представляющих интерес только для матриц, таких как transpose, hermitian, solve и т.д.

Типичный способ извлечения матрицы или массива из входных аргументов функции DEFUN_DLD следующий

#include <octave/oct.h>

DEFUN_DLD (addtwomatrices, args, , "Add A to B")
{
  if (args.length () != 2)
    print_usage ();

  NDArray A = args(0).array_value ();
  NDArray B = args(1).array_value ();

  return octave_value (A + B);
}

Чтобы избежать ошибок сегментации, приводящих к завершению работы Octave, эта функция явно проверяет наличие достаточного количества аргументов перед обращением к этим аргументам. Затем она получает два многомерных массива типа NDArray и складывает их. Обратите внимание, что метод array_value вызывается без использования метода is_matrix_type. Если при попытке извлечь значение произойдет ошибка, Octave выведет сообщение и бросит исключение. Причина предпочтения этой структуры кодирования заключается в том, что аргументы могут быть не типом NDArray, но для которого имеет смысл их преобразовать в него. Метод array_value позволяет выполнять это преобразование прозрачно, когда это возможно. Если вам нужно поймать такие ошибки и выполнить какую-либо очистку или другую операцию, вы можете поймать исключение octave_execution_error.

A + B, работая с двумя объектами NDArray, возвращает NDArray, который при возвращении из функции преобразуется в octave_value. Пример использования этой демонстрационной функции:

addtwomatrices (ones (2, 2), eye (2, 2))
      ⇒  2  1
          1  2

Ниже приведен список основных типов Matrix и Array, методы извлечения этих типов из octave_value, а также соответствующий заголовочный файл.