mxGetElementSize (C)

Количество байтов, необходимых для хранения каждого элемента данных

Для комплексного mxArray созданный с перемеженным комплексным API, mxGetElementSize возвращает в два раза больше значения, которое возвращает функция в отдельном комплексном API. Для получения дополнительной информации см. раздел Вопросов совместимости.

Синтаксис C

#include "matrix.h"
size_t mxGetElementSize(const mxArray *pm);

Описание

Звонить mxGetElementSize для определения количества байтов в каждом элементе данных mxArray. Для примера, если MATLAB® класс mxArray является int16, а mxArray сохраняет каждый элемент данных как 16-битное (2-байтовое) целое число со знаком. Таким образом, mxGetElementSize возвращает 2.

mxGetElementSize полезно при использовании стандартной программы, отличной от MATLAB, для манипулирования элементами данных. Для примера - функция C memcpy требуется размер элементов, которые вы хотите скопировать.

Входные параметры

расширить все

Указатель на mxArray, заданный как const mxArray*.

Выходные аргументы

расширить все

Количество байтов, необходимых для хранения одного элемента заданного mxArray, возвращается как size_t.

Если pm является комплексным числом, тогда данные в выходном аргументе зависят от того, какую версию API C Matrix вы используете.

  • Если вы строите с перемеженным комплексным API (mex -R2018a Опция), затем возврат значение sizeof(std::complex<T>), где T - тип данных массива.

  • Если вы строите с отдельным комплексным API (mex -R2017b опция), затем функция возвращает количество байтов для типа данных массива независимо от того, является ли массив комплексным или вещественным.

Если pm Точки к камере или структуре, затем mxGetElementSize возвращает размер указателя. Функция не возвращает размер всех элементов в каждой камере или поле структуры.

Возвращает 0 при отказе. Основной причиной отказа является то, что pm указывает на mxArray имеющий непризнанный класс.

Примеры

См. эти примеры в matlabroot/ extern/examples/refbook:

Вопросы совместимости

расширить все

Поведение изменено в R2018a

См. также

|

Представлено до R2006a