Использование функций MEX для методов классов MATLAB

Для реализации методов для классов MATLAB ® можно использовать функции MEX. Использование функций MEX позволяет интегрировать существующие алгоритмы и операции C++ в методы классов без перезаписи кода в MATLAB .

Для использования методов функции MEX:

Определение класса MATLAB в @ таким образом, методы могут содержаться в отдельных файлах. См. раздел Методы в отдельных файлах.
Реализовать функцию MEX и поместить исполняемый файл в класс @ папка.
Ссылка на функцию MEX в определении класса Methods блок.
Вызовите функцию MEX, как любой метод.

Метод умножения матрицы на скаляр

arrayMultiplier класс, определенный здесь, реализует multiplyAllElements метод в качестве функции MEX.

Этот класс хранит массив 2-D в своем Data собственность. multiplyAllElements метод принимает экземпляр класса и скалярный множитель в качестве входных данных. Метод умножает элементы массива в Data по множителю и присваивает результат Data собственность. Потому что arrayMultiplier класс является классом значений, multiplyAllElements возвращает измененный объект.

Вот определение arrayMultiplier класс.

classdef arrayMultiplier
    % An object that contains an array and an operation
    % to multiply each element of the array by an input
    % value.
    % This class demonstrates how to use a MEX function
    % as a method.
    properties
        Data (:,:) double {mustBeNonempty(Data)} = ones(4);
    end
    methods
        function obj = arrayMultiplier(Matrix)
            %  Create object
            if nargin
                obj.Data = Matrix;
            end
        end
        % multiplyAllElements method implemented
        % as a MEX function
        obj = multiplyAllElements(obj,multplier)
    end
end

Вот реализация функции C++ MEX multiplyAllElements способ.

/* C++ MEX file for MATLAB
*  returnObj = multiplyAllElements(obj, multiplier) modify object property.
*  Multiply all elements in obj.Data by multiplier.
*
*  Class method implemented as a MEX function
*
*/

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

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

class MexFunction : public matlab::mex::Function {
	std::shared_ptr<matlab::engine::MATLABEngine> matlabPtr = getEngine();
public:
    void operator()(ArgumentList outputs, ArgumentList inputs) {

        checkArguments(outputs, inputs);
        Array object(inputs[0]);
        double multiplier = inputs[1][0];
        assignProperty(object, multiplier);

        // Return modified object
        outputs[0] = object;
    }
     
    void assignProperty(Array& obj, double multiplier) {
        // Get matrix from Data property
		TypedArray<double> inMatrix = matlabPtr->getProperty(obj, u"Data");


		// Multiply matrix by multiplier
		for (auto& elem : inMatrix) {
			elem *= multiplier;
		}

		// Set the property value
		matlabPtr->setProperty(obj, u"Data", inMatrix);
    }

	void checkArguments(matlab::mex::ArgumentList outputs, matlab::mex::ArgumentList inputs) {
		matlab::data::ArrayFactory factory;

		if (inputs.size() != 2) {
			matlabPtr->feval(u"error",
				0, 
				std::vector<matlab::data::Array>({ factory.createScalar("Two inputs required") }));
		}

		if ((inputs[1].getType() != matlab::data::ArrayType::DOUBLE) || (inputs[1].getNumberOfElements() != 1)) {
			matlabPtr->feval(u"error", 
				0, 
				std::vector<matlab::data::Array>({ factory.createScalar("Input multiplier must be a noncomplex scalar double") }));
		}

	}
};

Чтобы использовать метод, создайте экземпляр класса. Значение по умолчанию для Data свойство является массивом 4 на 4, возвращаемым выражением ones(4).

a = arrayMultiplier;
a.Data

ans =

     1     1     1     1
     1     1     1     1
     1     1     1     1
     1     1     1     1

Используйте multiplyAllElements метод для умножения каждого элемента в массиве на скалярное значение. Назначьте возвращенный объект той же переменной.

a = multiplyAllElements(a,6.25);
a.Data

ans =

    6.2500    6.2500    6.2500    6.2500
    6.2500    6.2500    6.2500    6.2500
    6.2500    6.2500    6.2500    6.2500
    6.2500    6.2500    6.2500    6.2500

См. также

matlab::data::Array | matlab::mex::ArgumentList | matlab::mex::Function | mex

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