entry = registerCPPFunctionEntry(hTable, priority, numInputs, functionName, inputType, implementationName, outputType, headerFile, genCallback, genFileName, nameSpace)

Input Arguments

hTable

Handle to a CRL table previously returned by hTable = RTW.TflTable.

priority

Positive integer specifying the function entry's search priority, 0-100, relative to other entries of the same function name and conceptual argument list within this table. Highest priority is 0, and lowest priority is 100. If the table provides two implementations for a function, the implementation with the higher priority will shadow the one with the lower priority.

numInputs

Positive integer specifying the number of input arguments.

functionName

String specifying the name of the function to be replaced. The name must match one of the functions supported for replacement:

Math Functions

Note For detailed support information, see Map Math Functions to Target-Specific Implementations.

abs acos acosh asin

asinh atan atan2 atanh

ceil cos cosh exactrSqrt

exp fix floor frexp

hypot ldexp ln log

log10 max min mod/fmod

pow rem round rSqrt

saturate sign sin sincos

sinh sqrt round tanh

Memory Utility Functions

memcmp memcpy memset memset2zero¹

Nonfinite Support Utility Functions²

getInf getMinusInf getNaN isInf³

isNaN³

Notes:
¹ Some target processors provide optimized memset functions for use when performing a memory set to zero. The CRL API supports replacing memset to zero functions with more efficient target-specific functions.
² Replacement of nonfinite functions is supported for Simulink code generation (not for Stateflow or MATLAB Coder code generation).
³ Replacement of isInf and isNaN is supported only for complex floating-point inputs.

inputType

String specifying the data type of the input arguments, for example, 'double'. (This function requires that all input arguments are of the same type.)

implementationName

String specifying the name of your implementation. For example, if functionName is 'sqrt', implementationName can be 'sqrt' or a different name of your choosing.

outputType

String specifying the data type of the return argument, for example, 'double'.

headerFile

String specifying the header file in which the implementation function is declared, for example, '<math.h>'.

genCallback

String specifying '' or 'RTW.copyFileToBuildDir'. If you specify 'RTW.copyFileToBuildDir', and if this function entry is matched and used, the function RTW.copyFileToBuildDir will be called after code generation to copy additional header, source, or object files that you have specified for this function entry to the build directory. For more information, see Specify Build Information for Code Replacements in the Embedded Coder documentation.

genFileName

String specifying ''. (This argument is for use only by MathWorks developers.)

nameSpace

String specifying the C++ name space in which the implementation function is defined. If this function entry is matched, the software emits the name space in the generated function code (for example, std::sin(tfl_cpp_U.In1)). If you specify '', the software does not emit a name space designation in the generated code.

Output Arguments

Handle to the created CRL C++ function entry. Specifying the return argument in the registerCPPFunctionEntry function call is optional.

Description

The registerCPPFunctionEntry function provides a quick way to create and register a CRL C++ function entry. This function can be used only if your CRL C++ function entry meets the following conditions:

All input arguments are of the same type.
All input argument names and the return argument name follow the default Simulink naming convention:
- For input argument names, u1, u2, ..., un
- For return argument, y1

Note When you register a CRL containing C++ function entries, you must specify the value {'C++'} for the LanguageConstraint property of the CRL registry entry. For more information, see Register Code Replacement Libraries.

Examples

In the following example, the registerCPPFunctionEntry function is used to create a C++ function entry for sin in a CRL table.

hLib = RTW.TflTable;

hLib.registerCPPFunctionEntry(100, 1, 'sin', 'single', 'sin', ...
                              'single', 'cmath', '', '', 'std');