Main Content

compiler.build.CppSharedLibraryOptions

Options for building C++ shared libraries

    Description

    example

    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.

    example

    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

    collapse all

    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\R2021a\extern\examples\compiler\magicsquare.m'}
                   DebugBuild: off
                  LibraryName: 'magicsquare'
               LibraryVersion: '1.0.0.0'
              AdditionalFiles: {}
          AutoDetectDataFiles: on
                      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\R2021a\extern\examples\compiler\magicsquare.m'}
                   DebugBuild: off
                  LibraryName: 'magicsquare'
               LibraryVersion: '1.0.0.0'
              AdditionalFiles: {}
          AutoDetectDataFiles: on
                      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);

    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\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'

    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\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'

    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

    collapse all

    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 Pair Arguments

    Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

    Example: 'Verbose','on'

    Additional files 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. File paths can be relative to the current working directory or absolute.

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

    Data Types: char | string | cell

    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

    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 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'

    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

    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

    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. File 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

    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

    collapse all

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

    Introduced in R2021a