Functions
SbBool	floatIsEqual (float A, float B, unsigned int numFloat)
	Return true if A and B are equal.

template<typename T>
T	Max (T a, T b)

template<typename T>
T	Min (T a, T b)

template<typename T>
T	shiftValue (T v, int offset)
	shift the value of offset representable values considering value type.

template<>
float	shiftValue (float v, int offset)

template<>
double	shiftValue (double v, int offset)

template<typename T>
T	Clamp (T a, T minV, T maxV)
	Clamps value to given range [minV, maxV].

template<typename T>
T	alignToNextPowerOf2 (T n, size_t shift)
	Return an integer multiple of 2^shift greater or equals to n.

template<typename T>
T	getNextPow2 (T a)
	Return the next power of 2 greater or equal to a.

template<int N, typename T>
T	nearestUpperMultipleOf (T v)
	Return the nearest upper multiple of some value.

template<int N, typename T>
T	nearestLowerMultipleOf (T v)
	Return the nearest lower multiple of some value.

int	getNextLog2 (int num)
	Return the next log of 2 greater or equal to a.

float	deg2Rad (float a)
	Convert degrees to radians.

float	rad2Deg (float a)
	Convert radians to degrees.

double	roundToNearestInt (double x)
	Round the double value to the nearest integer value.

bool	isNaN (double a)
	Returns true if the specified value is NaN.

int	rand ()
	Returns a pseudo-random integer between 0 and OIV_RAND_MAX.

void	srand (unsigned seed)
	Set seed for a new sequence of pseudo-random integers to be returned by rand()

template<typename T>
bool	isCoinc (const T &x, const T &y, T tol=(T) OIV_DEF_MATH_HELPER_EPS)
	Coincidence test using given tolerance.

template<typename T>
T	abs (const T &v)
	Return absolute value of v.

template<>
long int	abs (const long int &v)

template<>
float	abs (const float &v)

template<>
double	abs (const double &v)

template<typename T>
bool	isLessThan (const T &x, const T &y, T tol=(T) OIV_DEF_MATH_HELPER_EPS)
	Less than test (x < y) using given tolerance.

template<typename T>
bool	isGreaterThan (const T &x, const T &y, T tol=(T) OIV_DEF_MATH_HELPER_EPS)
	Greater than test (x > y) using given tolerance.

template<typename T>
bool	isLessOrEqualThan (const T &x, const T &y, T tol=(T) OIV_DEF_MATH_HELPER_EPS)
	Less or equal than test (x <= y) using given tolerance.

template<typename T>
bool	isGreaterOrEqualThan (const T &x, const T &y, T tol=(T) OIV_DEF_MATH_HELPER_EPS)
	Greater or equal than test (x >= y) using given tolerance.

template<typename T>
bool	checkRangeI (const T &x, const T &min, T max, T tol=(T) OIV_DEF_MATH_HELPER_EPS)
	Inside closed interval (including endpoints) using given tolerance test.

template<typename T>
bool	checkRangeE (const T &x, const T &min, T max, T tol=(T) OIV_DEF_MATH_HELPER_EPS)
	Inside open interval (excluding endpoints) using given tolerance test.

template<typename T>
bool	isCoincRelativeOrAbsolute (const T &A, const T &B, T maxRelativeError, T maxAbsoluteError)
	Relative or absolute error without sign comparison.

template<typename T>
int	sgn (const T &val)
	Implements signum return value in { -1, 0, +1 }.

template<typename T>
T	rangeMax ()
	Returns the maximum finite value representable by the numeric type T.

template<typename T>
T	rangeMin ()
	Returns the lowest finite value representable by the numeric type T, that is, a finite value x such that there is no other finite value y where y < x.

template<>
float	rangeMin< float > ()

template<>
double	rangeMin< double > ()

template<typename T>
T	fract (const T &)
	Return fractional part of given value.

template<>
float	fract (const float &value)

template<>
double	fract (const double &value)

template<>
long double	fract (const long double &value)


bool	isFinite (double value)
	Returns true if the value is a finite value (i.e.

bool	isFinite (float value)
	Returns true if the value is a finite value (i.e.

Variables
static const int	OIV_RAND_MAX = 32767
	Maximum value returned by SbMathHelper::rand()

static const float	OIV_DEF_MATH_HELPER_EPS = 1.e-6f
	Default epsilon value for coincidence and interval checking.

Function Documentation

◆ abs() [1/4]

template<>

double SbMathHelper::abs ( const double & v )

inline

Definition at line 216 of file SbMathHelper.h.

◆ abs() [2/4]

template<>

float SbMathHelper::abs ( const float & v )

inline

Definition at line 215 of file SbMathHelper.h.

◆ abs() [3/4]

template<>

long int SbMathHelper::abs ( const long int & v )

inline

Definition at line 214 of file SbMathHelper.h.

◆ abs() [4/4]

template<typename T>

T SbMathHelper::abs ( const T & v )

inline

Return absolute value of v.

Definition at line 213 of file SbMathHelper.h.

◆ alignToNextPowerOf2()

template<typename T>

T SbMathHelper::alignToNextPowerOf2	(	T	n,
		size_t	shift )

inline

Return an integer multiple of 2^shift greater or equals to n.

Definition at line 73 of file SbMathHelper.h.

◆ checkRangeE()

template<typename T>

bool SbMathHelper::checkRangeE	(	const T &	x,
		const T &	min,
		T	max,
		T	tol = (T)OIV_DEF_MATH_HELPER_EPS )

inline

Inside open interval (excluding endpoints) using given tolerance test.

Definition at line 268 of file SbMathHelper.h.

◆ checkRangeI()

template<typename T>

bool SbMathHelper::checkRangeI	(	const T &	x,
		const T &	min,
		T	max,
		T	tol = (T)OIV_DEF_MATH_HELPER_EPS )

inline

Inside closed interval (including endpoints) using given tolerance test.

Definition at line 258 of file SbMathHelper.h.

◆ Clamp()

template<typename T>

T SbMathHelper::Clamp	(	T	a,
		T	minV,
		T	maxV )

inline

Clamps value to given range [minV, maxV].

Definition at line 68 of file SbMathHelper.h.

◆ deg2Rad()

float SbMathHelper::deg2Rad ( float a )

inline

Convert degrees to radians.

Definition at line 120 of file SbMathHelper.h.

◆ floatIsEqual()

SbBool SbMathHelper::floatIsEqual	(	float	A,
		float	B,
		unsigned int	numFloat )

Return true if A and B are equal.

numFloat is the number of allowed representable IEEE float between A and B. For example, there is no number between 10000 and 10000.000977. So if numFloat=1 it will return true for these two numbers.

◆ fract() [1/4]

template<>

double SbMathHelper::fract ( const double & value )

inline

Definition at line 320 of file SbMathHelper.h.

◆ fract() [2/4]

template<>

float SbMathHelper::fract ( const float & value )

inline

Definition at line 315 of file SbMathHelper.h.

◆ fract() [3/4]

template<>

long double SbMathHelper::fract ( const long double & value )

inline

Definition at line 325 of file SbMathHelper.h.

◆ fract() [4/4]

template<typename T>

T SbMathHelper::fract ( const T & )

inline

Return fractional part of given value.

ex: fract(23.15) return 0.15

Definition at line 310 of file SbMathHelper.h.

◆ getNextLog2()

int SbMathHelper::getNextLog2 ( int num )

Return the next log of 2 greater or equal to a.

◆ getNextPow2()

template<typename T>

T SbMathHelper::getNextPow2 ( T a )

inline

Return the next power of 2 greater or equal to a.

Definition at line 83 of file SbMathHelper.h.

◆ isCoinc()

template<typename T>

bool SbMathHelper::isCoinc	(	const T &	x,
		const T &	y,
		T	tol = (T)OIV_DEF_MATH_HELPER_EPS )

inline

Coincidence test using given tolerance.

Definition at line 207 of file SbMathHelper.h.

◆ isCoincRelativeOrAbsolute()

template<typename T>

bool SbMathHelper::isCoincRelativeOrAbsolute	(	const T &	A,
		const T &	B,
		T	maxRelativeError,
		T	maxAbsoluteError )

Relative or absolute error without sign comparison.

Definition at line 278 of file SbMathHelper.h.

◆ isFinite() [1/2]

bool SbMathHelper::isFinite ( double value )

inline

Returns true if the value is a finite value (i.e.

is is normal, subnormal or zero but not infinite or NaN).

Definition at line 166 of file SbMathHelper.h.

◆ isFinite() [2/2]

bool SbMathHelper::isFinite ( float value )

inline

Returns true if the value is a finite value (i.e.

is is normal, subnormal or zero but not infinite or NaN).

Definition at line 178 of file SbMathHelper.h.

◆ isGreaterOrEqualThan()

template<typename T>

bool SbMathHelper::isGreaterOrEqualThan	(	const T &	x,
		const T &	y,
		T	tol = (T)OIV_DEF_MATH_HELPER_EPS )

inline

Greater or equal than test (x >= y) using given tolerance.

Definition at line 249 of file SbMathHelper.h.

◆ isGreaterThan()

template<typename T>

bool SbMathHelper::isGreaterThan	(	const T &	x,
		const T &	y,
		T	tol = (T)OIV_DEF_MATH_HELPER_EPS )

inline

Greater than test (x > y) using given tolerance.

Definition at line 231 of file SbMathHelper.h.

◆ isLessOrEqualThan()

template<typename T>

bool SbMathHelper::isLessOrEqualThan	(	const T &	x,
		const T &	y,
		T	tol = (T)OIV_DEF_MATH_HELPER_EPS )

inline

Less or equal than test (x <= y) using given tolerance.

Definition at line 240 of file SbMathHelper.h.

◆ isLessThan()

template<typename T>

bool SbMathHelper::isLessThan	(	const T &	x,
		const T &	y,
		T	tol = (T)OIV_DEF_MATH_HELPER_EPS )

inline

Less than test (x < y) using given tolerance.

Definition at line 222 of file SbMathHelper.h.

◆ isNaN()

bool SbMathHelper::isNaN ( double a )

inline

Returns true if the specified value is NaN.

Definition at line 152 of file SbMathHelper.h.

◆ Max()

template<typename T>

T SbMathHelper::Max	(	T	a,
		T	b )

inline

Definition at line 52 of file SbMathHelper.h.

◆ Min()

template<typename T>

T SbMathHelper::Min	(	T	a,
		T	b )

inline

Definition at line 53 of file SbMathHelper.h.

◆ nearestLowerMultipleOf()

template<int N, typename T>

T SbMathHelper::nearestLowerMultipleOf ( T v )

inline

Return the nearest lower multiple of some value.

for example nearestLowerMultipleOf<4>(7) return 4. Template because it let compiler to do some optimizations.

Definition at line 107 of file SbMathHelper.h.

◆ nearestUpperMultipleOf()

template<int N, typename T>

T SbMathHelper::nearestUpperMultipleOf ( T v )

inline

Return the nearest upper multiple of some value.

for example nearestUpperMultipleOf<4>(7) return 8. Template because it let compiler to do some optimizations.

Definition at line 95 of file SbMathHelper.h.

◆ rad2Deg()

float SbMathHelper::rad2Deg ( float a )

inline

Convert radians to degrees.

Definition at line 128 of file SbMathHelper.h.

◆ rand()

int SbMathHelper::rand ( )

Returns a pseudo-random integer between 0 and OIV_RAND_MAX.

The returned sequence will be the same on all machines.

◆ rangeMax()

template<typename T>

T SbMathHelper::rangeMax ( )

inline

Returns the maximum finite value representable by the numeric type T.

Definition at line 300 of file SbMathHelper.h.

◆ rangeMin()

template<typename T>

T SbMathHelper::rangeMin ( )

inline

Returns the lowest finite value representable by the numeric type T, that is, a finite value x such that there is no other finite value y where y < x.

Definition at line 304 of file SbMathHelper.h.

◆ rangeMin< double >()

template<>

double SbMathHelper::rangeMin< double > ( )

inline

Definition at line 306 of file SbMathHelper.h.

◆ rangeMin< float >()

template<>

float SbMathHelper::rangeMin< float > ( )

inline

Definition at line 305 of file SbMathHelper.h.

◆ roundToNearestInt()

double SbMathHelper::roundToNearestInt ( double x )

inline

Round the double value to the nearest integer value.

Examples: roundToNearestInt(4.8) returns 5 roundToNearestInt(-7.4) returns -7

This method always round by the lower value when there is 2 nearest integer values. Example: roundToNearestInt(0.5) returns 0 roundToNearestInt(-7.5) returns -8

Definition at line 144 of file SbMathHelper.h.

◆ sgn()

template<typename T>

int SbMathHelper::sgn ( const T & val )

Implements signum return value in { -1, 0, +1 }.

Definition at line 294 of file SbMathHelper.h.

◆ shiftValue() [1/3]

template<>

double SbMathHelper::shiftValue	(	double	v,
		int	offset )

◆ shiftValue() [2/3]

template<>

float SbMathHelper::shiftValue	(	float	v,
		int	offset )

◆ shiftValue() [3/3]

template<typename T>

T SbMathHelper::shiftValue	(	T	v,
		int	offset )

shift the value of offset representable values considering value type.

If T is an integer type (char, short, etc...), it just return v + offset. If T is a float type (float, double, ...) it return the offset'th representable value starting from v. ex: shiftValue(10000.0f, 1) returns 10000.000977...

Definition at line 61 of file SbMathHelper.h.

◆ srand()

void SbMathHelper::srand ( unsigned seed )

Set seed for a new sequence of pseudo-random integers to be returned by rand()

Variable Documentation

◆ OIV_DEF_MATH_HELPER_EPS

const float SbMathHelper::OIV_DEF_MATH_HELPER_EPS = 1.e-6f

static

Default epsilon value for coincidence and interval checking.

Definition at line 43 of file SbMathHelper.h.

◆ OIV_RAND_MAX

const int SbMathHelper::OIV_RAND_MAX = 32767

static

Maximum value returned by SbMathHelper::rand()

Definition at line 39 of file SbMathHelper.h.

Open Inventor Release 2025.1.0

Functions

Variables

Function Documentation

◆ abs() [1/4]

◆ abs() [2/4]

◆ abs() [3/4]

◆ abs() [4/4]

◆ alignToNextPowerOf2()

◆ checkRangeE()

◆ checkRangeI()

◆ Clamp()

◆ deg2Rad()

◆ floatIsEqual()

◆ fract() [1/4]

◆ fract() [2/4]

◆ fract() [3/4]

◆ fract() [4/4]

◆ getNextLog2()

◆ getNextPow2()

◆ isCoinc()

◆ isCoincRelativeOrAbsolute()

◆ isFinite() [1/2]

◆ isFinite() [2/2]

◆ isGreaterOrEqualThan()

◆ isGreaterThan()

◆ isLessOrEqualThan()

◆ isLessThan()

◆ isNaN()

◆ Max()

◆ Min()

◆ nearestLowerMultipleOf()

◆ nearestUpperMultipleOf()

◆ rad2Deg()

◆ rand()

◆ rangeMax()

◆ rangeMin()

◆ rangeMin< double >()

◆ rangeMin< float >()

◆ roundToNearestInt()

◆ sgn()

◆ shiftValue() [1/3]

◆ shiftValue() [2/3]

◆ shiftValue() [3/3]

◆ srand()

Variable Documentation

◆ OIV_DEF_MATH_HELPER_EPS

◆ OIV_RAND_MAX