compiler.build.CppSharedLibraryOptions

Options for building C++ shared libraries

Since R2021a

Syntax

opts = compiler.build.CppSharedLibraryOptions(FunctionFiles)

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

Description

opts = compiler.build.CppSharedLibraryOptions(FunctionFiles) creates a C++ shared library options object using the MATLAB^® files FunctionFiles. Use the CppSharedLibraryOptions object as an input to the compiler.build.cppSharedLibrary function.

opts = compiler.build.CppSharedLibraryOptions(FunctionFiles,Name,Value) creates a CppSharedLibraryOptions object with options specified using one or more name-value arguments. Options include the library name, output directory, and additional files to include.

Examples

Create C++ Shared Library Options Object Using Function Files

Create a CppSharedLibraryOptions object using file input.

For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler.

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\R2024a\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
           LibraryVersion: '1.0.0.0'
          AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\magicsquarecppSharedLibrary'

You can modify the property values of an existing CppSharedLibraryOptions object using dot notation. For example, enable verbose output.

opts.Verbose = 'on'

opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2024a\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
           LibraryVersion: '1.0.0.0'
          AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: '.\magicsquarecppSharedLibrary'

Use the CppSharedLibraryOptions object as an input to the compiler.build.cppSharedLibrary function to build a C++ shared library.

buildResults = compiler.build.cppSharedLibrary(opts);

Customize C++ Shared Library Options Object

Create a CppSharedLibraryOptions object and customize it using name-value arguments.

For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler. Use name-value arguments to specify the output directory and disable automatic detection of data files.

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\R2024a\extern\examples\compiler\magicsquare.m'}
               DebugBuild: off
              LibraryName: 'magicsquare'
           LibraryVersion: '1.0.0.0'
          AdditionalFiles: {}
      AutoDetectDataFiles: off
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicSquareLib'

You can modify the property values of an existing CppSharedLibraryOptions object using dot notation. For example, enable verbose output.

opts.Verbose = 'on'

opts = 

  CppSharedLibraryOptions with properties:

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

Use the CppSharedLibraryOptions object as an input to the compiler.build.cppSharedLibrary function to build a C++ shared library.

buildResults = compiler.build.cppSharedLibrary(opts);

Input Arguments

FunctionFiles — Files implementing MATLAB functions

character vector | string scalar | cell array of character vectors | string array

Files implementing MATLAB functions, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute. Files must have a .m extension.

Example: ["myfunc1.m","myfunc2.m"]

Data Types: char | string | cell

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Verbose','on'

AdditionalFiles — Additional files

character vector | string scalar | cell array of character vectors | string array

Additional files and folders to include in the C++ shared library, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.

Example: 'AdditionalFiles',["myvars.mat","data.txt"]

Data Types: char | string | cell

AutoDetectDataFiles — Flag to automatically include data files

'on' (default) | on/off logical value

Flag to automatically include data files, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then data files that you provide as inputs to certain functions (such as load and fopen) are automatically included in the shared library.

• If you set this property to 'off', then you must add data files to the shared library using the AdditionalFiles property.

Example: 'AutoDetectDataFiles','off'

Data Types: logical

DebugBuild — Flag to enable debug symbols

'off' (default) | on/off logical value

Flag to enable debug symbols, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then the compiled library contains debug symbols.

• If you set this property to 'off', then the compiled library does not contain debug symbols.

Example: 'DebugBuild','on'

Data Types: logical

Interface — Interface API

'matlab-data' (default) | 'mwarray'

Interface API, specified as one of the following options:

• 'matlab-data' — Generate shared libraries using the MATLAB Data API.

• 'mwarray' — Generate shared libraries using the mwArray API.

For more information, see API Selection for C++ Shared Library.

Example: 'Interface','mwarray'

LibraryName — Name of C++ shared library

character vector | string scalar

Name of the C++ shared library, specified as a character vector or a string scalar. The default name of the generated library is the first entry of the FunctionFiles argument.

Example: 'LibraryName','mymagic'

Data Types: char | string

ObfuscateArchive — Flag to obfuscate deployable archive

'off' (default) | on/off logical value

Flag to obfuscate the deployable archive, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in MATLAB files are placed into a user package within the archive. Additionally, all .m files are converted to P-files before packaging. This option is equivalent to using mcc with -j and -s specified.

• If you set this property to 'off', then the deployable archive is not obfuscated. This is the default behavior.

Example: 'ObfuscateArchive','on'

Data Types: logical

OutputDir — Path to output directory

character vector | string scalar

Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

The default name of the build folder is the library name appended with cppSharedLibrary.

Example: 'OutputDir','D:\Documents\MATLAB\work\mymagiccppSharedLibrary'

Data Types: char | string

SampleGenerationFiles — MATLAB sample files

character vector | string scalar | cell array of character vectors | string array

MATLAB sample files used to generate sample C++ library files for functions included within the library, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute. Files must have a .m extension. For more information and limitations, see Sample Driver File Creation.

Example: 'SampleGenerationFiles',["sample1.m","sample2.m"]

Data Types: char | string | cell

SupportPackages — Support packages

'autodetect' (default) | 'none' | string scalar | cell array of character vectors | string array

Support packages to include, specified as one of the following options:

• 'autodetect' (default) — The dependency analysis process detects and includes the required support packages automatically.

• 'none' — No support packages are included. Using this option can cause runtime errors.

• A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see compiler.codetools.deployableSupportPackages.

Example: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

Data Types: char | string | cell

Verbose — Flag to control build verbosity

'off' (default) | on/off logical value

Flag to control build verbosity, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then the MATLAB command window displays progress information indicating compiler output during the build process.

• If you set this property to 'off', then the command window does not display progress information.

Example: 'Verbose','on'

Data Types: logical

Output Arguments

opts — C++ library build options

CppSharedLibraryOptions object

C++ library build options, returned as a CppSharedLibraryOptions object.

Version History

Introduced in R2021a