Определение отсутствующей информации для сигнатур MATLAB

MATLAB^® интерфейс автоматически преобразует сигнатуры функции C++ в сигнатуры функции MATLAB. Однако некоторые конструкции языка C++ не имеют уникальных соответствий на языке MATLAB. Чтобы включить эту функциональность в интерфейс, отредактируйте .mlx Определением файла и замените <DIRECTION>, <SHAPE>, и <MLTYPE> параметры с отсутствующей информацией. Эти параметры используются в следующих случаях.

Чтобы указать, является ли аргумент указателя входным, выходным или изменяемым входным параметром только для чтения, используйте параметр DIRECTION.
Если для данных массива используется аргумент, то для преобразования массива между C++ и MATLAB требуется информация о размерности. Используйте параметр SHAPE, чтобы задать эту информацию.
C++ имеет много типов, представляющих строковые аргументы. Возможно, вам потребуется задать значения MLTYPE и SHAPE, чтобы MATLAB мог правильно преобразовать тип C++ в MATLAB string тип.

MATLAB предлагает код предложения по значениям этих параметров. Чтобы активировать предложения для определенного параметра:

Раскомментируйте код, определяющий функцию.
Удалите имя параметра, включая <> персонажи.
Пауза, чтобы разрешить отображение предложений кода.
Если предложения не отображаются, проверьте, что заданы libName.mlx файл указан в пути MATLAB.

`DIRECTION` Параметр

В C++ аргументы указателя могут использоваться, чтобы передать и вернуть данные от функции. Используйте DIRECTION параметр, чтобы указать, является ли аргумент входным, только выходным или изменяемым входным параметром только для чтения.

The DIRECTION параметр имеет одно из следующих значений:

"input"- Только входной параметр
Если для передачи данных в функцию используется аргумент указателя, то он должен появиться как входной параметр в сигнатуре MATLAB.
The DIRECTION значение для параметров C-string должно быть входным.
"output"- Только выходной аргумент
Если для извлечения данных из функции используется аргумент-указатель, то он должен появиться как выходной аргумент в сигнатуре MATLAB.
"inputoutput"- Входной и выходной аргумент
Если аргумент указателя используется как для передачи, так и для возврата данных, то он должен отображаться как входной параметр и выходной аргумент.

Примечание

Аргументы по умолчанию с направлением, заданным как OUT не поддерживаются. Определите их с помощью DIRECTION как "input" или "inputoutput" в файле MLX.

Например, предположим, что функция C++ passData имеет следующую подпись. Аргумент data может быть входом в функцию, возврат значением функции или входом, который функция изменяет и возвращает. Документация функции подсказывает, как функция использует аргумент data.

void passData(double *data);

Принимая data является скалярным двойным значением, в этой таблице показана сигнатура MATLAB, основанная на ее роли.

Роль C++ для `data`	Подпись MATLAB
Входные данные только для `passData`	% Set DIRECTION = "input" passData(data)
Возвращает данные только из `passData`	% Set DIRECTION = "output" [data] = passData()
Входные и выходные данные для `passData`	% Set DIRECTION = "inputoutput" [data] = passData(data)

`SHAPE` Параметр

В C++ аргументы указателя используются как для скалярных данных, так и для данных массива. Чтобы использовать указатель в качестве массива, для преобразования массива между C++ и MATLAB требуется информация о размерности. The SHAPE параметр задает размерности для указателя мыши.

Примечание

Эти типы указателей могут использоваться только в качестве скаляров. Задайте SHAPE как 1 в файле MLX.

Указатели, представляющие массивы объектов класса C++
Указатели на несоответствующие примитивные массивы, возвращенные из функции

Следующие примеры конструкций, заданных в выборке cppUseCases.hpp файл заголовка показывает, как задать форму аргумента. В этих таблицах описания функций в столбце C++ Signature and Role of Pointer основаны на предполагаемых знаниях аргументов. Сама подпись не предоставляет эту информацию.

Чтобы просмотреть cppUseCases.hpp заголовочный файл и его сгенерированный файл определения, см. Выборку файла определения библиотеки C++.

Задайте аргумент указателя на фиксированный скаляр

Подпись C++ и роль указателя	`defineArgument` Значения
Вход этой функции является скалярным указателем `in`. void readScalarPtr(int const * in)	Для получения аргументов `in`, задать `SHAPE` на `1`. defineArgument(readScalarPtrDefinition, "in", ... "int32", "input", 1);
Вход этой функции является скалярным указателем на класс `ns::MyClass2`. void readScalarPtr(ns::MyClass2 const * in)	Для получения аргументов `in`, задать `SHAPE` на `1`. defineArgument(readScalarPtrDefinition, "in", ... "clib.cppUseCases.ns.MyClass2", "input", 1);

Задайте аргумент указателя

Подпись C++	`defineArgument` Значения
Вход в эту функцию является указателем на целочисленный массив длины `m`. void readMatrix1DPtr(int const * mat, size_t m)	Для получения аргументов `mat`, задать `SHAPE` в аргумент `m`. defineArgument(readMatrix1DPtrDefinition, "mat", ... "int32", "input", "m");
Вход этой функции является указателем на массив фиксированной длины `mat`. void readMatrix1DPtrFixedSize(int const * mat)	Для получения аргументов `mat`, задать `SHAPE` к фиксированному целому числу, такому как 5. defineArgument(readMatrix1DPtrFixedSizeDefinition, ... "mat", "int32", "input", 5);
Вход этой функции является указателем на двумерную целочисленную матрицу `mat` размера `m`-by- `n`. void readMatrix2DPtr(int const * mat, size_t m, size_t n)	Для получения аргументов `mat`, задать `SHAPE` на `["m","n"]`. defineArgument(readMatrix2DPtrDefinition, "mat", ... "int32", "input", ["m","n"]);
Вход этой функции является указателем на двумерную матрицу `mat` фиксированных размерностей. void readMatrix2DPtrFixedSize(int const * mat)	Для получения аргументов `mat`, задать `SHAPE` к фиксированному целому числу, такому как 6. defineArgument(readMatrix2DPtrFixedSizeDefinition, ... "mat", "int32", "input", 6);
Вход этой функции является указателем на трехмерную матрицу `mat` размера `m`-by- `n`-by- `p`. void readMatrix3DPtr(int const * mat, size_t m, size_t n, size_t p)	Для получения аргументов `mat`, задать `SHAPE` на `["m","n","p"]`. defineArgument(readMatrix3DPtrDefinition, "mat", ... "int32", "input", ["m","n","p"]);

Задайте аргумент массива

Подпись C++	`defineArgument` Значения
Вход этой функции является одномерным массивом `mat` длины `len`. void readMatrix1DArr(int const [] mat, size_t len)	Для получения аргументов `mat`, задать `SHAPE` по длине `len`. defineArgument(readMatrix1DArrDefinition, "mat", ... "int32", "input", "len");

Задайте выходной аргумент указателя

Подпись C++	`defineArgument` Значения
Вход этой функции является указателем на массив длин `len`. Функция возвращает аргумент указателя как вывод. int const * getRandomValues(size_t len)	Для значения возврата `RetVal`, задать `SHAPE` в аргумент `len`. defineOutput(getRandomValuesDefinition, "RetVal", ... "int32", "len");
Выходным аргументом этой функции является указатель на массив фиксированной длины. int const * getRandomValuesFixedSize()	Для значения возврата `RetVal`, задать `SHAPE` к целому числу, такому как 5. defineOutput(getRandomValuesFixedSizeDefinition, ... "RetVal", "int32", 5);

Задайте скалярный аргумент объекта

Подпись C++	`defineArgument` Значения
Вход в эту функцию является указателем на класс `ns::MyClass2`. double addClassByPtr(ns::MyClass2 const * myc2)	Для `myc2` аргумент, задание `SHAPE` на `1`. defineArgument(addClassByPtrDefinition, "myc2", ... "clib.cppUseCases.ns.MyClass2", "input", 1);
Вход в эту функцию является указателем на класс `ns::MyClass2`. void updateClassByPtr(ns::MyClass2 * myc2, double a, short b, long c)	Для получения аргументов `myc2`, задать `SHAPE` на `1`. defineArgument(updateClassByPtrDefinition, "myc2", ... "clib.cppUseCases.ns.MyClass2", "input", 1);
Вход в эту функцию является указателем на класс `ns::MyClass2`. void readClassByPtr(ns::MyClass2 * myc2)	Для получения аргументов `myc2`, задать `SHAPE` на `1`. defineArgument(readClassByPtrDefinition, "myc2", ... "clib.cppUseCases.ns.MyClass2", "input", 1);
Вход в эту функцию является указателем на класс `ns::MyClass2`. void fillClassByPtr(ns::MyClass2 * myc2, double a, short b, long c)	Для получения аргументов `myc2`, задать `SHAPE` на `1`. defineArgument(fillClassByPtrDefinition, "myc2", ... "clib.cppUseCases.ns.MyClass2", "input", 1);

Задайте матричный аргумент

Подпись C++	`defineArgument` Значения
Вход в эту функцию является указателем на целый вектор длины `len`. Аргумент `x` изменяет входной параметр. void updateMatrix1DPtrByX(int * mat, size_t len, int x)	Для получения аргументов `mat`, задать `DIRECTION` на `"inputoutput"` и `SHAPE` на `"len"`. defineArgument(updateMatrix1DPtrByXDefinition, ... "mat", "int32", "inputoutput", "len");
Вход в эту функцию является ссылкой на целочисленный массив длины `len`. Аргументы в `x` изменяет входной параметр `mat`. void updateMatrix1DArrByX(int [] mat, size_t len, int x)	Для получения аргументов `mat`, задать `DIRECTION` на `"inputoutput"` и `SHAPE` на `"len"`. defineArgument(updateMatrix1DArrByXDefinition, ... "mat", "int32", "inputoutput", "len");
Вход в эту функцию является указателем на целый вектор длины `len`. Функция не изменяет входного параметра. int addValuesByPtr(int * mat, size_t len)	Для получения аргументов `mat`, задать `DIRECTION` на `"input"` и `SHAPE` на `"len"`. defineArgument(addValuesByPtrDefinition, "mat", ... "int32", "input", "len");
Вход в эту функцию является ссылкой на целочисленный массив длины `len`. Функция не изменяет входного параметра. int addValuesByArr(int [] mat, size_t len)	Для получения аргументов `mat`, задать `DIRECTION` на `"input"` и `SHAPE` на `"len"`. defineArgument(addValuesByArrDefinition, ... "mat", "int32", "input", "len");
Эта функция создает целочисленный вектор длины `len` и возвращает ссылку на вектор. void fillRandomValuesToPtr(int * mat, size_t len)	Для получения аргументов `mat`, задать `DIRECTION` на `"output"` и `SHAPE` на `"len"`. defineArgument(fillRandomValuesToPtrDefinition, ... "mat", "int32", "output", "len");
Эта функция создает целочисленный вектор длины `len` и возвращает ссылку на вектор. void fillRandomValuesToArr(int [] mat, size_t len)	Для получения аргументов `mat`, задать `DIRECTION` на `"output"` и `SHAPE` на `"len"`. defineArgument(fillRandomValuesToArrDefinition, ... "mat", "int32", "output", "len");

Задайте строковый аргумент

Подпись C++	`defineArgument` Значения
Входной вход этой функции представляет собой строку в стиле С. char const * getStringCopy(char const * str)	Для получения аргументов `str`, задать `MLTYPE` на `"string"` и `SHAPE` на `"nullTerminated"`. defineArgument(getStringCopyDefinition, "str", ... "string", "input", "nullTerminated");
Значение возврата для этой функции является строкой. char const * getStringCopy(char const * str)	Для обратного значения `RetVal`, задать `MLTYPE` на `"string"` и `SHAPE` на `"nullTerminated"`. defineOutput(getStringCopyDefinition, "RetVal", "string", ... "nullTerminated");
Входом для этой функции является строка, заданная длиной `len`. void readCharArray(char const * chArray, size_t len)	Для получения аргументов `chArray`, задать `MLTYPE` на `"char"` и `SHAPE` на `"len"`. defineArgument(readCharArrayDefinition, "chArray", ... "char", "input", "len");
Вход в эту функцию является массивом типов `int8` и длина `len`. void readInt8Array(char const * int8Array, size_t len)	Для получения аргументов `int8Array`, задать `MLTYPE` на `"int8"` и `SHAPE` на `"len"`. defineArgument(readInt8ArrayDefinition, "int8Array", ... "int8", "input", "len");
Значение возврата для этой функции является скаляром символов. char const * getRandomCharScalar()	Для обратного значения `RetVal`, задать `MLTYPE` на `"char"` и `SHAPE` на `1`. defineOutput(getRandomCharScalarDefinition, ... "RetVal", "char", 1);
Тип возврата значения для этой функции `int8`. char const * getRandomInt8Scalar()	Для обратного значения `RetVal`, задать `MLTYPE` на `"int8"` и `SHAPE` на `1`. defineOutput(getRandomInt8ScalarDefinition, ... "RetVal", "int8", 1);
Эта функция обновляет входной параметр `chArray`. Длина `chArray` является `len`. void updateCharArray(char* chArray, size_t len)	Для получения аргументов `chArray`, задать `DIRECTION` на `"inputoutput"` и `SHAPE` на `"len"`. defineArgument(updateCharArrayDefinition, ... "chArray", "int8", "inputoutput", "len");
Вход этих функций является массивом C-строк размера `numStrs`. void readCStrArray(char** strs, int numStrs); void readCStrArray(char* strs[], int numStrs);	Для получения аргументов `strs`, задать `SHAPE` в `["numStrs", "nullTerminated"] массива`. defineArgument(readCStrArrayDefinition, ... "strs", "string", "input", ["numStrs", "nullTerminated"])
Входной параметр этих функций является const массива C-строки размера `numStrs`. void readConstCStrArray (const char** strs, int numStrs); void readConstCStrArray (const char* strs[], int numStrs);	Звонить `clibgen.generateLibraryDefinition` с `TreatConstCharPointerAsCString` установите значение true, чтобы автоматически задать `SHAPE` для аргументов `strs` как `["numStrs", "nullTerminated"]`. defineArgument(readConstCStrArrayDefinition, ... "strs", "string", "input", ["numStrs", "nullTerminated"])
Вход этой функции является массивом фиксированного размера С-строкой. void readFixedCStrArray (char* strs[5]);	Для получения аргументов `strs`, задать `SHAPE` в `[5, "nullTerminated"] массива`. defineArgument(readFixedCStrArrayDefinition, ... "strs", "string", "input", [5, "nullTerminated"])
Вход этой функции является массивом const с C-строкой фиксированного размера. void readConstCFixedStrArray (const char* strs[5]);	Звонить `clibgen.generateLibraryDefinition` с `TreatConstCharPointerAsCString` установите значение true, чтобы задать `SHAPE` для аргументов `strs` как `[5, "nullTerminated"]`. defineArgument(readConstFixedCStrArrayDefinition, ... "strs", "string", "input", [5, "nullTerminated"])

Задайте типизированный аргумент указателя

Подпись C++ defineArgument Значения

Подпись C++	`defineArgument` Значения
Вход в эту функцию является указателем на typedef `intDataPtr`. void useTypedefPtr(intDataPtr input1) `intDataPtr` определяется как: typedef int16_t intData; typedef intData * intDataPtr;	Для получения аргументов `input1`, задать `DIRECTION` на `input` и `SHAPE` на `1`. defineArgument(useTypedefPtrDefinition, "input1", ... "int16", "input", 1);

Вход в эту функцию является указателем на typedef intDataPtr.

void useTypedefPtr(intDataPtr input1)

intDataPtr определяется как:

typedef int16_t intData;
typedef intData * intDataPtr;

Для получения аргументов input1, задать DIRECTION на input и SHAPE на 1.

defineArgument(useTypedefPtrDefinition, "input1", ...
    "int16", "input", 1);

`MLTYPE` Параметр

MATLAB автоматически преобразует типы C++ в типы MATLAB, как описано в C++, в Тип данных MATLAB Отображения. Если тип C++ для аргумента является строкой, используйте эти опции, чтобы выбрать значения для MLTYPE и SHAPE аргументы.

Тип C++	`MLTYPE`	Опции для `SHAPE`
`char*`	`"int8"`	Скалярное значение Массив скалярных значений
`char*` `char[]`	`"string"`	вектор
`const char*`	`"char"`	Скалярное значение Массив скалярных значений
`const char*`	`"string"`	`"nullTerminated"`
`const char*` `const char[]`	`"char"`	Скалярное значение Массив скалярных значений
`const char*` `const char[]`	`"string"`	`"nullTerminated"`

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