Матричный API на C

Напишите программы на C/C + +, которые работают с MATLAB^® mxArray структура данных

Чтобы записать программы на C, которые работают с MATLAB R2017b или ранее, используйте функции в Matrix API на C. Эти функции работают с mxArray структура данных и используются для создания функций C MEX или приложений C engine.

Примечание

MathWorks рекомендует по возможности выбирать приложения C++ over C. Для получения дополнительной информации см. Вызов MATLAB из библиотек C++ или C++ в MATLAB, чтобы непосредственно вызвать функциональность библиотеки C++ из MATLAB.

Существует две версии API на C Matrix.

Этот interleaved complex API содержит функциональность API на C MATLAB R2018a. Для получения дополнительной информации смотрите Поддержку MATLAB для чередующегося комплексного API в MEX-функциях.
Этот separate complex API содержит функциональность API на C MATLAB R2017b.

Для примеров, использующих эти функции библиотеки, смотрите:

Таблицы примеров исходного кода MEX-функций
Таблица исходных Файлов кода MAT-файлов
Смотрите индивидуума функции для получения примера информации. Для примера см. mxIsChar.

Внимание

C Matrix API несовместим с MATLAB Data API, который поддерживает современные функции C++. Вы не можете использовать функции C Matrix API с функциями в приложениях C++ MEX или MATLAB Engine API для C++.

Типы данных C

`mxArray`	Тип C для массива MATLAB
`mwSize`	Тип C для значений размера mxArray
`mwIndex`	Тип C для значений индекса mxArray
`mwSignedIndex`	Тип C со знаком целое число для значений размера mxArray
`mxChar`	Тип для строковых массивов
`mxLogical`	Тип для логического массива
`mxComplexity`	Флаг, определяющий, имеет ли массив мнимые компоненты

Атрибуты mxArray

`mxIsNumeric`	Определите, является ли mxArray числовым
`mxIsComplex`	Определите, являются ли данные комплексными
`mxGetNumberOfDimensions`	Количество размерностей в mxArray
`mxGetElementSize`	Количество байтов, необходимых для хранения каждого элемента данных
`mxGetDimensions`	Указатель на массив размерностей
`mxSetDimensions`	Измените количество размерностей и размер каждой размерности
`mxGetNumberOfElements`	Количество элементов в числе mxArray
`mxCalcSingleSubscript`	Смещение от первого элемента к требуемому элементу
`mxGetM`	Количество строк в mxArray
`mxSetM`	Установите количество строк в mxArray
`mxGetN`	Количество столбцов в mxArray
`mxSetN`	Установите количество столбцов в mxArray
`mxIsEmpty`	Определите, является ли mxArray пустым
`mxIsFromGlobalWS`	Определите, был ли mxArray скопирован из глобальной рабочей области MATLAB

Создание, запрос и Доступ к данным типов

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

Числовые типы

`mxCreateDoubleMatrix`	2-D, двойная точность, массив с плавающей точкой
`mxCreateDoubleScalar`	Скаляр с двойной точностью, инициализированный до заданного значения
`mxCreateNumericMatrix`	2-D числовую матрицу
`mxCreateNumericArray`	N-D числовой массив
`mxCreateUninitNumericMatrix`	Неинициализированная 2-D числовая матрица
`mxCreateUninitNumericArray`	Неинициализированный N-D числовой массив

Некомплексные числа с плавающей запятой

`mxIsScalar`	Определите, является ли массив скалярным массивом
`mxGetScalar`	Действительный компонент первого элемента данных в массиве
`mxIsDouble`	Определите, представляет ли mxArray данные как двойную точность, числа с плавающей запятой
`mxGetDoubles`	Действительные элементы данных в `mxDOUBLE_CLASS` массив
`mxSetDoubles`	Установите реальные элементы данных в `mxDOUBLE_CLASS` массив
`mxIsSingle`	Определите, представляет ли mxArray данные как одинарную точность, числа с плавающей запятой
`mxGetSingles`	Действительные элементы данных в `mxSINGLE_CLASS` массив
`mxSetSingles`	Установите реальные элементы данных в `mxSINGLE_CLASS` массив
`mxGetPr`	(Не рекомендуемый) Реальные элементы данных в `mxDOUBLE_CLASS` массив
`mxSetPr`	(Не рекомендуемый) Установите реальные элементы данных в `mxDOUBLE_CLASS` массив

Некомплексное целое число

`mxIsInt8`	Определите, представляет ли mxArray данные как подписанные 8-битные целые числа
`mxGetInt8s`	Действительные элементы данных в `mxINT8_CLASS` массив
`mxSetInt8s`	Установите реальные элементы данных в `mxINT8_CLASS` массив
`mxIsUint8`	Определите, представляет ли mxArray данные как беззнаковые 8-битные целые числа
`mxGetUint8s`	Действительные элементы данных в `mxUINT8_CLASS` массив
`mxSetUint8s`	Установите реальные элементы данных в `mxUINT8_CLASS` массив
`mxIsInt16`	Определите, представляет ли mxArray данные как подписанные 16-битные целые числа
`mxGetInt16s`	Действительные элементы данных в `mxINT16_CLASS` массив
`mxSetInt16s`	Установите реальные элементы данных в `mxINT16_CLASS` массив
`mxIsUint16`	Определите, представляет ли mxArray данные как беззнаковые 16-битные целые числа
`mxGetUint16s`	Действительные элементы данных в `mxUINT16_CLASS` массив
`mxSetUint16s`	Установите реальные элементы данных в `mxUINT16_CLASS` массив
`mxIsInt32`	Определите, представляет ли mxArray данные как подписанные 32-битные целые числа
`mxGetInt32s`	Действительные элементы данных в `mxINT32_CLASS` массив
`mxSetInt32s`	Установите реальные элементы данных в `mxINT32_CLASS` массив
`mxIsUint32`	Определите, представляет ли mxArray данные как беззнаковые 32-битные целые числа
`mxGetUint32s`	Действительные элементы данных в `mxUINT32_CLASS` массив
`mxSetUint32s`	Установите реальные элементы данных в `mxUINT32_CLASS` массив
`mxIsInt64`	Определите, представляет ли mxArray данные как 64-разрядные целые числа со знаком
`mxGetInt64s`	Действительные элементы данных в `mxINT64_CLASS` массив
`mxSetInt64s`	Установите элементы данных в `mxINT64_CLASS` массив
`mxIsUint64`	Определите, представляет ли mxArray данные как беззнаковые 64-битные целые числа
`mxGetUint64s`	Действительные элементы данных в `mxUINT64_CLASS` массив
`mxSetUint64s`	Установите реальные элементы данных в `mxUINT64_CLASS` массив

Комплексные поплавки

`mxGetComplexDoubles`	Комплексные данные в `mxDOUBLE_CLASS` массив
`mxSetComplexDoubles`	Установите комплексные данные элементы в `mxDOUBLE_CLASS` массив
`mxGetComplexSingles`	Комплексные данные в `mxSINGLE_CLASS` массив
`mxSetComplexSingles`	Установите комплексные данные элементы в `mxSINGLE_CLASS` массив
`mxGetImagData`	Мнимые данные в числовых `mxArray`
`mxSetImagData`	Установите мнимые данные элементы в числовые `mxArray`
`mxGetPi`	(Не рекомендуемый) Мнимые элементы данных в `mxDOUBLE_CLASS` массив
`mxSetPi`	(Не рекомендуемый) Установите мнимые элементы данных в `mxDOUBLE_CLASS` массив

Комплексное целое число

`mxGetComplexInt8s`	Комплексные данные в `mxINT8_CLASS` массив
`mxSetComplexInt8s`	Установите комплексные данные элементы в `mxINT8_CLASS` массив
`mxGetComplexUint8s`	Комплексные данные в `mxUINT8_CLASS` массив
`mxSetComplexUint8s`	Установите комплексные данные элементы в `mxUINT8_CLASS` массив
`mxGetComplexInt16s`	Комплексные данные в `mxINT16_CLASS` массив
`mxSetComplexInt16s`	Установите комплексные данные элементы в `mxINT16_CLASS` массив
`mxGetComplexUint16s`	Комплексные данные в `mxUINT16_CLASS` массив
`mxSetComplexUint16s`	Установите комплексные данные элементы в `mxUINT16_CLASS` массив
`mxGetComplexInt32s`	Комплексные данные в `mxINT32_CLASS` массив
`mxSetComplexInt32s`	Установите комплексные данные элементы в `mxINT32_CLASS` массив
`mxGetComplexUint32s`	Комплексные данные в `mxUINT32_CLASS` массив
`mxSetComplexUint32s`	Установите комплексные данные элементы в `mxUINT32_CLASS` массив
`mxGetComplexInt64s`	Комплексные данные в `mxINT64_CLASS` массив
`mxSetComplexInt64s`	Установите комплексные данные элементы в `mxINT64_CLASS` массив
`mxGetComplexUint64s`	Комплексные данные в `mxUINT64_CLASS` массив
`mxSetComplexUint64s`	Установите комплексные данные элементы в `mxUINT64_CLASS` массив
`mxGetPi`	(Не рекомендуемый) Мнимые элементы данных в `mxDOUBLE_CLASS` массив
`mxSetPi`	(Не рекомендуемый) Установите мнимые элементы данных в `mxDOUBLE_CLASS` массив

Редкий

`mxCreateSparse`	2-D разреженный массив
`mxCreateSparseLogicalMatrix`	2-D, разреженный, логический массив
`mxIsSparse`	Определите, является ли вход разреженным mxArray
`mxGetNzmax`	Количество элементов в массивах IR, PR и PI
`mxSetNzmax`	Установите пространство памяти для ненулевых элементов
`mxGetIr`	Разреженная матрица Массива ir
`mxSetIr`	Массив ir разреженного массива
`mxGetJc`	Разреженный матричный массив JC
`mxSetJc`	Массив JC разреженного массива

Нечисловые типы

`mxGetData`	Элементы данных в нечисловых `mxArray`
`mxSetData`	Установите указатель на элементы данных в нечисловых `mxArray`

Символ

`mxCreateString`	1-N массив, инициализированный в указанную строку
`mxCreateCharMatrixFromStrings`	2-D `mxChar` массив, инициализированный до заданного значения
`mxCreateCharArray`	N-D- `mxChar` массив
`mxIsChar`	Определите, является ли вход `mxChar` массив
`mxGetChars`	Указатель на данные символьного массива

Логичный

`mxIsLogical`	Определите, имеет ли mxArray тип `mxLogical`
`mxIsLogicalScalar`	Определите, является ли скалярный массив типом mxLogical
`mxIsLogicalScalarTrue`	Определите, является ли скалярный массив типа mxLogical true
`mxClassID`	Перечисленное значение, идентифицирующее класс массива
`mxCreateLogicalArray`	N-D логический массив
`mxCreateLogicalMatrix`	2-D логический массив
`mxCreateLogicalScalar`	Скаляр, логический массив
`mxGetLogicals`	Указатель на логические данные массива

Объект

`mxIsClass`	Определите, является ли mxArray объектом заданного класса
`mxGetClassID`	Класс mxArray
`mxGetClassName`	Класс mxArray как строка
`mxSetClassName`	Массив структур в MATLAB объектного массива
`mxGetProperty`	Значение общественной собственности объекта MATLAB
`mxSetProperty`	Установите значение общественной собственности объекта MATLAB

Структура

`mxCreateStructMatrix`	2-D массив структур
`mxCreateStructArray`	N-D массив структур
`mxIsStruct`	Определите, является ли mxArray структурой
`mxGetField`	Указатель на значение поля из массива структур, заданный индекс и имя поля
`mxSetField`	Установите значение поля в массиве структур, задайте индекс и имя поля
`mxGetNumberOfFields`	Количество полей в массиве структур
`mxGetFieldNameByNumber`	Указатель на имя поля из массива структур, заданный номер поля
`mxGetFieldNumber`	Номер поля из массива структур, заданное имя поля
`mxGetFieldByNumber`	Указатель на значение поля из массива структур, заданный индекс и номер поля
`mxSetFieldByNumber`	Установите значение поля в массиве структур, задайте индекс и номер поля
`mxAddField`	Добавьте поле в массив структур
`mxRemoveField`	Удалите поле из массива структур

Камера

`mxCreateCellMatrix`	2-D массивы ячеек
`mxCreateCellArray`	N-D массив ячеек
`mxIsCell`	Определите, является ли mxArray массивом ячеек
`mxGetCell`	Указатель на элемент в массиве ячеек
`mxSetCell`	Установите содержимое массива ячеек

Удаление и дублирование mxArray

`mxDestroyArray`	Свободная динамическая память, выделяемая функциями MXCREATE *
`mxDuplicateArray`	Сделайте глубокую копию массива

Преобразование mxArray

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

Числовой

`mxMakeArrayComplex`	Преобразуйте реальные `mxArray` к комплексным, сохраняющим реальные данные
`mxMakeArrayReal`	Преобразуйте комплексные `mxArray` к реальным, сохраняющим реальные данные

Символ

`mxArrayToString`	Массив в строку
`mxArrayToUTF8String`	Массив в строку в UTF-8 кодировке
`mxGetString`	`mxChar` массив в строку стиля C или `character` ФОРТРАН массив

Структура

mxSetClassName Массив структур в MATLAB объектного массива

Управление памятью данных

`mxCalloc`	Выделите динамическую память для массива, инициализированную равной 0, используя диспетчера памяти MATLAB
`mxMalloc`	Выделите неинициализированную динамическую память с помощью диспетчера памяти MATLAB
`mxRealloc`	Перераспределите динамическую память с помощью диспетчера памяти MATLAB
`mxFree`	Свободная динамическая память, выделенная mxCalloc, mxMalloc, mxRealloc, mxArrayToString или mxArrayToUTF8String функциями

Утверждает

`mxAssert`	Проверьте значение значения для отладки
`mxAssertS`	Проверьте значение значения без печати текста значения

Константы

`mxIsInf`	Определите, является ли вход бесконечным
`mxIsFinite`	Определите, является ли вход конечным
`mxIsNaN`	Определите, является ли вход NaN (Не число)

Темы

Передайте строки в файле MEX на C

В этом примере показано, как передать строки в MEX-функцию, созданную с помощью API на C Matrix.

Передайте скалярные значения в файле MEX на C

В этом примере показано, как записать файл MEX, который передает скалярные значения.

Обрабатывайте разреженные массивы в файле MEX на C

В этом примере показано, как заполнить разреженную матрицу с помощью C Matrix API.

Дескриптор 8-, 16-, 32- и 64-Bit данных в файле MEX на C

В этом примере показано, как использовать беззнаковые 16-битные целые числа в файле MEX с помощью API C Matrix.

Передайте структуры и массивы ячеек в файл MEX на C

В этом примере показано, как передать структуры и массивы ячеек в файлы MEX, созданные с помощью API на C Matrix.

Манипуляции с многомерными числовыми массивами в файлах MEX на C

Можно манипулировать многомерными числовыми массивами, используя типизированные функции доступа к данным, такие как mxGetDoubles и mxGetComplexDoubles.

Связанная информация

Выбор MATLAB API для вашего приложения

Файл MEX на C приложения

MATLAB Engine API для C

Документация

Матричный API на C

Типы данных C

Атрибуты mxArray

Создание, запрос и Доступ к данным типов

Числовые типы

Некомплексные числа с плавающей запятой

Некомплексное целое число

Комплексные поплавки

Комплексное целое число

Редкий

Нечисловые типы

Символ

Логичный

Объект

Структура

Камера

Удаление и дублирование mxArray

Преобразование mxArray

Числовой

Символ

Структура

Управление памятью данных

Утверждает

Константы

Темы

Связанная информация

Документация MATLAB

Поддержка