#include <OgreMathlibC.h>

Static Public Member Functions
static ArrayReal	Abs4 (ArrayReal a)
	Returns the absolute values of each 4 floats. More...

static ArrayReal	ACos4 (ArrayReal x)
	Returns the arccos of x. More...

static ArrayInt	And (ArrayInt a, ArrayInt b)
	Returns the result of "a & b". More...

static ArrayMaskI	And (ArrayInt a, ArrayMaskI b)

static ArrayMaskI	And (ArrayMaskI a, ArrayInt b)

static ArrayMaskI	And (ArrayMaskI a, ArrayMaskI b)

static ArrayInt	AndNot (ArrayInt a, ArrayInt b)
	Returns the result of "a & ~b". More...

static ArrayMaskI	AndNot (ArrayInt a, ArrayMaskI b)

static ArrayMaskI	AndNot (ArrayMaskI a, ArrayInt b)

static ArrayMaskI	AndNot (ArrayMaskI a, ArrayMaskI b)

static ArrayReal	Cmov4 (ArrayReal arg1, ArrayReal arg2, ArrayMaskR mask)
	Branchless conditional move for 4 floating point values. More...

static ArrayInt	CmovRobust (ArrayInt arg1, ArrayInt arg2, ArrayMaskI mask)

static ArrayReal	CmovRobust (ArrayReal arg1, ArrayReal arg2, ArrayMaskR mask)
	Robust, branchless conditional move for a 128-bit value. More...

static Real	ColapseMax (ArrayReal a)
	Returns the maximum value of all elements in a. More...

static Real	ColapseMin (ArrayReal a)
	Returns the minimum value of all elements in a. More...

static ArrayMaskR	CompareGreater (ArrayReal a, ArrayReal b)
	Returns the result of "a > b". More...

static ArrayMaskR	CompareGreaterEqual (ArrayReal a, ArrayReal b)
	Returns the result of "a >= b". More...

static ArrayMaskR	CompareLess (ArrayReal a, ArrayReal b)
	Returns the result of "a < b". More...

static ArrayMaskR	CompareLessEqual (ArrayReal a, ArrayReal b)
	Returns the result of "a <= b". More...

static ArrayReal	ConvertToF32 (ArrayInt a)
	Converts 32-bit integer to float. More...

static ArrayReal	Cos4 (ArrayReal x)
	Returns the cosine of x. More...

static void	extractS16 (ArrayToS16 a, int16 outValues[ARRAY_PACKED_REALS])
	Extracts ARRAY_PACKED_REALS int16. More...

static void	extractS8 (ArrayToS8 a, int8 outValues[ARRAY_PACKED_REALS])
	Extracts ARRAY_PACKED_REALS int8. More...

static Real	Get0 (ArrayReal src)
	Returns the first entry in src. More...

static ArrayReal	Inv4 (ArrayReal val)
	Returns the reciprocal of x. More...

static ArrayReal	InvNonZero4 (ArrayReal val)
	Returns the reciprocal of x. More...

static ArrayReal	InvSqrt4 (ArrayReal f)
	Returns the squared root of the reciprocal of x. More...

static ArrayReal	InvSqrtNonZero4 (ArrayReal f)
	Returns the squared root of the reciprocal of x. More...

static ArrayMaskR	isInfinity (ArrayReal a)
	Returns the result of "a == std::numeric_limits<float>::infinity()". More...

static ArrayReal	Max (ArrayReal a, ArrayReal b)
	Returns the maximum value between a and b. More...

static ArrayReal	Min (ArrayReal a, ArrayReal b)
	Returns the minimum value between a and b. More...

static ArrayReal	Modf4 (ArrayReal x, ArrayReal &outIntegral)
	Break x into fractional and integral parts. More...

static ArrayInt	Or (ArrayInt a, ArrayInt b)
	Returns the result of "a \| b". More...

static ArrayMaskI	Or (ArrayInt a, ArrayMaskI b)

static ArrayMaskI	Or (ArrayMaskI a, ArrayInt b)

static ArrayMaskI	Or (ArrayMaskI a, ArrayMaskI b)

static ArrayReal	Saturate (ArrayReal a)
	Clamps the value to the range [0; 1]. More...

static void	Set (ArrayReal &dst, Real val, size_t index)

static ArrayReal	SetAll (Real val)

static ArrayInt	SetAll (uint32 val)

static ArrayReal	Sin4 (ArrayReal x)
	Returns the sine of x. More...

static void	SinCos4 (ArrayReal x, ArrayReal &outSin, ArrayReal &outCos)
	Calculates the cosine & sine of x. More...

static ArrayMaskI	TestFlags4 (ArrayInt a, ArrayInt b)
	Test if "a AND b" will result in non-zero, returning 0xffffffff on those cases. More...

static ArrayMaskI	TestFlags4 (ArrayInt a, ArrayMaskI b)

static ArrayMaskI	TestFlags4 (ArrayMaskI a, ArrayInt b)

static ArrayToS16	ToSnorm16 (ArrayReal a)
	Returns: (int16)( saturate( a ) * 32767.5f );. More...

static ArrayToS8	ToSnorm8Unsafe (ArrayReal a)
	Returns: (int16)( saturate( a ) * 127.5f );. More...

static ArrayInt	Truncate (ArrayReal a)
	Truncates float to 32-bit integer. More...

Static Public Attributes
static const ArrayReal	fDeg2Rad

static const ArrayReal	fEpsilon

static const ArrayReal	FLOAT_MIN

static const ArrayReal	fRad2Deg

static const ArrayReal	fSqEpsilon

static const ArrayReal	HALF

static const ArrayReal	INFINITEA

static const ArrayReal	MAX_NEG

static const ArrayReal	MAX_POS

static const ArrayReal	NEG_ONE

static const ArrayReal	ONE

static const ArrayReal	ONE_DIV_2PI

static const ArrayReal	OneMinusEpsilon

static const ArrayReal	PI

static const ArrayReal	SIGN_MASK

static const ArrayReal	THREE

static const ArrayReal	TWO_PI

Member Function Documentation

◆ Abs4()

static ArrayReal Ogre::MathlibC::Abs4 ( ArrayReal a )

inlinestatic

Returns the absolute values of each 4 floats.

Parameters

a	4 floating point values

Returns: abs( a )

References Ogre::Math::Abs().

◆ ACos4()

static ArrayReal Ogre::MathlibC::ACos4 ( ArrayReal x )

inlinestatic

Returns the arccos of x.

Parameters

x	4 floating point values

Returns: arccos( x ) (packed as 4 floats)

◆ And() [1/4]

static ArrayInt Ogre::MathlibC::And	(	ArrayInt	a,
		ArrayInt	b
	)

inlinestatic

Returns the result of "a & b".

Returns: r[i] = a[i] & b[i];

◆ And() [2/4]

static ArrayMaskI Ogre::MathlibC::And	(	ArrayInt	a,
		ArrayMaskI	b
	)

inlinestatic

◆ And() [3/4]

static ArrayMaskI Ogre::MathlibC::And	(	ArrayMaskI	a,
		ArrayInt	b
	)

inlinestatic

◆ And() [4/4]

static ArrayMaskI Ogre::MathlibC::And	(	ArrayMaskI	a,
		ArrayMaskI	b
	)

inlinestatic

◆ AndNot() [1/4]

static ArrayInt Ogre::MathlibC::AndNot	(	ArrayInt	a,
		ArrayInt	b
	)

inlinestatic

Returns the result of "a & ~b".

Returns: r[i] = a[i] & ~b[i];

◆ AndNot() [2/4]

static ArrayMaskI Ogre::MathlibC::AndNot	(	ArrayInt	a,
		ArrayMaskI	b
	)

inlinestatic

◆ AndNot() [3/4]

static ArrayMaskI Ogre::MathlibC::AndNot	(	ArrayMaskI	a,
		ArrayInt	b
	)

inlinestatic

◆ AndNot() [4/4]

static ArrayMaskI Ogre::MathlibC::AndNot	(	ArrayMaskI	a,
		ArrayMaskI	b
	)

inlinestatic

◆ Cmov4()

static ArrayReal Ogre::MathlibC::Cmov4	(	ArrayReal	arg1,
		ArrayReal	arg2,
		ArrayMaskR	mask
	)

inlinestatic

Branchless conditional move for 4 floating point values.

Remarks: Will NOT work if any of the arguments contains Infinite or NaNs or non-floating point values. If an exact binary copy is needed,

See also: CmovRobust

Parameters

arg1	4 floating point values. Can't be NaN or Inf
arg2	4 floating point values. Can't be NaN or Inf
mask	4 values containing either 0 or 0xffffffff Any other value, the result is undefined

Returns: r[i] = mask[i] != 0 ? arg1[i] : arg2[i] Another way to say it: if( maskCondition[i] == true ) r[i] = arg1[i]; else arg2[i];

References Ogre::Math::isNaN().

◆ CmovRobust() [1/2]

static ArrayInt Ogre::MathlibC::CmovRobust	(	ArrayInt	arg1,
		ArrayInt	arg2,
		ArrayMaskI	mask
	)

inlinestatic

◆ CmovRobust() [2/2]

static ArrayReal Ogre::MathlibC::CmovRobust	(	ArrayReal	arg1,
		ArrayReal	arg2,
		ArrayMaskR	mask
	)

inlinestatic

Robust, branchless conditional move for a 128-bit value.

Remarks: If you're looking to copy 4 floating point values that do not contain Inf or Nans,

See also: Cmov4 which is faster. This is because switching between registers flagged as floating point to integer and back has a latency delay

For more information refer to Chapter 3.5.2.3 Bypass between Execution Domains, Intel® 64 and IA-32 Architectures Optimization Reference Manual Order Number: 248966-026 April (and also Table 2-12)

Parameters

arg1	A value containing 128 bits
arg2	A value containing 128 bits
mask	Mask, each bit is evaluated

Returns: For each bit: r[i] = mask[i] != 0 ? arg1[i] : arg2[i] Another way to say it: if( maskCondition[i] == true ) r[i] = arg1[i]; else arg2[i];

◆ ColapseMax()

static Real Ogre::MathlibC::ColapseMax ( ArrayReal a )

inlinestatic

Returns the maximum value of all elements in a.

Returns: r[0] = max( a[0], a[1], a[2], a[3] )

◆ ColapseMin()

static Real Ogre::MathlibC::ColapseMin ( ArrayReal a )

inlinestatic

Returns the minimum value of all elements in a.

Returns: r[0] = min( a[0], a[1], a[2], a[3] )

◆ CompareGreater()

static ArrayMaskR Ogre::MathlibC::CompareGreater	(	ArrayReal	a,
		ArrayReal	b
	)

inlinestatic

Returns the result of "a > b".

Returns: r[i] = a[i] > b[i] ? 0xffffffff : 0;

◆ CompareGreaterEqual()

static ArrayMaskR Ogre::MathlibC::CompareGreaterEqual	(	ArrayReal	a,
		ArrayReal	b
	)

inlinestatic

Returns the result of "a >= b".

Returns: r[i] = a[i] >= b[i] ? 0xffffffff : 0;

Referenced by Ogre::ArrayRay::intersects().

◆ CompareLess()

static ArrayMaskR Ogre::MathlibC::CompareLess	(	ArrayReal	a,
		ArrayReal	b
	)

inlinestatic

Returns the result of "a < b".

Returns: r[i] = a[i] < b[i] ? 0xffffffff : 0;

◆ CompareLessEqual()

static ArrayMaskR Ogre::MathlibC::CompareLessEqual	(	ArrayReal	a,
		ArrayReal	b
	)

inlinestatic

Returns the result of "a <= b".

Returns: r[i] = a[i] <= b[i] ? 0xffffffff : 0;

◆ ConvertToF32()

static ArrayReal Ogre::MathlibC::ConvertToF32 ( ArrayInt a )

inlinestatic

Converts 32-bit integer to float.

◆ Cos4()

static ArrayReal Ogre::MathlibC::Cos4 ( ArrayReal x )

inlinestatic

Returns the cosine of x.

Parameters

x	4 floating point values

Returns: cos( x ) (packed as 4 floats)

◆ extractS16()

static void Ogre::MathlibC::extractS16	(	ArrayToS16	a,
		int16	outValues[ARRAY_PACKED_REALS]
	)

inlinestatic

Extracts ARRAY_PACKED_REALS int16.

Parameters

a	a must contain integers. Not floats.
outValues	[out] outValues[0] = (int16)a[0]; outValues[1] = (int16)a[1]; outValues[2] = (int16)a[2]; outValues[3] = (int16)a[3];

◆ extractS8()

static void Ogre::MathlibC::extractS8	(	ArrayToS8	a,
		int8	outValues[ARRAY_PACKED_REALS]
	)

inlinestatic

Extracts ARRAY_PACKED_REALS int8.

Parameters

a	a must contain integers. Not floats.
outValues	[out] outValues[0] = (int8)a[0]; outValues[1] = (int8)a[1]; outValues[2] = (int8)a[2]; outValues[3] = (int8)a[3];

◆ Get0()

static Real Ogre::MathlibC::Get0 ( ArrayReal src )

inlinestatic

Returns the first entry in src.

Returns: src[0]

◆ Inv4()

static ArrayReal Ogre::MathlibC::Inv4 ( ArrayReal val )

inlinestatic

Returns the reciprocal of x.

Remarks: If you have a very rough guarantees that you won't be feeding a zero, consider using

See also: InvNonZero4 because it's faster. See MathlibSSE2 implementation

Returns: 1 / x (packed as 4 floats)

◆ InvNonZero4()

static ArrayReal Ogre::MathlibC::InvNonZero4 ( ArrayReal val )

inlinestatic

Returns the reciprocal of x.

Remarks: If the input is zero, it will produce a NaN!!! (but it's faster) Note: Some architectures may slowdown when a NaN is produced, making this function slower than Inv4 for those cases

See also: Inv4

Parameters

val	If it's zero, the returned value could be NaN depending on implementation

Returns: 1 / x

◆ InvSqrt4()

static ArrayReal Ogre::MathlibC::InvSqrt4 ( ArrayReal f )

inlinestatic

Returns the squared root of the reciprocal of x.

Returns: 1 / sqrt( x )

◆ InvSqrtNonZero4()

static ArrayReal Ogre::MathlibC::InvSqrtNonZero4 ( ArrayReal f )

inlinestatic

Returns the squared root of the reciprocal of x.

Returns: 1 / sqrt( x ) (packed as 4 floats)

◆ isInfinity()

static ArrayMaskR Ogre::MathlibC::isInfinity ( ArrayReal a )

inlinestatic

Returns the result of "a == std::numeric_limits<float>::infinity()".

Returns: r[i] = a[i] == Inf ? 0xffffffff : 0;

◆ Max()

static ArrayReal Ogre::MathlibC::Max	(	ArrayReal	a,
		ArrayReal	b
	)

inlinestatic

Returns the maximum value between a and b.

Referenced by Ogre::ArrayRay::intersects().

◆ Min()

static ArrayReal Ogre::MathlibC::Min	(	ArrayReal	a,
		ArrayReal	b
	)

inlinestatic

Returns the minimum value between a and b.

Referenced by Ogre::ArrayRay::intersects().

◆ Modf4()

static ArrayReal Ogre::MathlibC::Modf4	(	ArrayReal	x,
		ArrayReal &	outIntegral
	)

inlinestatic

Break x into fractional and integral parts.

Parameters

x	4 floating point values. i.e. "2.57" (x4)
outIntegral	The integral part of x. i.e. 2

Returns: The fractional part of x. i.e. 0.57

◆ Or() [1/4]

static ArrayInt Ogre::MathlibC::Or	(	ArrayInt	a,
		ArrayInt	b
	)

inlinestatic

Returns the result of "a | b".

Returns: r[i] = a[i] | b[i];

◆ Or() [2/4]

static ArrayMaskI Ogre::MathlibC::Or	(	ArrayInt	a,
		ArrayMaskI	b
	)

inlinestatic

◆ Or() [3/4]

static ArrayMaskI Ogre::MathlibC::Or	(	ArrayMaskI	a,
		ArrayInt	b
	)

inlinestatic

◆ Or() [4/4]

static ArrayMaskI Ogre::MathlibC::Or	(	ArrayMaskI	a,
		ArrayMaskI	b
	)

inlinestatic

◆ Saturate()

static ArrayReal Ogre::MathlibC::Saturate ( ArrayReal a )

inlinestatic

Clamps the value to the range [0; 1].

◆ Set()

static void Ogre::MathlibC::Set	(	ArrayReal &	dst,
		Real	val,
		size_t	index
	)

inlinestatic

◆ SetAll() [1/2]

static ArrayReal Ogre::MathlibC::SetAll ( Real val )

inlinestatic

Referenced by Ogre::ArrayRay::intersects().

◆ SetAll() [2/2]

static ArrayInt Ogre::MathlibC::SetAll ( uint32 val )

inlinestatic

◆ Sin4()

static ArrayReal Ogre::MathlibC::Sin4 ( ArrayReal x )

inlinestatic

Returns the sine of x.

Parameters

x	4 floating point values

Returns: sin( x ) (packed as 4 floats)

◆ SinCos4()

static void Ogre::MathlibC::SinCos4	(	ArrayReal	x,
		ArrayReal &	outSin,
		ArrayReal &	outCos
	)

static

Calculates the cosine & sine of x.

Use this function if you need to calculate both, as it is faster than calling Cos4 & Sin4 together.

Parameters

x	4 floating point values
outSin	Output value, sin( x ) (packed as 4 floats)
outCos	Output value, cos( x ) (packed as 4 floats)

◆ TestFlags4() [1/3]

static ArrayMaskI Ogre::MathlibC::TestFlags4	(	ArrayInt	a,
		ArrayInt	b
	)

inlinestatic

Test if "a AND b" will result in non-zero, returning 0xffffffff on those cases.

Returns: r[i] = (a[i] & b[i]) ? 0xffffffff : 0;

◆ TestFlags4() [2/3]

static ArrayMaskI Ogre::MathlibC::TestFlags4	(	ArrayInt	a,
		ArrayMaskI	b
	)

inlinestatic

◆ TestFlags4() [3/3]

static ArrayMaskI Ogre::MathlibC::TestFlags4	(	ArrayMaskI	a,
		ArrayInt	b
	)

inlinestatic

◆ ToSnorm16()

static ArrayToS16 Ogre::MathlibC::ToSnorm16 ( ArrayReal a )

inlinestatic

Returns: (int16)( saturate( a ) * 32767.5f );.

◆ ToSnorm8Unsafe()

static ArrayToS8 Ogre::MathlibC::ToSnorm8Unsafe ( ArrayReal a )

inlinestatic

Returns: (int16)( saturate( a ) * 127.5f );.

Input a MUST be in range (-256.996; 256.996) for saturation to properly work (in other implementations, C version doesn't have this flaw). Otherwise result will be wrong.

◆ Truncate()

static ArrayInt Ogre::MathlibC::Truncate ( ArrayReal a )

inlinestatic

Truncates float to 32-bit integer.

Member Data Documentation

◆ fDeg2Rad

const ArrayReal Ogre::MathlibC::fDeg2Rad

static

◆ fEpsilon

const ArrayReal Ogre::MathlibC::fEpsilon

static

◆ FLOAT_MIN

const ArrayReal Ogre::MathlibC::FLOAT_MIN

static

◆ fRad2Deg

const ArrayReal Ogre::MathlibC::fRad2Deg

static

◆ fSqEpsilon

const ArrayReal Ogre::MathlibC::fSqEpsilon

static

◆ HALF

const ArrayReal Ogre::MathlibC::HALF

static

◆ INFINITEA

const ArrayReal Ogre::MathlibC::INFINITEA

static

◆ MAX_NEG

const ArrayReal Ogre::MathlibC::MAX_NEG

static

◆ MAX_POS

const ArrayReal Ogre::MathlibC::MAX_POS

static

◆ NEG_ONE

const ArrayReal Ogre::MathlibC::NEG_ONE

static

◆ ONE

const ArrayReal Ogre::MathlibC::ONE

static

◆ ONE_DIV_2PI

const ArrayReal Ogre::MathlibC::ONE_DIV_2PI

static

◆ OneMinusEpsilon

const ArrayReal Ogre::MathlibC::OneMinusEpsilon

static

◆ PI

const ArrayReal Ogre::MathlibC::PI

static

◆ SIGN_MASK

const ArrayReal Ogre::MathlibC::SIGN_MASK

static

◆ THREE

const ArrayReal Ogre::MathlibC::THREE

static

◆ TWO_PI

const ArrayReal Ogre::MathlibC::TWO_PI

static

The documentation for this class was generated from the following file:

OgreMathlibC.h

Static Public Member Functions

Static Public Attributes

Member Function Documentation

◆ Abs4()

◆ ACos4()

◆ And() [1/4]

◆ And() [2/4]

◆ And() [3/4]

◆ And() [4/4]

◆ AndNot() [1/4]

◆ AndNot() [2/4]

◆ AndNot() [3/4]

◆ AndNot() [4/4]

◆ Cmov4()

◆ CmovRobust() [1/2]

◆ CmovRobust() [2/2]

◆ ColapseMax()

◆ ColapseMin()

◆ CompareGreater()

◆ CompareGreaterEqual()

◆ CompareLess()

◆ CompareLessEqual()

◆ ConvertToF32()

◆ Cos4()

◆ extractS16()

◆ extractS8()

◆ Get0()

◆ Inv4()

◆ InvNonZero4()

◆ InvSqrt4()

◆ InvSqrtNonZero4()

◆ isInfinity()

◆ Max()

◆ Min()

◆ Modf4()

◆ Or() [1/4]

◆ Or() [2/4]

◆ Or() [3/4]

◆ Or() [4/4]

◆ Saturate()

◆ Set()

◆ SetAll() [1/2]

◆ SetAll() [2/2]

◆ Sin4()

◆ SinCos4()

◆ TestFlags4() [1/3]

◆ TestFlags4() [2/3]

◆ TestFlags4() [3/3]

◆ ToSnorm16()

◆ ToSnorm8Unsafe()

◆ Truncate()

Member Data Documentation

◆ fDeg2Rad

◆ fEpsilon

◆ FLOAT_MIN

◆ fRad2Deg

◆ fSqEpsilon

◆ HALF

◆ INFINITEA

◆ MAX_NEG

◆ MAX_POS

◆ NEG_ONE

◆ ONE

◆ ONE_DIV_2PI

◆ OneMinusEpsilon

◆ PI

◆ SIGN_MASK

◆ THREE

◆ TWO_PI