|
XCORE SDK
XCORE Software Development Kit
|
Classes | |
| struct | complex_s64_t |
| A complex number with a 64-bit real part and 64-bit imaginary part. More... | |
| struct | complex_s32_t |
| A complex number with a 32-bit real part and 32-bit imaginary part. More... | |
| struct | complex_s16_t |
| A complex number with a 16-bit real part and 16-bit imaginary part. More... | |
| struct | float_s32_t |
| A floating-point scalar with a 32-bit mantissa. More... | |
| struct | float_s64_t |
| A floating-point scalar with a 64-bit mantissa. More... | |
| struct | float_complex_s16_t |
| A complex floating-point scalar with a complex 16-bit mantissa. More... | |
| struct | float_complex_s32_t |
| A complex floating-point scalar with a complex 32-bit mantissa. More... | |
| struct | float_complex_s64_t |
| A complex floating-point scalar with a complex 64-bit mantissa. More... | |
Typedefs | |
| typedef int | exponent_t |
| An exponent. More... | |
| typedef unsigned | headroom_t |
| Headroom of some integer or integer array. More... | |
| typedef int | right_shift_t |
| A rightwards arithmetic bit-shift. More... | |
| typedef int | left_shift_t |
| A leftwards arithmetic bit-shift. More... | |
| typedef int32_t | fixed_s32_t |
| A 32-bit fixed-point scalar. More... | |
| typedef int16_t | fixed_s16_t |
| A 16-bit fixed-point scalar. More... | |
| typedef int exponent_t |
An exponent.
Many places in this API make use of integers representing the exponent associated with some floating-point value or block floating-point vector.
For a floating-point value \(x \cdot 2^p\), \(p\) is the exponent, and may usually be positive or negative.
| typedef int16_t fixed_s16_t |
A 16-bit fixed-point scalar.
Represents a 16-bit fixed-point scalar with a Q-format implied by the context in which it occurs. Typically this type will be used for fixed-point function parameters as a hint to the user to check the documentation for the required Q-format.
If a function has a fixed_s16_t parameter ending with _qXX (where the X are digits), the XX typically indicates the number of fractional bits. For example, a fixed_s16_t parameter called coef_q14 would imply 14 fractional bits and an associated exponent of -14. This is just a convention, however, and this interpretation should be verified in the function's documentation.
| typedef int32_t fixed_s32_t |
A 32-bit fixed-point scalar.
Represents a 32-bit fixed-point scalar with a Q-format implied by the context in which it occurs. Typically this type will be used for fixed-point function parameters as a hint to the user to check the documentation for the required Q-format.
If a function has a fixed_s32_t parameter ending with _qXX (where the X are digits), the XX typically indicates the number of fractional bits. For example, a fixed_s32_t parameter called coef_q30 would imply 30 fractional bits and an associated exponent of -30. This is just a convention, however, and this interpretation should be verified in the function's documentation.
| typedef unsigned headroom_t |
Headroom of some integer or integer array.
Represents the headroom of a signed or unsigned integer, complex integer or channel pair, or the headroom of the mantissa array of a block floating-point vector.
| typedef int left_shift_t |
A leftwards arithmetic bit-shift.
Represents a left bit-shift to be applied to an integer. May be signed or unsigned, depending on context. If signed, negative values represent rightward bit-shifts.
| typedef int right_shift_t |
A rightwards arithmetic bit-shift.
Represents a right bit-shift to be applied to an integer. May be signed or unsigned, depending on context. If signed, negative values represent leftward bit-shifts.
1.9.1