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

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

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

Для получения информации о том, как MATLAB Compiler SDK использует слой прокси для библиотек, которые приложение должно соединить, видеть, Понимают Слой Прокси mclmcrrt.

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

 Код mwArray API C++, чтобы Реализовать Разделяемую Библиотеку

/*==============================================================
 *
 * 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++ к функции MATLAB addmatrix сгенерирован как:

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)
		...
}

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

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

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

Для полного списка методов смотрите Сервисные Классы C++.