Using the Function Reference (MATLAB C++ Math Library)

Introduction

This reference gives you quick access to the prototypes and call syntax for the MATLAB C++ Math Library functions. The functions fall into these groups: the mwArray class interface, mwVarargin and mwVarargout constructors, the mathematical functions, and the utility functions. This section discusses the organization of the reference pages.

Refer to the online Application Program Interface Reference for documentation of the mx routines available from the MATLAB C++ Math Library.

Reference Pages

Use the reference pages to look up the prototypes and syntax for a MATLAB C++ Math Library function. At the bottom of each page, you'll find a link to the documentation for the MATLAB version of the function. Use the MATLAB function page to look up the description of the arguments and the behavior of the function.

Structure

A reference page for a MATLAB C++ Math Library function includes these sections:

Purpose
C++ Prototypes
C++ Syntax
MATLAB Syntax
See Also links to the documentation of the MATLAB version of the function and to the calling conventions

Overloaded versions of the C++ functions or prototypes with defaulted input arguments represent the MATLAB syntax. You'll find a different prototype for each way of calling the MATLAB function.

To make the reference pages easier to read:

The variable names that appear in the "MATLAB Syntax" section are used as parameter names in the prototypes for a function.
The first C++ prototype listed should correspond to the first C++ call to a function listed under "C++ Syntax" and to the first call listed under "MATLAB Syntax." The second C++ prototype corresponds to the second C++ call and the second MATLAB call, and so forth.

Note The "C++ Syntax" section shows only the calls supported by the library. When you link to the MATLAB version of the function, you may notice MATLAB syntax that support objects. Because this version of the MATLAB C++ Math Library does not support objects, the corresponding MATLAB function documentation regarding objects does not apply to the C++ version of the function.

Typographic Conventions

String arrays, including those that represent a function name, are italicized to indicate that you must assign a value to the variable.
In general, a lowercase variable name/argument indicates a vector.
In general, an uppercase variable name/argument indicates a matrix.

What Isn't Presented

Assignments to input arguments

Exceptions

Occasionally, a string, for example, "nobalance", or an integer is passed as an argument if that string or integer is the only valid value for the argument.
Occasionally, a call to horzcat() initializes a vector.
The number of C++ prototypes may not match the number of documented calls to the MATLAB function. This mismatch occurs if one prototype supports two ways of calling the MATLAB function or if an additional prototype has been added to support the omission of input or output arguments supported by MATLAB.

[ Previous | Help Desk | Next ]