Примеры обходного решения ограничения C++

Если ваша разделяемая библиотека содержит типы данных или функции языка, не поддерживавшие интерфейсом MATLAB® к библиотекам C++, вы можете смочь включать эту функциональность путем создания заголовочного файла обертки. Эта тема обеспечивает примеры для некоторых ограничений. Для получения дополнительной информации смотрите Ограничения к Поддержке C/C++.

Запускать примеры обходного решения на Windows®:

  • Скопируйте операторы заголовочного файла C++ в .hpp файлы.

  • Скопируйте исходный код в .cpp файлы и сборка, с помощью инструкций в Примере Сборки Совместно использовали Файлы Библиотеки на Windows.

  • Выполните код MATLAB, чтобы создать интерфейс.

  • При необходимости отредактируйте файл определения библиотеки.

  • Выполните код MATLAB, чтобы протестировать функциональность.

Объекты класса в std Пространство имен

Интерфейс MATLAB к библиотеке C++ не включает функции, которые используют объекты, заданные в std пространство имен. Например, функции в этом Student.hpp передача заголовочного файла std::stack объекты. Если вы создаете интерфейс MATLAB, readStudents функций и getStudents не включены.

#ifndef STUDENT_HEADER
#define STUDENT_HEADER

#include <stack>

#ifdef _WIN32
#ifdef EXPORT
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT __declspec(dllimport)
#endif
#else
#define DLL_EXPORT __attribute__((visibility ("default")))
#endif

class DLL_EXPORT Student {
    int rollNumber;
public:
    Student();
    Student(int rollNo);
    int getRollNumber();
};

DLL_EXPORT void readStudents(const std::stack<Student>& students);

DLL_EXPORT std::stack<Student> getStudents(int size);

#endif
  1. Чтобы запустить этот пример на Windows, создайте Student.lib и Student.dll файлы от этого Student.cpp исходный файл, с помощью Примера Сборки Совместно использовал Файлы Библиотеки на Windows.

    #define EXPORT
    
    #include "Student.hpp"
    
    
    Student::Student() : rollNumber(0) {}
    
    Student::Student(int rollNo) : rollNumber(rollNo) {}
    
    int Student::getRollNumber() {
        return rollNumber;
    }
    
    DLL_EXPORT void readStudents(const std::stack<Student>& students) {
    }
    
    DLL_EXPORT std::stack<Student> getStudents(int size) {
        std::stack<Student> students;
        for (int i = 0; i < size; i++) {
            students.push(Student(i+1));
        }
        return students;
    }
  2. Создайте Student.hpp заголовочный файл и помещенный это с Student.dll совместно использованный файл библиотеки в папке, идентифицированной как rtpath.

  3. Создайте класс CStack представлять std::stack объект. Поместите это определение в заголовочный файл CStack.hpp.

    //Wrapper header to access/pass std::stack objects from MATLAB
    #ifndef stack_header
    #define stack_header
    
    #include <stack>
    #include <stdexcept>
    
    template<typename T>
    class CStack {
        std::stack<T> data;
    public:
        CStack() {}
        
        // This parameterized constructor is required for the wrapper functions
        // and is not included in the MATLAB interface
        CStack(const std::stack<T>& d):data(d) {} 
    
        // Function to access the topmost element in stack
        T* get() {
            if (data.empty())
                throw std::runtime_error("Retrieving element from Empty Stack");
            return &data.top();
        }
        
        // Function to remove elements from stack
        void remove() { 
            if (data.empty())
                throw std::runtime_error("Stack is empty");
            data.pop();
        }
        
        // Function to add elements to stack
        void add(const T* element) { 
            data.push(*element);
        }
        
        // This method is required for the wrapper functions, and
        // is not included in the MATLAB interface
        const std::stack<T>& getData() const{ 
            return data;
        }
    };
    #endif
  4. Задайте функциональный readStudentsWrapper вызывать readStudents функция с помощью CStack класс и getStudentsWrapper вызывать getStudents функция. Включайте эти функции в заголовочный файл обертки под названием StudentWrapper.hpp.

    //Header to call readStudents and getStudents functions from MATLAB
    #include "Student.hpp"
    #include "CStack.hpp"
    
    //wrapper function to access the function that accepts std::stack input
    void readStudentsWrapper(const CStack<Student>& students) { 
        readStudents(students.getData());
    }
    
    //wrapper function to access the function that returns the std::stack
    CStack<Student> getStudentsWrapper(int size) { 
        auto students = getStudents(size);
        CStack<Student> cstackStudents(students);
        return cstackStudents;
    }
  5. Сгенерируйте определение библиотеки в пакете под названием stack.

    clibgen.generateLibraryDefinition(["Student.hpp","StudentWrapper.hpp"],"PackageName","stack",...
        "Libraries","Student.lib","TreatObjectPointerAsScalar",true,"Verbose",true);
    Warning: File 'manifest.json' not found. 
    Warning: Some C++ language constructs in the header file are not supported and not imported.
    
    Did not add 'readStudents' at Student.hpp:24.
      Type 'stack' is from std namespace or system header and is not supported.
    
    Did not add 'getStudents' at Student.hpp:26.
      Type 'stack' is from std namespace or system header and is not supported.
    
    Did not add constructor to class 'CStack<Student>' at CStack.hpp:16.
      Type 'stack' is from std namespace or system header and is not supported.
    
    Did not add member 'getData' to class 'CStack<Student>' at CStack.hpp:39.
      Type 'stack' is from std namespace or system header and is not supported.
     
    Using MinGW64 Compiler (C++) compiler.
    Generated definition file definestack.mlx and data file 'stackData.xml' 
    contain definitions for 13 constructs supported by MATLAB.
    Build using build(definestack).

    Проигнорируйте Did not add сообщения. В MATLAB вы вызываете функции readStudentsWrapper и getStudentsWrapper вместо readStudents и getStudents. Конструктор, чтобы классифицировать CStack и член getData используются внутренне и не вызываемые от интерфейса.

  6. Создайте интерфейс.

    build(definestack)
    addpath('stack')
  7. Добавьте разделяемый путь к библиотеке к системе (время выполнения) путь. Если файл расположен на rtPath, затем тип:

    syspath = getenv('PATH');
    rtPath = 'myrtpathname';
    setenv('PATH',[rtPath ';' syspath]);
    
  8. Вызовите readStudentsWrapper.

    studentsStack = clib.stack.CStack_Student_;
    studentsStack.add(clib.stack.Student(1))
    studentsStack.add(clib.stack.Student(2))
    studentsStack.add(clib.stack.Student(3))
    clib.stack.readStudentsWrapper(studentsStack)
  9. Вызовите getStudentsWrapper.

    clear studentsStack;
    studentsStack = clib.stack.getStudentsWrapper(3);
    student = studentsStack.get; % returns topmost element from studentStack
    studentsStack.remove % removes topmost element of stack

Шаблоны классов с неполными или Недостающими инстанцированиями

Интерфейс MATLAB к библиотеке C++ не поддерживает неинстанцированные шаблонные классы. Например, класс Pairs в этом Templates.hpp заголовочный файл не инстанцируют.

// Header for Template class
#ifndef templates_Header
#define templates_Header

template <class T>
class Pairs { 
public:
    T val1;
    T val2;
    Pairs() : val1(0), val2(0) {}
    Pairs(T first, T second) : val1(first), val2(second) {}
    T getVal1() {
        return val1;
    }
    T getVal2() {
        return val2;
    }
};
#endif
  1. Включать Pairs класс, создайте этот заголовочный файл обертки TemplatesWrapper.hpp. Примите тот Pairs поддержки int и double типы данных.

    //Wrapper to instantiate template class Pairs
    #include "Templates.hpp"
    
    /* Data types that will be used for Pairs class. */
    template class Pairs<int>;
    template class Pairs<double>;
  2. Сгенерируйте определение библиотеки.

    clibgen.generateLibraryDefinition(["TemplatesWrapper.hpp","Templates.hpp"],"PackageName","Templates","Verbose",true)
    Generated definition file defineTemplates.mlx and data file 'TemplatesData.xml' 
    contain definitions for 16 constructs supported by MATLAB.
    Build using build(defineTemplates).
  3. Создайте интерфейс.

    build(defineTemplates)
    addpath('Templates')
  4. Создайте Pairs объекты и вызов getVal1 и getVal2 функции.

    Pairs1 = clib.Templates.Pairs_int_(2,3);
    Val1 = Pairs1.getVal1;
    Pairs2 = clib.Templates.Pairs_double_(4.5,10.9);
    Val2 = Pairs2.getVal2;
    Pairs3 = clib.Templates.Pairs_int_(4.3,10.9);
    Val2 = Pairs3.getVal2;

Директивы препроцессору

Интерфейс MATLAB к библиотеке C++ не поддерживает директивы препроцессору (макросы). Например, этот Area.hpp заголовочный файл задает макро-PI. Если вы создаете интерфейс MATLAB, PI не включен.

//Header with Macro preprocessor directive
#ifndef area_header
#define area_header

#ifdef _WIN32
#ifdef EXPORT
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT __declspec(dllimport)
#endif
#else
#define DLL_EXPORT __attribute__((visibility ("default")))
#endif

#define PI 3.1415   

DLL_EXPORT double getArea(int radius, double piVal);

#endif
  1. Чтобы запустить этот пример на Windows, создайте Area.lib и Area.dll файлы от этого Area.cpp исходный файл, с помощью Примера Сборки Совместно использовал Файлы Библиотеки на Windows.

    #define EXPORT
    
    #include "Area.hpp"
    
    DLL_EXPORT double getArea(int radius, double piVal) {
        return piVal*radius*radius;
    }
  2. Создайте Area.hpp заголовочный файл и помещенный это с Area.dll совместно использованный файл библиотеки в папке, идентифицированной как rtpath.

  3. Включать PI, создайте этот заголовочный файл обертки WrapperPI.hpp который задает функциональный getPI получить значение директивы препроцессору.

    //Wrapper to access the preprocessor directive value
    #include "Area.hpp"
    
    double getPI(){ //Wrapper function retrieves the value of PI
        return PI;
    }
  4. Сгенерируйте определение библиотеки.

    clibgen.generateLibraryDefinition(["Area.hpp","WrapperPI.hpp"],"PackageName","Area",...
        "Libraries","Area.lib","TreatObjectPointerAsScalar",true,"Verbose",true)
  5. Создайте интерфейс.

    build(defineArea)
    addpath('Area')
  6. Добавьте разделяемый путь к библиотеке к системе (время выполнения) путь. Если файл расположен на rtPath, затем тип:

    syspath = getenv('PATH');
    rtPath = 'myrtpathname';
    setenv('PATH',[rtPath ';' syspath]);
    
  7. Вызовите getArea.

    pi = clib.Area.getPI;
    area = clib.Area.getArea(2,pi)
    area =
    
       12.5660

Массивы строк

Интерфейс MATLAB к библиотеке C++ не включает функции с аргументами std::string для типа элемента вектора. Например, readStringVector и getStringVector функции в этом StringVector.hpp заголовочный файл не включен, когда вы создаете интерфейс MATLAB.

//Header file which accepts and return the vector of std::string
#ifndef stringVec_header
#define stringVec_header
#include <vector>
#include <string>

#ifdef _WIN32
#ifdef EXPORT
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT __declspec(dllimport)
#endif
#else
#define DLL_EXPORT __attribute__((visibility ("default")))
#endif

DLL_EXPORT void readStringVector(const std::vector<std::string>& stringVector); //readStringVector function gets dropped as vector of std::string input is not supported in MATLAB C++ interface.

DLL_EXPORT std::vector<std::string> getStringVector(int size); //getStringVector function gets dropped as return type of vector of std::string is not supported for MATLAB C++ Interface

#endif
  1. Чтобы запустить этот пример на Windows, создайте StringVector.lib и StringVector.dll файлы от этого StringVector.cpp исходный файл, с помощью Примера Сборки Совместно использовал Файлы Библиотеки на Windows.

    #define EXPORT
    
    #include "StringVector.hpp"
    
    DLL_EXPORT void readStringVector(const std::vector<std::string>& stringVector) {
    }
    
    DLL_EXPORT std::vector<std::string> getStringVector(int size) {
        std::vector<std::string> stringVector;
        for (int i = 0; i < size; i++) {
           stringVector.push_back(("string"+ std::to_string(i+1)));
        }
        return stringVector;
    }
  2. Создайте StringVector.hpp заголовочный файл и помещенный это с StringVector.dll совместно использованный файл библиотеки в папке, идентифицированной как rtpath.

  3. Поддерживать std::vector из типа std::string, создайте CVector класс, который задает эти методы, чтобы передать std::vector между MATLAB и библиотекой.

    • Параметризованный конструктор:

      CVector(const std::vector<T>& d): data(d)
    • Перемещение конструктора:

      CVector(std::vector<T>&& d) : data(std::move(d))
    • Метод, чтобы получить доступ к элементу в индексе:

      T get(int index)
    • Метод, чтобы добавить элементы в векторы:

      void add(const T& element)
    • Метод, чтобы получить данные из векторов:

      const std::vector<T>& getData() const

    CVector.hpp задает этот класс.

    //Wrapper header to access/pass std::vector from MATLAB
    #ifndef cvector_header
    #define cvector_header
    
    #include <vector>
    
    template<typename T>
    class CVector {
        std::vector<T> data;
    public:
        CVector() {}
        CVector(const std::vector<T>& d): data(d) {}
        CVector(std::vector<T>&& d) : data(std::move(d)) {}
        T get(int index) { 
            return data.at(index-1);
        }
        void add(const T& element) { 
            data.push_back(element);
        }
        const std::vector<T>& getData() const {
            return data;
        }
    };
    
    #endif
  4. Включать readStringVector и getStringVector, создайте WrapperStringVector.hpp заголовочный файл, который задает методы, чтобы передать CVector аргументы к методам библиотеки C++.

    // Header that allows the readStringVector and getStringVector functions 
    // to be accessed from MATLAB interface
    #include "StringVector.hpp"
    #include "CVector.hpp"
    #include <string>
    
    void wrapperReadStringVector(const CVector<std::string>& stringVec) { 
        readStringVector(stringVec.getData());
    }
    
    CVector<std::string> wrapperGetStringVector(int size) { 
        auto strVec = getStringVector(size);
        CVector<std::string> cvecString(strVec);
        return cvecString;
    }
  5. Сгенерируйте определение библиотеки.

    clibgen.generateLibraryDefinition(["StringVector.hpp","WrapperStringVector.hpp"],"PackageName","StringVector",...
        "Libraries","StringVector.lib","TreatObjectPointerAsScalar",true,"Verbose",true)
  6. Создайте интерфейс.

    build(defineWrapperStringVector)
    addpath('WrapperStringVector')
  7. Добавьте разделяемый путь к библиотеке к системе (время выполнения) путь. Если файл расположен на rtPath, затем тип:

    syspath = getenv('PATH');
    rtPath = 'myrtpathname';
    setenv('PATH',[rtPath ';' syspath]);
    
  8. Вызовите функции.

    % Instantiate the CVector class
    stringVectorObj = clib.StringVector.CVector_std____cxx11__basic_string_char_Std__char_traits_c;
    
    % Add elements to vector
    stringVectorObj.add("Jack");
    stringVectorObj.add("John");
    stringVectorObj.add("Joe");
    
    % Call function with std::string vector input with CVector
    clib.StringVector.wrapperReadStringVector(stringVectorObj);
    clear stringVectorObj;

Создайте совместно использованные файлы библиотеки примера на Windows

В командной строке Windows добавьте путь к компилятору MinGW-w64 к системному пути. Например, если компилятор в mingwpath, затем тип:

mingwpath = 'mingwpathname';
set PATH=mingwpath;%PATH%

Перейдите к местоположению исходных файлов C++.

Запустите эти команды, чтобы сгенерировать совместно использованную библиотеку от исходного файла source.cpp:

mingwpath\g++ -c source.cpp -o source.obj -std=c++11
mingwpath\g++ -shared -o source.dll source.obj -Wl,--out-implib,source.lib

Похожие темы

Для просмотра документации необходимо авторизоваться на сайте