Main Content

coder.BLASCallback.getBLASDoubleComplexTypeName

Class: coder.BLASCallback
Package: coder

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

Syntax

doubleComplexTypeName = coder.BLASCallback.getBLASDoubleComplexTypeName()

Description

doubleComplexTypeName = coder.BLASCallback.getBLASDoubleComplexTypeName() returns the name of the double-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 getBLASDoubleComplexTypeName method from coder.BLASCallback. If your BLAS library takes a type other than double* and void* for double-precision complex array arguments, you must override the inherited getBLASDoubleComplexTypeName method with your own implementation in your callback class definition.

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

Output Arguments

expand all

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

Attributes

Statictrue

To learn about attributes of methods, see Method Attributes.

Examples

expand all

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

function doubleComplexTypeName = getBLASDoubleComplexTypeName()
doubleComplexTypeName = 'my_double_complex_type';
end

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

Introduced in R2018b