Создайте исходный файл C++ MEX

Вот как создать базовую функцию C++ MEX. Эта функция просто добавляет смещение к каждому элементу входного массива, чтобы продемонстрировать основные входные и выходные параметры. Для более подробного обсуждения создания исходного кода MEX-функции смотрите Структуру C++ MEX-функция и похожие темы.

Создайте исходный файл

Используя ваш редактор, создайте файл с .cpp расширение и добавление закомментированных инструкций. Для примера, MyMEXFunction.cpp.

/* MyMEXFunction
 * Adds second input to each  
 * element of first input
 * a = MyMEXFunction(a,b);
*/

Добавление необходимых файлов заголовков

Для функций C++ MEX добавьте эти заголовочные файлы.

/* MyMEXFunction
 * Adds second input to each  
 * element of first input
 * a = MyMEXFunction(a,b);
*/

#include "mex.hpp"
#include "mexAdapter.hpp"

Использование определений удобства

Опционально задайте пространство имен для matlab::data и определить другие удобства.

/* MyMEXFunction
 * Adds second input to each  
 * element of first input
 * a = MyMEXFunction(a,b);
*/

#include "mex.hpp"
#include "mexAdapter.hpp"

using namespace matlab::data;
using matlab::mex::ArgumentList;

Задайте класс MexFunction

Все функции C++ MEX реализованы как класс с именем MexFunction. Этот класс должен быть выведен из matlab::mex::Function.

/* MyMEXFunction
 * Adds second input to each  
 * element of first input
 * a = MyMEXFunction(a,b);
*/

#include "mex.hpp"
#include "mexAdapter.hpp"

using namespace matlab::data;
using matlab::mex::ArgumentList;

class MexFunction : public matlab::mex::Function {

};

Задайте оператор ()

Все MexFunction классы должны переопределить оператор вызова функции, operator(), для принятия двух аргументов типа matlab::mex::ArgumentList. Эти аргументы содержат входы и выходы.

/* MyMEXFunction
 * Adds second input to each  
 * element of first input
 * a = MyMEXFunction(a,b);
*/

#include "mex.hpp"
#include "mexAdapter.hpp"

using namespace matlab::data;
using matlab::mex::ArgumentList;

class MexFunction : public matlab::mex::Function {
public:
    void operator()(ArgumentList outputs, ArgumentList inputs) {

    }

};

Добавьте функцию представителя для проверки аргументов

Проверяйте, имеют ли аргументы правильный тип и размер. Если тесты не пройдены, вызовите MATLAB^® error функция.

/* MyMEXFunction
 * Adds second input to each  
 * element of first input
 * a = MyMEXFunction(a,b);
*/

#include "mex.hpp"
#include "mexAdapter.hpp"

using namespace matlab::data;
using matlab::mex::ArgumentList;

class MexFunction : public matlab::mex::Function {
public:
    void operator()(ArgumentList outputs, ArgumentList inputs) {

    }
    void checkArguments(ArgumentList outputs, ArgumentList inputs) {
        // Get pointer to engine
        std::shared_ptr<matlab::engine::MATLABEngine> matlabPtr = getEngine();

        // Get array factory
        ArrayFactory factory;

        // Check first input argument
        if (inputs[0].getType() != ArrayType::DOUBLE ||
            inputs[0].getNumberOfElements() != 1)
        {
            matlabPtr->feval(u"error",
                0,
                std::vector<Array>({ factory.createScalar("First input must be scalar double") }));
        }

        // Check second input argument
        if (inputs[1].getType() != ArrayType::DOUBLE)
        {
            matlabPtr->feval(u"error",
                0,
                std::vector<Array>({ factory.createScalar("Input must be double array") }));
        }
        // Check number of outputs
        if (outputs.size() > 1) 
        {
            matlabPtr->feval(u"error",
                0,
                std::vector<Array>({ factory.createScalar("Only one output is returned") }));
        }
    }
};

Реализация расчетов

Получите скалярное смещение и присвойте его const double. Получите массив входа и переместите его в matlab::data::TypedArray<double> для работы с массивом. Добавьте смещение каждому элементу массива и присвойте измененный массив переменного выхода.

/* MyMEXFunction
 * Adds second input to each  
 * element of first input
 * a = MyMEXFunction(a,b);
*/

#include "mex.hpp"
#include "mexAdapter.hpp"

using namespace matlab::data;
using matlab::mex::ArgumentList;

class MexFunction : public matlab::mex::Function {
public:
    void operator()(ArgumentList outputs, ArgumentList inputs) {
        checkArguments(outputs, inputs);
        const double offSet = inputs[0][0];
        TypedArray<double> doubleArray = std::move(inputs[1]);
        for (auto& elem : doubleArray) {
            elem += offSet;
        }
        outputs[0] = doubleArray;
    }

    void checkArguments(ArgumentList outputs, ArgumentList inputs) {
        // Get pointer to engine
        std::shared_ptr<matlab::engine::MATLABEngine> matlabPtr = getEngine();

        // Get array factory
        ArrayFactory factory;

        // Check first input argument
        if (inputs[0].getType() != ArrayType::DOUBLE ||
            inputs[0].getType() == ArrayType::COMPLEX_DOUBLE ||
            inputs[0].getNumberOfElements() != 1)
        {
            matlabPtr->feval(u"error",
                0,
                std::vector<Array>({ factory.createScalar("First input must be scalar double") }));
        }

        // Check second input argument
        if (inputs[1].getType() != ArrayType::DOUBLE ||
            inputs[1].getType() == ArrayType::COMPLEX_DOUBLE)
        {
            matlabPtr->feval(u"error",
                0,
                std::vector<Array>({ factory.createScalar("Input must be double array") }));
        }
        // Check number of outputs
        if (outputs.size() > 1) {
            matlabPtr->feval(u"error",
                0,
                std::vector<Array>({ factory.createScalar("Only one output is returned") }));
        }
    }
};

Setup и сборка

После установки поддерживаемого компилятора используйте mex команда, чтобы создать MEX-функцию.

mex -setup c++
mex MyMEXFunction.cpp

Для получения дополнительной информации о создании MEX-функций, смотрите Сборка программ C++ MEX.

Вызов MEX-функции

Вызовите MEX-функцию из MATLAB.

b = MyMEXFunction(11.5, rand(1000));

См. также

matlab::mex::ArgumentList | matlab::mex::Function | mex

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