compiler.build.CppSharedLibraryOptions

Опции для создания общих библиотек C++

Свернуть все на странице

    Синтаксис

    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles)
    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles,Name,Value)

    Описание

    пример

    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles) создает объект опций общей библиотеки C++ с помощью MATLAB® файлы FunctionFiles. Используйте CppSharedLibraryOptions объект как вход в compiler.build.cppSharedLibrary функция.

    пример

    opts = compiler.build.CppSharedLibraryOptions(FunctionFiles,Name,Value) создает CppSharedLibraryOptions объект с опциями, заданными с помощью одного или нескольких аргументов в виде имя-значение. Опции включают имя библиотеки, выходную директорию и дополнительные файлы, которые нужно включить.

    Примеры

    свернуть все

    Создайте CppSharedLibraryOptions объект с использованием ввода файла.

    В данном примере используйте файл magicsquare.m расположен в matlabroot\ extern\примеры\компилятор.

    appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.CppSharedLibraryOptions(appFile)
    opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
           LibraryVersion: '1.0.0.0'
          AdditionalFiles: {}
      AutoDetectDataFiles: on
                  Verbose: off
                OutputDir: '.\magicsquarecppSharedLibrary'

    Можно изменять значения свойств существующей CppSharedLibraryOptions объект с использованием записи через точку. Для примера включите подробные выходы.

    opts.Verbose = 'on'
    opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
           LibraryVersion: '1.0.0.0'
          AdditionalFiles: {}
      AutoDetectDataFiles: on
                  Verbose: on
                OutputDir: '.\magicsquarecppSharedLibrary'

    Используйте CppSharedLibraryOptions объект как вход в compiler.build.cppSharedLibrary функция для создания общей библиотеки C++.

    buildResults = compiler.build.cppSharedLibrary(opts);

    Создайте CppSharedLibraryOptions объект и настройте его с помощью аргументов имя-значение.

    В данном примере используйте файл magicsquare.m расположен в matlabroot\ extern\примеры\компилятор. Используйте аргументы имя-значение, чтобы задать выход директории и отключить автоматическое обнаружение файлов данных.

    appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.CppSharedLibraryOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\MagicSquareLib',...
    'AutoDetectDataFiles','off')
    opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
           LibraryVersion: '1.0.0.0'
          AdditionalFiles: {}
      AutoDetectDataFiles: off
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicSquareLib'

    Можно изменять значения свойств существующей CppSharedLibraryOptions объект с использованием записи через точку. Для примера включите подробные выходы.

    opts.Verbose = 'on'
    opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
           LibraryVersion: '1.0.0.0'
          AdditionalFiles: {}
      AutoDetectDataFiles: off
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\MagicSquareLib'

    Используйте CppSharedLibraryOptions объект как вход в compiler.build.cppSharedLibrary функция для создания общей библиотеки C++.

    buildResults = compiler.build.cppSharedLibrary(opts);

    Входные параметры

    свернуть все

    Файлы, реализующие функции MATLAB, заданные как вектор символов, строковый скаляр, строковые массивы или массив ячеек векторов символов. Пути к файлам могут быть относительно текущей рабочей директории или абсолютными. Файлы должны иметь .m расширение.

    Пример: ["myfunc1.m","myfunc2.m"]

    Типы данных: char | string | cell

    Аргументы в виде пар имя-значение

    Задайте необязательные разделенные разделенными запятой парами Name,Value аргументы. Name - имя аргумента и Value - соответствующее значение. Name должны находиться внутри кавычек. Можно задать несколько аргументов в виде пар имен и значений в любом порядке Name1,Value1,...,NameN,ValueN.

    Пример: 'Verbose','on'

    Дополнительные файлы для включения в общую библиотеку C++, заданные как вектор символов, строковый скаляр, строковые массивы или массив ячеек векторов символов. Пути к файлам могут быть относительно текущей рабочей директории или абсолютными.

    Пример: 'AdditionalFiles',["myvars.mat","data.txt"]

    Типы данных: char | string | cell

    Флаг для автоматического включения файлов данных, заданный как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

    • Если вы задаете это свойство равным 'on', затем файлы данных, которые вы предоставляете в качестве входов для определенных функций (таких как load и fopen) автоматически включаются в общую библиотеку.

    • Если вы задаете это свойство равным 'off', затем необходимо добавить файлы данных в общую библиотеку с помощью AdditionalFiles свойство.

    Пример: 'AutoDetectDataFiles','off'

    Типы данных: logical

    Флаг для включения отладки символов, заданный как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

    • Если вы задаете это свойство равным 'on', затем скомпилированная библиотека содержит символы отладки.

    • Если вы задаете это свойство равным 'off', тогда скомпилированная библиотека не содержит символов отладки.

    Пример: 'DebugBuild','on'

    Типы данных: logical

    Интерфейс API, заданный как один из следующих опций:

    • 'matlab-data' - Создавайте общие библиотеки с помощью MATLAB Data API.

    • 'mwarray' - Создавайте общие библиотеки с помощью mwArray API.

    Для получения дополнительной информации см. раздел «Выбор API для общей библиотеки C++».

    Пример: 'Interface','mwarray'

    Имя общей библиотеки C++, заданное как вектор символов или строковый скаляр. Имя по умолчанию сгенерированной библиотеки является первой записью FunctionFiles аргумент.

    Пример: 'LibraryName','mymagic'

    Типы данных: char | string

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

    Именем по умолчанию для папки сборки является имя библиотеки, добавленное в cppSharedLibrary.

    Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagiccppSharedLibrary'

    Типы данных: char | string

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

    Пример: 'SampleGenerationFiles',["sample1.m","sample2.m"]

    Типы данных: char | string | cell

    Флаг для управления подробностями сборки, заданный как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

    • Если вы задаете это свойство равным 'on', затем в командном окне MATLAB отображается информация о прогрессе, указывающая на выход компилятора в процессе сборки.

    • Если вы задаете это свойство равным 'off'затем командное окно не отображает информацию о прогрессе.

    Пример: 'Verbose','on'

    Типы данных: logical

    Выходные аргументы

    свернуть все

    Опции сборки библиотеки C++, возвращенные как CppSharedLibraryOptions объект.

    См. также

    Введенный в R2021a

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

    Поддержка

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