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

Запись приложения драйвера

В версии C++ matrix прикладные matrix_mwarray.cpp, массивы представлены объектами класса mwArray. Каждый mwArray объект класса содержит указатель на структуру массива MATLAB. По этой причине атрибуты mwArray объект является супермножеством атрибутов массива MATLAB. Каждый массив MATLAB содержит информацию о размере и форме массива (т.е. количестве строк, столбцов и страниц) и одном или двух массивах данных. Первый массив хранит вещественную часть данных массива, а второй массив хранит мнимую деталь. Для массивов без мнимой детали второй массив отсутствует. Данные в массиве расположены в порядке «основной столбец», а не «основная строка».

Дополнительные сведения о том, как MATLAB Compiler SDK использует слой прокси для библиотек, которые должно связывать приложение, см. в разделе «Сведения о слое прокси-сервера mclmcrrt».

The matrix_mwarray.cpp файл драйвера расположен в matlabroot\extern\examples\compilersdk\c_cpp\matrix.

 Код API C++ mwArray для реализации общей библиотеки

/*==============================================================
 *
 * MATRIX_MWARRAY.CPP
 * Sample driver code that calls a C++ shared library created using
 * the MATLAB Compiler SDK. Refer to the MATLAB Compiler SDK
 * documentation for more information.
 *
 * Copyright 1984-Present The MathWorks, Inc.
 *
 *============================================================*/

// Include the library specific header file as generated by the 
// MATLAB Compiler SDK
#include "libmatrix.h"

int run_main(int argc, const char **argv)
{
    if( !libmatrixInitialize() )
    {
        std::cerr << "Could not initialize the library properly"
                   << std::endl;
        return -1;
    }
    else
    {
        try
        {
            // Create input data
            double data[] = {1,2,3,4,5,6,7,8,9};
            mwArray in1(3, 3, mxDOUBLE_CLASS, mxREAL);
            mwArray in2(3, 3, mxDOUBLE_CLASS, mxREAL);
            in1.SetData(data, 9);
            in2.SetData(data, 9);
            
            // Create output array
            mwArray out;
            
            // Call the library function
            addmatrix(1, out, in1, in2);
            
            // Display the return value of the library function
            std::cout << "The sum of the matrix with itself is:" << std::endl;
            std::cout << out << std::endl;
            
            multiplymatrix(1, out, in1, in2);
            std::cout << "The product of the matrix with itself is:" 
                      << std::endl;
            std::cout << out << std::endl;
            
            eigmatrix(1, out, in1);
            std::cout << "The eigenvalues of the original matrix are:"
                      << std::endl;
            std::cout << out << std::endl;
        }
        catch (const mwException& e)
        {
            std::cerr << e.what() << std::endl;
            return -2;
        }
        catch (...)
        {
            std::cerr << "Unexpected error thrown" << std::endl;
            return -3;
        }     
        // Call the application and library termination routine
        libmatrixTerminate();
    }
    // mclTerminateApplication shuts down the MATLAB Runtime.
    // You cannot restart it by calling mclInitializeApplication.
    // Call mclTerminateApplication once and only once in your application.
    mclTerminateApplication();
    return 0;
}

// The main routine. On the Mac, the main thread runs the system code, and
// user code must be processed by a secondary thread. On other platforms, 
// the main thread runs both the system code and the user code.
int main(int argc, const char **argv)
{
    // Call application and library initialization. Perform this 
    // initialization before calling any API functions or
    // Compiler SDK-generated libraries.
    if (!mclInitializeApplication(nullptr, 0)) 
    {
        std::cerr << "Could not initialize the application properly"
                  << std::endl;
        return -1;
    }

    return mclRunMain(static_cast<mclMainFcnType>(run_main), argc, argv);
}

Компиляция приложения драйвера

Чтобы скомпилировать matrix_mwarray.cpp код драйвера, вы используете ваш компилятор C++. Путем выполнения следующей mbuild команда, которая соответствует вашей платформе разработки, вы будете использовать компилятор C++ для компиляции кода.

mbuild matrix_mwarray.cpp libmatrix.lib            (Windows)
mbuild matrix_mwarray.cpp -L. -lmatrix -I.         (UNIX)

Включение общей библиотеки C++ в приложение

Существуют два основных различий при использовании общей библиотеки C++:

Экспортированная сигнатура функции

Целевой объект общей библиотеки C++ генерирует два набора интерфейсов для каждой функции MATLAB. Для получения дополнительной информации смотрите Функции, сгенерированные из файлов MATLAB. Типовая сигнатура экспортированных функций C++ выглядит следующим образом:

Функции MATLAB без возвращаемых значений

bool MW_CALL_CONV <function-name>(<const_mwArray_references>); 

Функции MATLAB с по крайней мере одним возвращаемым значением

bool MW_CALL_CONV <function-name>(int <number_of_return_values>,
     <mwArray_references>, <const_mwArray_references>);

В этом случае const_mwArray_references представляет списку , разделенному запятыми ссылок типа const mwArray& и mwArray_references представляет списку , разделенному запятыми ссылок типа mwArray&. Для примера, в libmatrix библиотека, интерфейс C++ к addmatrix Функция MATLAB генерируется как:

void addmatrix(int nargout, mwArray& a, const mwArray& a1,  
               const mwArray& a2);

где a является выходным параметром и a1 и a2 являются входными параметрами.

Входные параметры переданы в функцию MATLAB через varargin должна быть передана через одну mwArray это массив ячеек. Каждый элемент массива ячеек должен составлять входной параметр. Выходные аргументы, извлеченные из функции MATLAB через varargout должна быть извлечена через одну mwArray это массив ячеек. Каждый элемент массива ячеек будет представлять собой выходной аргумент. Количество элементов в массиве ячеек будет равно number_of_return_values - количество именованных выходных параметров. Также обратите внимание, что,

Обработка ошибок

Функции интерфейса C++ обрабатывают ошибки во время выполнения, выдавая исключение C++. Используйте mwException класс для этой цели. Ваше приложение может поймать mwExceptions и запросите what() метод для получения сообщения об ошибке. Чтобы правильно обработать ошибки при вызове функций интерфейса C++, переносите каждый вызов внутрь try-catch блок.

	try
{
		...
		(call function)
		...
}
catch (const mwException& e)
{
		...
		(handle error)
		...
}

The matrix_mwarray.cpp приложение иллюстрирует типичный способ обработки ошибок при вызове функций интерфейса C++.

Работа с общими библиотеками C++ и разреженными массивами

MATLAB Compiler SDK C/C + + API включает статические заводские методы работы с разреженными массивами.

Полный список методов см. в разделе C++ Utility Classes.