MATLAB Object For C++ Arrays

MATLAB^® provides an interface, clib.array, which wraps C++ native arrays and std::vector types. The term clib array refers to the MATLAB representation of these C++ types.

A MATLAB clib array is only defined when the corresponding C++ native array or std::vector is used by supported C++ constructs—function input and output arguments and data members. The provided headers must contain the definition of the element type. The construct must be supported by MATLAB and not dropped when building the interface.

Create MATLAB Object Representing C++ Array

To create a MATLAB object to pass to a C++ function, call the MATLAB clibArray function. For example, suppose that your library libname defines a class myclass. In MATLAB, you refer to this class as clib.libname.myclass. To create an array of five myclass objects:

myclassArray = clibArray('clib.libname.myclass',5);

The type of the MATLAB array myclassArray is clib.array.libname.myclass.

Convert MATLAB Array to C++ Array Object

You can use an existing MATLAB array as a C++ array object. Call the clibConvertArray function.

MATLAB C++ Object Array Properties

MATLAB arrays created with clibArray or clibConvertArray have these properties.

Property	Type	Access	Description
`Dimensions`	`double vector`	read-only	C++ dimensions of the array
`Resizable`	`logical scalar`	read-only	`true`—add/remove element allowed `false`—add/remove element not allowed

Property

Type

Access

Description

Dimensions

double vector

read-only

C++ dimensions of the array

Resizable

logical scalar

read-only

true—add/remove element allowed
false—add/remove element not allowed

MATLAB C++ Object Array Methods

MATLAB arrays created with clibArray or clibConvertArray have these methods.

Method	Signature	Description
`append`	`append([element])`	Add an optionally specified element to the end of the array. For a primitive MATLAB clib array, if there is no input argument, then a zero value is appended. For a class-type MATLAB clib array, if there is no input argument, then the class-type default constructor is appended. If the class-type default constructor is deleted, a runtime error occurs.
`removeLast`	`removeLast`	Remove the last element of the array. If the MATLAB clib array is empty, a runtime error occurs.
`double`	`double`	Convert to double precision.
`int8`	`int8`	Convert to `int8`.
`uint8`	`uint8`	Convert to `uint8`.
`int16`	`int16`	Convert to `int16`.
`uint16`	`uint16`	Convert to `uint16`.
`int32`	`int32`	Convert to `int32`.
`uint32`	`uint32`	Convert to `uint32`.
`int64`	`int64`	Convert to `int64`.
`uint64`	`uint64`	Convert to `uint64`.
`logical`	`logical`	Convert numeric values to logical.

Memory Management

The memory for MATLAB arrays created with clibArray or clibConvertArray is owned by MATLAB. To release the memory, call clibRelease.

Documentation