Basic Types
[Base API]
Modules
- The number traits class is specialized for number types defined in this API, such as mi::Uint32 and mi::Float64. More...
Namespaces
- namespace
- Namespace for the Base API. More...
Defines
- #define MI_PI 3.14159265358979323846
- Value of Pi.
- #define MI_PI_2 1.57079632679489661923
- Value of Pi / 2.
- #define MI_PI_4 0.78539816339744830962
- Value of Pi / 4.
Typedefs
- typedef Sint64 mi::Difference
- Signed integral type that is large enough to hold the difference of two pointers. More...
- typedef float mi::Float32
- 32-bit float.
- typedef double mi::Float64
- 64-bit float.
- typedef signed short mi::Sint16
- 16-bit signed integer.
- typedef signed int mi::Sint32
- 32-bit signed integer.
- typedef long long mi::Sint64
- 64-bit signed integer.
- typedef signed char mi::Sint8
- 8-bit signed integer.
- typedef Uint64 mi::Size
- Unsigned integral type that is large enough to hold the size of all types. More...
- typedef unsigned short mi::Uint16
- 16-bit unsigned integer.
- typedef unsigned int mi::Uint32
- 32-bit unsigned integer.
- typedef unsigned long long mi::Uint64
- 64-bit unsigned integer.
- typedef unsigned char mi::Uint8
- 8-bit unsigned integer.
Enumerations
- enum mi::Comparison_result{ NEGATIVE = -1, ZERO = 0, POSITIVE = 1, LESS = -1, EQUAL = 0, GREATER = 1}
- An enum for a three-valued comparison result. More...
Functions
- Comparison_result mi::operator-( Comparison_result sign)
- Reverse the sign of a three valued enum.
- template< typename T>Comparison_result mi::three_valued_compare( T lhs, T rhs)
- Return the three valued comparison result between two values of a numerical type T. More...
- template< typename T>Comparison_result mi::three_valued_sign( T t)
- Return the three valued sign for a numerical type T. More...
Variables
- static const Difference mi::DIFFERENCE_MAX_VALUE = 9223372036854775807LL
- The maximum value for Difference. More...
- static const Difference mi::DIFFERENCE_MIN_VALUE = -9223372036854775807LL - 1LL
- The minimum value for Difference. More...
- static const Size mi::SIZE_MAX_VALUE = 18446744073709551615ULL
- The maximum value for Size. More...
Defines
Typedefs
- typedef Sint64 mi::Difference
-
Signed integral type that is large enough to hold the difference of two pointers. It corresponds to a 32-bit signed integer on 32-bit architectures and a 64-bit signed integer on 64-bit architectures.
- typedef float mi::Float32
-
32-bit float.
- typedef double mi::Float64
-
64-bit float.
- typedef signed short mi::Sint16
-
16-bit signed integer.
- typedef signed int mi::Sint32
-
32-bit signed integer.
- typedef long long mi::Sint64
-
64-bit signed integer.
- typedef signed char mi::Sint8
-
8-bit signed integer.
- typedef Uint64 mi::Size
-
Unsigned integral type that is large enough to hold the size of all types. This type is for example used for dimensions and indices of vectors.
It corresponds to a 32-bit unsigned integer on 32-bit architectures and a 64-bit unsigned integer on 64-bit architectures.
- typedef unsigned short mi::Uint16
-
16-bit unsigned integer.
- typedef unsigned int mi::Uint32
-
32-bit unsigned integer.
- typedef unsigned long long mi::Uint64
-
64-bit unsigned integer.
- typedef unsigned char mi::Uint8
-
8-bit unsigned integer.
Enums
Functions
- Comparison_result mi::operator-( Comparison_result sign) [inline]
-
Reverse the sign of a three valued enum.
-
template< typename T>
Comparison_result mi::three_valued_compare( T lhs, T rhs) [inline] -
Return the three valued comparison result between two values of a numerical type T. Values of type T must be comparable.
Note:The result of this function is undefined if lhs or rhs is NaN.
-
template< typename T>
Comparison_result mi::three_valued_sign( T t) [inline] -
Return the three valued sign for a numerical type T. A value of type T must be comparable against 0.
Note:The result of this function is undefined if t is NaN.
Variables
- const Difference mi::DIFFERENCE_MAX_VALUE = 9223372036854775807LL [static]
-
The maximum value for Difference.
Note:The actual value of this constant depends on the architecture. Possible values are 9223372036854775807 on 64-bit architectures and 2147483647 on 32-bit architectures.
- const Difference mi::DIFFERENCE_MIN_VALUE = -9223372036854775807LL - 1LL [static]
-
The minimum value for Difference.
Note:The actual value of this constant depends on the architecture. Possible values are -9223372036854775808 on 64-bit architectures and -2147483648 on 32-bit architectures.
- const Size mi::SIZE_MAX_VALUE = 18446744073709551615ULL [static]
-
The maximum value for Size.
Note:The actual value of this constant depends on the architecture. Possible values are 18446744073709551615 on 64-bit architectures and 4294967295 on 32-bit architectures.