A.2.2 Работа с матрицами и массивами в mex-файлах

Базовый тип mex для всех переменных — mxArray. Любой объект, например матрица, массив ячеек или структура, хранится в этом базовом типе. mxArray выполняет практически ту же функцию, что и класс octave_value в oct-файлах: он служит контейнером для всех более специализированных типов.

Структура mxArray содержит как минимум имя представляемой ею переменной, её размерности, тип и указание на то, является ли переменная вещественной или комплексной. В зависимости от типа mxArray она также может содержать ряд дополнительных полей. Существует несколько функций для создания структур mxArray, включая mxCreateDoubleMatrix, mxCreateCellArray, mxCreateSparse и универсальную функцию mxCreateNumericArray.

Основная функция для доступа к данным массива — mxGetPr. Поскольку интерфейс mex предполагает, что вещественная и мнимая части комплексного массива хранятся отдельно, существует эквивалентная функция mxGetPi, которая получает мнимую часть. Обе эти функции предназначены только для матриц двойной точности. Универсальные функции mxGetData и mxGetImagData выполняют ту же операцию для всех типов матриц. Например:

mxArray *m;
mwSize *dims;
UINT32_T *pr;

dims = (mwSize *) mxMalloc (2 * sizeof (mwSize));
dims[0] = 2; dims[1] = 2;
m = mxCreateNumericArray (2, dims, mxUINT32_CLASS, mxREAL);
pr = (UINT32_T *) mxGetData (m);

Существуют также функции mxSetPr и т. д., выполняющие обратное действие: они задают данные массива, используя блок памяти, на который указывает аргумент mxSetPr.

Обратите внимание, что использованные выше типы mwSize и mwIndex определяются в соответствии с собственной точностью индексации Octave на платформе, для которой собирается mex-файл. Благодаря этому mex-файлы поддерживаются как на 32-, так и на 64-разрядных платформах. mwSize используется для задания размерностей массива и максимального числа элементов, тогда как mwIndex используется для индексации массивов.

В файле mypow2.c, приведённом ниже, показан пример работы с произвольными вещественными или комплексными массивами двойной точности.

#include "mex.h"

void
mexFunction (int nlhs, mxArray *plhs[],
             int nrhs, const mxArray *prhs[])
{
  mwSize n;
  mwIndex i;
  double *vri, *vro;

  if (nrhs != 1 || ! mxIsDouble (prhs[0]))
    mexErrMsgTxt ("ARG1 must be a double matrix");

  n = mxGetNumberOfElements (prhs[0]);
  plhs[0] = mxCreateNumericArray (mxGetNumberOfDimensions (prhs[0]),
                                  mxGetDimensions (prhs[0]),
                                  mxGetClassID (prhs[0]),
                                  mxIsComplex (prhs[0]));
  vri = mxGetPr (prhs[0]);
  vro = mxGetPr (plhs[0]);

  if (mxIsComplex (prhs[0]))
    {
      double *vii, *vio;
      vii = mxGetPi (prhs[0]);
      vio = mxGetPi (plhs[0]);

      for (i = 0; i < n; i++)
        {
          vro[i] = vri[i] * vri[i] - vii[i] * vii[i];
          vio[i] = 2 * vri[i] * vii[i];
        }
    }
  else
    {
      for (i = 0; i < n; i++)
        vro[i] = vri[i] * vri[i];
    }
}

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

b = randn (4,1) + 1i * randn (4,1);
all (b.^2 == mypow2 (b))
⇒ 1

В приведённом выше примере для работы с размерностями многомерных массивов используются функции mxGetDimensions, mxGetNumberOfElements и mxGetNumberOfDimensions. Функции mxGetM и mxGetN также позволяют получить число строк и столбцов двумерной матрицы (матрицы MxN).