Embedded MATLAB Run-Time Library -- Categorical List :: Embedded MATLAB Function Block Reference (Simulink Reference)

Simulink Reference

Embedded MATLAB Run-Time Library -- Categorical List

The following topics list functions in the Embedded MATLAB run-time library by different function types. Each entry includes a function name link to online help for the equivalent MATLAB function along with a one-line description and any limitations that apply to it.

Arithmetic Operator Functions

See Arithmetic Operators + - * / \ ^ ' in MATLAB online help for detailed descriptions on any of the following operator equivalent functions.

Function
Description

ctranspose
Complex conjugate transpose (')

isa
Determine if input is object of given class

ldivide
Arraywise left division

minus
Minus (-)

mldivide
Left matrix divide (\)

mpower
Equivalent of elementwise power operator (.^)

mrdivide
Matrix right division

mtimes
Matrix multiply (*)

plus
Plus (+)

power
Arraywise power

rdivide
Arraywise right division

times
Arraywise multiplication

transpose
Matrix transpose (')

uminus
Unary minus (-)

uplus
Unary plus (+)

Function	Description
`ctranspose`	Complex conjugate transpose (`'`)
`isa`	Determine if input is object of given class
`ldivide`	Arraywise left division
`minus`	Minus (`-`)
`mldivide`	Left matrix divide (`\`)
`mpower`	Equivalent of elementwise power operator (.^)
`mrdivide`	Matrix right division
`mtimes`	Matrix multiply (`*`)
`plus`	Plus (`+`)
`power`	Arraywise power
`rdivide`	Arraywise right division
`times`	Arraywise multiplication
`transpose`	Matrix transpose (`'`)
`uminus`	Unary minus (`-`)
`uplus`	Unary plus (`+`)

Casting Functions

Embedded MATLAB functions support the following functions for converting one type of data to another:

Data Type
Description

cast
Cast variable to different data type

char
Create character array (string)

class
Query class of object argument

double
Convert to double-precision floating point

int8, int16, int32
Convert to signed integer data type

logical
Convert to Boolean true or false data type

single
Convert to single-precision floating point

uint8, uint16, uint32
Convert to unsigned integer data type

Data Type	Description
`cast`	Cast variable to different data type
`char`	Create character array (string)
`class`	Query class of object argument
`double`	Convert to double-precision floating point
`int8,` `int16,` `int32`	Convert to signed integer data type
`logical`	Convert to Boolean `true` or `false` data type
`single`	Convert to single-precision floating point
`uint8,` `uint16,` `uint32`	Convert to unsigned integer data type

Complex Number Functions

Embedded MATLAB functions support the following functions for complex numbers:

Function
Description

complex
Construct complex data from real and imaginary components; aee Declaring Complex Variables Implicitly in Embedded MATLAB Functions in Simulink online documentation

conj
Return the conjugate of a complex number

imag
Return the imaginary part of a complex number

isnumeric
True for numeric arrays

isreal
Return false (0) for a complex number

isscalar
True if array is a scalar

real
Return the real part of a complex number

Function	Description
`complex`	Construct complex data from real and imaginary components; aee Declaring Complex Variables Implicitly in Embedded MATLAB Functions in Simulink online documentation
`conj`	Return the conjugate of a complex number
`imag`	Return the imaginary part of a complex number
`isnumeric`	True for numeric arrays
`isreal`	Return false (0) for a complex number
`isscalar`	True if array is a scalar
`real`	Return the real part of a complex number

Exponential Functions

Embedded MATLAB functions support the following elementary exponential functions:

Function
Description

exp
Exponential

factorial
Factorial function

log
Natural logarithm

sqrt
Square root

Function	Description
`exp`	Exponential
`factorial`	Factorial function
`log`	Natural logarithm
`sqrt`	Square root

Input and Output Functions

Embedded MATLAB functions support the following functions for accessing argument and return values:

Function
Description

nargin
Return the number of input arguments a user has supplied

nargout
Return the number of output return values a user has requested

Function	Description
`nargin`	Return the number of input arguments a user has supplied
`nargout`	Return the number of output return values a user has requested

Logical Operator Functions

Embedded MATLAB functions support the following functions for performing logical operations:

Function
Description

and
Logical AND (&)

not
Logical NOT (~)

or
Logical OR (|)

Function	Description
`and`	Logical AND (`&`)
`not`	Logical NOT (`~`)
`or`	Logical OR (`\|`)

Matrix/Array Functions

Embedded MATLAB functions support the following functions:

Function
Description

abs
Return absolute value and complex magnitude of an array

all
Test if all elements are nonzero

angle
Phase angle

any
Test for any nonzero elements

cross
Vector cross product

cumprod
Cumulative product of array elements

cumsum
Cumulative sum of array elements

diag
Return a matrix formed around the specified diagonal vector and the specified diagonal (0, 1, 2,...) it occupies

diff
Differences and approximate derivatives

eye
Identity matrix

false
Return an array of 0's for the specified dimensions

interp1
One-dimensional interpolation (table lookup)

interp1q, see interp1
One-dimensional data interpolation (table lookup)

inv
Inverse of a square matrix

isempty
Test if an array is empty

isfloat
Determine if input is floating-point array

isfinite
Detect finite elements of an array

isinf
Detect infinite elements of an array (simulation only)

isnan
Detect NaN elements of an array (simulation only)

length
Return the length of a matrix

lu
Matrix factorization

max
Maximum elements of a matrix

min
Minimum elements of a matrix

ndims
Number of dimensions

ones
Create a matrix of all ones

pinv
Pseudoinverse of a matrix

prod
Product of array element

repmat
Replicate and tile an array

reshape
Reshape one array into the dimensions of another

sign
Signum function

size
Return the size of a matrix

sort
Sort elements in ascending or descending order.

sum
Sum of matrix elements

tril
Extract lower triangular part

triu
Extract upper triangular part

true
Return an array of logical (Boolean) 1's for the specified dimensions

zeros
Create a matrix of all zeros

Function	Description
`abs`	Return absolute value and complex magnitude of an array
`all`	Test if all elements are nonzero
`angle`	Phase angle
`any`	Test for any nonzero elements
`cross`	Vector cross product
`cumprod`	Cumulative product of array elements
`cumsum`	Cumulative sum of array elements
`diag`	Return a matrix formed around the specified diagonal vector and the specified diagonal (0, 1, 2,...) it occupies
`diff`	Differences and approximate derivatives
`eye`	Identity matrix
`false`	Return an array of 0's for the specified dimensions
`interp1`	One-dimensional interpolation (table lookup)
`interp1q`, see `interp1`	One-dimensional data interpolation (table lookup)
`inv`	Inverse of a square matrix
`isempty`	Test if an array is empty
`isfloat`	Determine if input is floating-point array
`isfinite`	Detect finite elements of an array
`isinf`	Detect infinite elements of an array (simulation only)
`isnan`	Detect NaN elements of an array (simulation only)
`length`	Return the length of a matrix
`lu`	Matrix factorization
`max`	Maximum elements of a matrix
`min`	Minimum elements of a matrix
`ndims`	Number of dimensions
`ones`	Create a matrix of all ones
`pinv`	Pseudoinverse of a matrix
`prod`	Product of array element
`repmat`	Replicate and tile an array
`reshape`	Reshape one array into the dimensions of another
`sign`	Signum function
`size`	Return the size of a matrix
`sort`	Sort elements in ascending or descending order.
`sum`	Sum of matrix elements
`tril`	Extract lower triangular part
`triu`	Extract upper triangular part
`true`	Return an array of logical (Boolean) 1's for the specified dimensions
`zeros`	Create a matrix of all zeros

Relational Operator Functions

Embedded MATLAB functions support the following functions for performing relational operations:

Function
Description

eq
Equal (==)

ge
Greater than or equal to (>=)

gt
Greater than (>)

le
Less than or equal to (<=)

lt
Less than (<)

ne
Not equal (~=)

Function	Description
`eq`	Equal (`==`)
`ge`	Greater than or equal to (`>=`)
`gt`	Greater than (`>`)
`le`	Less than or equal to (`<=`)
`lt`	Less than (`<`)
`ne`	Not equal (`~=`)

Rounding and Remainder Functions

Embedded MATLAB functions support the following rounding and remainder functions:

Function
Description

ceil
Round toward plus infinity

fix
Round toward zero

floor
Round toward minus infinity

mean
Average or mean value

mod
Modulus (signed remainder after division)

rem
Remainder after division

round
Round toward nearest integer

Function	Description
`ceil`	Round toward plus infinity
`fix`	Round toward zero
`floor`	Round toward minus infinity
`mean`	Average or mean value
`mod`	Modulus (signed remainder after division)
`rem`	Remainder after division
`round`	Round toward nearest integer

Signal Processing Functions

Embedded MATLAB supports the following signal processing functions:

Function
Description

chol
Cholesky factorization

conv
Convolution and polynomial multiplication
(license required -- see note below)

fft
Discrete Fourier transform
(license required -- see note below)

filter
Filter a data sequence using a digital filter that works for both real and complex inputs
(license required -- see note below)

ifft
Inverse discrete Fourier transform
(license required -- see note below)

sosfilt
Second order (biquadratic) IIR filtering
(license required -- see note below)

svd
Singular value decomposition

xcorr
Cross-correlation function estimates
(license required -- see note below)

Function	Description
`chol`	Cholesky factorization
`conv`	Convolution and polynomial multiplication (license required -- see note below)
`fft`	Discrete Fourier transform (license required -- see note below)
`filter`	Filter a data sequence using a digital filter that works for both real and complex inputs (license required -- see note below)
`ifft`	Inverse discrete Fourier transform (license required -- see note below)
`sosfilt`	Second order (biquadratic) IIR filtering (license required -- see note below)
`svd`	Singular value decomposition
`xcorr`	Cross-correlation function estimates (license required -- see note below)

Note Some signal processing functions for the Embedded MATLAB Run-Time Function Library require a Signal Processing Blockset license. These functions also have file dependencies on static functions supplied for some of the Signal Processing blocks. For code deployment to another environment, be sure to consult the generated make file for the RTW target you build to identify and locate these file dependencies.

Special Values

Embedded MATLAB functions support the following special data values:

Symbol
Description

eps
Return floating-point relative accuracy

Inf or inf
Return IEEE arithmetic representation for positive infinity (simulation only)

intmax
Largest possible value of specified integer type

intmin
Smallest possible value of specified integer type

NaN or nan
Return not a number (simulation only)

pi
Return the ratio of the circumference to the diameter for a circle

realmax
Return the largest positive floating-point number

realmin
Return the smallest positive floating-point number

Symbol	Description
`eps`	Return floating-point relative accuracy
Inf or `inf`	Return IEEE arithmetic representation for positive infinity (simulation only)
`intmax`	Largest possible value of specified integer type
`intmin`	Smallest possible value of specified integer type
NaN or `nan`	Return not a number (simulation only)
`pi`	Return the ratio of the circumference to the diameter for a circle
`realmax`	Return the largest positive floating-point number
`realmin`	Return the smallest positive floating-point number

String Functions

Embedded MATLAB functions support the following functions for handling strings:

Function
Description

char
Create character array (string)

ischar
True for character array (string)

strcmp
Return a logical result for the comparison of two strings; limited to strings known at compile time

Function	Description
`char`	Create character array (string)
`ischar`	True for character array (string)
`strcmp`	Return a logical result for the comparison of two strings; limited to strings known at compile time

Trigonometric Functions

Embedded MATLAB functions support the following elementary trigonometric functions:

Function
Description

acos
Inverse cosine

acosh
Inverse hyperbolic cosine

asin
Inverse sine

asinh
Inverse hyperbolic sine

atan
Inverse tangent

atan2
Four quadrant inverse tangent

atanh
Inverse hyperbolic tangent

cos
Cosine

cosh
Hyperbolic cosine

sin
Sine

sinh
Hyperbolic sine

tan
Tangent

tanh
Hyperbolic tangent

Function	Description
`acos`	Inverse cosine
`acosh`	Inverse hyperbolic cosine
`asin`	Inverse sine
`asinh`	Inverse hyperbolic sine
`atan`	Inverse tangent
`atan2`	Four quadrant inverse tangent
`atanh`	Inverse hyperbolic tangent
`cos`	Cosine
`cosh`	Hyperbolic cosine
`sin`	Sine
`sinh`	Hyperbolic sine
`tan`	Tangent
`tanh`	Hyperbolic tangent

Embedded MATLAB Run-Time Function Library -- Alphabetical List Unsupported MATLAB Features and Limitations