![]() ![]() BRAHMS
Reference Manual » Component Interface » Native » Types » TYPE
This documentation is offline - click here to go online
Index | Search: Go online to use Search
| ||
Overview(See also C API (Component Interface)
The TYPE constant specifies a "primitive numeric type" (storage format, primitive bit width, real or complex), and/or data about the format of a numeric array. Can also indicate some non-numeric storage formats. Note that the vast majority of usage will simply be of one of the Shortcuts (see section below) union (logical OR) one of the Complexity constants, for instance Notes
ValuesA TYPE constant holds a value made up of the union (logical OR) of one of each of the following value sets. The value TYPE_UNSPECIFIED is distinct, and can be used to indicate that a type constant is not set. Storage FormatExactly one of the following values is used to indicate the storage format. Extract from a TYPE constant by logical AND with TYPE_FORMAT_MASK.
Primitive Bit-widthExactly one of the following values is used to indicate the primitive bit-width (if the storage format is TYPE_FORMAT_STRUCT or TYPE_FORMAT_CELL, the bit-width is TYPE_WIDTH_UNSPECIFIED). Extract from a TYPE constant by logical AND with TYPE_WIDTH_MASK. ComplexityExactly one of the following values is used to indicate the complexity (TYPE_COMPLEX_UNSPECIFIED is zero). If the storage format is TYPE_FORMAT_STRUCT or TYPE_FORMAT_CELL, the complexity must be TYPE_COMPLEX_UNSPECIFIED. Extract from a Complex Storage FormatExactly one of the following values is used to indicate the complex storage format (TYPE_CPXFMT_UNSPECIFIED is zero). Extract from a OrderingExactly one of the following values is used to indicate the order storage format (TYPE_ORDER_UNSPECIFIED is zero). Extract from a Additional MasksIntersect (logical AND) a TYPE constant with one of the following masks to extract aspects of the data it holds.
ShortcutsMost of the time you will use
SynonymsIn addition, some synonyms are provided.
MacrosThe following macros are defined for use with TYPE instances.
|
||
This is a documentation page for the BRAHMS Modular Execution (Simulation) Framework. For details of licensing and distribution, please click here. To advise of an error or omission, please click here. |