coder.BLASCallback.getBLASSingleComplexTypeName

Class: coder.BLASCallback
Namespace: coder

Return name of single-precision complex data type used by CBLAS interface

Syntax

singleComplexTypeName = coder.BLASCallback.getBLASSingleComplexTypeName()


Description

singleComplexTypeName = coder.BLASCallback.getBLASSingleComplexTypeName() returns the name of the single-precision complex data type that is used by the CBLAS interface to a specific BLAS library.

coder.BLASCallback is an abstract class for defining a BLAS callback class. A BLAS callback class specifies the BLAS library and CBLAS header and data type information to use for BLAS calls in code generated from MATLAB^® code. At code generation time, if you specify a BLAS callback class, for certain vector and matrix function calls, the code generator produces BLAS calls in standalone code.

By default, the callback class that you define inherits the getBLASSingleComplexTypeName method from coder.BLASCallback. If your BLAS library takes a type other than float* and void* for single-precision complex array arguments, you must override the inherited getBLASSingleComplexTypeName method with your own implementation in your callback class definition.

The generated code uses the single-precision complex data type name to specify types of variables in the generated code that produces BLAS calls.

Output Arguments

singleComplexTypeName — CBLAS single-precision complex data type name

character vector

Character vector that specifies the name of the single-precision complex data type that the CBLAS interface to a specific BLAS library uses.

Attributes

Static

true

To learn about attributes of methods, see Method Attributes.

Examples

Return Single Complex Type Name

If your BLAS library takes a type other than float* and void* for single-precision complex array arguments, you must include this Static method in your callback class definition.

function singleComplexTypeName = getBLASSingleComplexTypeName()
doubleComplexTypeName = 'my_single_complex_type';
end

Replace my_single_complex_type with the type that your BLAS library takes for single-precision complex array arguments.

Version History

Introduced in R2018b