Platform-independent types. More...

Modules
	Specializations for numeric_traits
	The number traits class is specialized for number types defined in this API, such as mi::Uint32 and mi::Float64.

Namespaces
namespace	mi::base
	Namespace for the Base API.

Classes
struct	mi::base::numeric_traits_base<T>
	Base class for the helper class to deduce properties of numeric types defined in this API. More...

struct	mi::base::numeric_traits<T>
	Helper class to deduce properties of numeric types defined in this API. More...

Macros
#define	MI_BASE_FMT_MI_SINT64 "lld"
	The `printf` format specifier for mi::Sint64. More...

#define	MI_BASE_FMT_MI_UINT64 "llu"
	The `printf` format specifier for mi::Uint64. More...

#define	MI_BASE_FMT_MI_SIZE "llu"
	The `printf` format specifier for mi::Size. More...

#define	MI_BASE_FMT_MI_DIFFERENCE "lld"
	The `printf` format specifier for mi::Difference. More...

#define	MI_PI 3.14159265358979323846
	Value of Pi. More...

#define	MI_PI_2 1.57079632679489661923
	Value of Pi / 2. More...

#define	MI_PI_4 0.78539816339744830962
	Value of Pi / 4. More...

Typedefs
typedef signed char	mi::Sint8
	8-bit signed integer. More...

typedef signed short	mi::Sint16
	16-bit signed integer. More...

typedef signed int	mi::Sint32
	32-bit signed integer. More...

typedef unsigned char	mi::Uint8
	8-bit unsigned integer. More...

typedef unsigned short	mi::Uint16
	16-bit unsigned integer. More...

typedef unsigned int	mi::Uint32
	32-bit unsigned integer. More...

typedef float	mi::Float32
	32-bit float. More...

typedef double	mi::Float64
	64-bit float. More...

typedef long long	mi::Sint64
	64-bit signed integer. More...

typedef unsigned long long	mi::Uint64
	64-bit unsigned integer. More...

typedef Uint64	mi::Size
	Unsigned integral type that is large enough to hold the size of all types. More...

typedef Sint64	mi::Difference
	Signed integral type that is large enough to hold the difference of two pointers. More...

Enumerations
enum	mi::Comparison_result { mi::NEGATIVE = -1 , mi::ZERO = 0 , mi::POSITIVE = 1 , mi::LESS = -1 , mi::EQUAL = 0 , mi::GREATER = 1 }
	An enum for a three-valued comparison result. More...

Functions
Comparison_result	mi::operator- (Comparison_result sign)
	Reverses the sign of a three valued enum. More...

template<typename T>
Comparison_result	mi::three_valued_sign (T t)
	Returns the three valued sign for a numerical type `T`. More...

template<typename T>
Comparison_result	mi::three_valued_compare (T lhs, T rhs)
	Returns the three valued comparison result between two values of a numerical type `T`. More...

template<class Target , class Source>
Target	mi::base::binary_cast (Source const &val)
	Cast an immutable 'Source' value to an immutable 'Target' value. More...

Variables
static const Size	mi::SIZE_MAX_VALUE = 18446744073709551615ULL
	The maximum value for `Size`. More...

static const Difference	mi::DIFFERENCE_MIN_VALUE = -9223372036854775807LL - 1LL
	The minimum value for `Difference`. More...

static const Difference	mi::DIFFERENCE_MAX_VALUE = 9223372036854775807LL
	The maximum value for `Difference`. More...

Detailed Description

Platform-independent types.

Include File:: #include <mi/base/types.h>

Macro Definition Documentation

^◆ MI_BASE_FMT_MI_DIFFERENCE

#define MI_BASE_FMT_MI_DIFFERENCE "lld"

The printf format specifier for mi::Difference.

mi::Difference x = ...;

printf( "x equals %" MI_BASE_FMT_MI_DIFFERENCE " \n", x);

MI_BASE_FMT_MI_DIFFERENCE

#define MI_BASE_FMT_MI_DIFFERENCE

The printf format specifier for mi::Difference.

Definition: types.h:184

mi::Difference

Sint64 Difference

Signed integral type that is large enough to hold the difference of two pointers.

Definition: types.h:122

^◆ MI_BASE_FMT_MI_SINT64

#define MI_BASE_FMT_MI_SINT64 "lld"

The printf format specifier for mi::Sint64.

mi::Sint64 x = ...;

printf( "x equals %" MI_BASE_FMT_MI_SINT64 " \n", x);

mi::Sint64

long long Sint64

64-bit signed integer.

Definition: types.h:61

MI_BASE_FMT_MI_SINT64

#define MI_BASE_FMT_MI_SINT64

The printf format specifier for mi::Sint64.

Definition: types.h:89

^◆ MI_BASE_FMT_MI_SIZE

#define MI_BASE_FMT_MI_SIZE "llu"

The printf format specifier for mi::Size.

mi::Size x = ...;

printf( "x equals %" MI_BASE_FMT_MI_SIZE " \n", x);

mi::Size

Uint64 Size

Unsigned integral type that is large enough to hold the size of all types.

Definition: types.h:112

MI_BASE_FMT_MI_SIZE

#define MI_BASE_FMT_MI_SIZE

The printf format specifier for mi::Size.

Definition: types.h:172

^◆ MI_BASE_FMT_MI_UINT64

#define MI_BASE_FMT_MI_UINT64 "llu"

The printf format specifier for mi::Uint64.

mi::Uint64 x = ...;

printf( "x equals %" MI_BASE_FMT_MI_UINT64 " \n", x);

mi::Uint64

unsigned long long Uint64

64-bit unsigned integer.

Definition: types.h:62

MI_BASE_FMT_MI_UINT64

#define MI_BASE_FMT_MI_UINT64

The printf format specifier for mi::Uint64.

Definition: types.h:101

^◆ MI_PI

#define MI_PI 3.14159265358979323846

Value of Pi.

^◆ MI_PI_2

#define MI_PI_2 1.57079632679489661923

Value of Pi / 2.

^◆ MI_PI_4

#define MI_PI_4 0.78539816339744830962

Value of Pi / 4.

Typedef Documentation

^◆ Difference

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.

^◆ Float32

typedef float mi::Float32

32-bit float.

^◆ Float64

typedef double mi::Float64

64-bit float.

^◆ Sint16

typedef signed short mi::Sint16

16-bit signed integer.

^◆ Sint32

typedef signed int mi::Sint32

32-bit signed integer.

^◆ Sint64

typedef long long mi::Sint64

64-bit signed integer.

^◆ Sint8

typedef signed char mi::Sint8

8-bit signed integer.

^◆ Size

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.

^◆ Uint16

typedef unsigned short mi::Uint16

16-bit unsigned integer.

^◆ Uint32

typedef unsigned int mi::Uint32

32-bit unsigned integer.

^◆ Uint64

typedef unsigned long long mi::Uint64

64-bit unsigned integer.

^◆ Uint8

typedef unsigned char mi::Uint8

8-bit unsigned integer.

Enumeration Type Documentation

^◆ Comparison_result

enum mi::Comparison_result

An enum for a three-valued comparison result.

The three values, -1, 0, and 1, have several symbolic names that can be used interchangeable depending on the context. The symbolic names group together as indicated in their order.

Enumerator
NEGATIVE	= -1. Sign of a value is negative.
ZERO	= 0. Value is zero.
POSITIVE	= +1. Sign of a value is positive.
LESS	= -1. First value is less than second value.
EQUAL	= 0. First value is equal to second value.
GREATER	= +1. First value is greater than second value.

Function Documentation

^◆ binary_cast()

template<class Target , class Source>

Target mi::base::binary_cast ( Source const & val )

inline

Cast an immutable 'Source' value to an immutable 'Target' value.

Use this function as follows:

float fval( 0.0f );

Uint32 uval( binary_cast<Uint32>(fval) );

mi::Uint32

unsigned int Uint32

32-bit unsigned integer.

Definition: types.h:49

^◆ operator-()

Comparison_result mi::operator- ( Comparison_result sign )

inline

Reverses the sign of a three valued enum.

^◆ three_valued_compare()

template<typename T>

Comparison_result mi::three_valued_compare	(	T	lhs,
		T	rhs
	)

inline

Returns the three valued comparison result between two values of a numerical type T.

Precondition: Values of type T must be comparable.

Note: The result of this function is undefined if lhs or rhs is NaN.

^◆ three_valued_sign()

template<typename T>

Comparison_result mi::three_valued_sign ( T t )

inline

Returns the three valued sign for a numerical type T.

Precondition: The value of type T must be comparable against 0.

Note: The result of this function is undefined if t is NaN.

Variable Documentation

^◆ DIFFERENCE_MAX_VALUE

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.

^◆ DIFFERENCE_MIN_VALUE

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.

^◆ SIZE_MAX_VALUE

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.

Modules

Namespaces

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MI_BASE_FMT_MI_DIFFERENCE

◆ MI_BASE_FMT_MI_SINT64

◆ MI_BASE_FMT_MI_SIZE

◆ MI_BASE_FMT_MI_UINT64

◆ MI_PI

◆ MI_PI_2

◆ MI_PI_4

Typedef Documentation

◆ Difference

◆ Float32

◆ Float64

◆ Sint16

◆ Sint32

◆ Sint64

◆ Sint8

◆ Size

◆ Uint16

◆ Uint32

◆ Uint64

◆ Uint8

Enumeration Type Documentation

◆ Comparison_result

Function Documentation

◆ binary_cast()

◆ operator-()

◆ three_valued_compare()

◆ three_valued_sign()

Variable Documentation

◆ DIFFERENCE_MAX_VALUE

◆ DIFFERENCE_MIN_VALUE

◆ SIZE_MAX_VALUE

^◆ MI_BASE_FMT_MI_DIFFERENCE

^◆ MI_BASE_FMT_MI_SINT64

^◆ MI_BASE_FMT_MI_SIZE

^◆ MI_BASE_FMT_MI_UINT64

^◆ MI_PI

^◆ MI_PI_2

^◆ MI_PI_4

^◆ Difference

^◆ Float32

^◆ Float64

^◆ Sint16

^◆ Sint32

^◆ Sint64

^◆ Sint8

^◆ Size

^◆ Uint16

^◆ Uint32

^◆ Uint64

^◆ Uint8

^◆ Comparison_result

^◆ binary_cast()

^◆ operator-()

^◆ three_valued_compare()

^◆ three_valued_sign()

^◆ DIFFERENCE_MAX_VALUE

^◆ DIFFERENCE_MIN_VALUE

^◆ SIZE_MAX_VALUE