A class representing a 8-component 16-bit signed-integer SIMD scalar. More...

#include <omSIMDScalarInt16_8.h>

Public Member Functions
	SIMDScalar ()
	Define the type for a 4x float scalar structure. More...

	SIMDScalar (Int16 value)
	Create a new 4D SIMD scalar with all elements equal to the specified value. More...

	SIMDScalar (Int16 newA, Int16 newB, Int16 newC, Int16 newD, Int16 newE, Int16 newF, Int16 newG, Int16 newH)
	Create a new 4D SIMD scalar with the elements equal to the specified 4 values. More...

	SIMDScalar (const Int16 *array)
	Create a new 4D SIMD scalar from the first 4 values stored at specified pointer's location. More...

	SIMDScalar (const SIMDScalar &other)
	Create a new SIMD scalar with the same contents as another. More...

SIMDScalar &	operator= (const SIMDScalar &other)
	Assign the contents of one SIMDScalar object to another. More...

void	store (Int16 *destination) const
	Store the contents of this SIMD scalar into the specified aligned destination pointer. More...

void	storeUnaligned (Int16 *destination) const
	Store the contents of this SIMD scalar into the specified unaligned destination pointer. More...

Int16 &	operator[] (Index i)
	Return a reference to the value stored at the specified component index in this scalar. More...

Int16	operator[] (Index i) const
	Return the value stored at the specified component index in this scalar. More...

const Int16 *	toArray () const
	Return a pointer to the first element in this scalar. More...

SIMDScalar	operator~ () const
	Return the bitwise NOT of this 4D SIMD vector. More...

SIMDScalar	operator& (const SIMDScalar &vector) const
	Compute the bitwise AND of this 4D SIMD vector with another and return the result. More...

SIMDScalar	operator\| (const SIMDScalar &vector) const
	Compute the bitwise OR of this 4D SIMD vector with another and return the result. More...

SIMDScalar	operator^ (const SIMDScalar &vector) const
	Compute the bitwise XOR of this 4D SIMD vector with another and return the result. More...

SIMDScalar &	operator&= (const SIMDScalar &vector)
	Compute the logical AND of this 4D SIMD vector with another and assign it to this vector. More...

SIMDScalar &	operator\|= (const SIMDScalar &vector)
	Compute the logical OR of this 4D SIMD vector with another and assign it to this vector. More...

SIMDScalar &	operator^= (const SIMDScalar &vector)
	Compute the bitwise XOR of this 4D SIMD vector with another and assign it to this vector. More...

SIMDScalar	operator== (const SIMDScalar &scalar) const
	Compare two 4D SIMD scalars component-wise for equality. More...

SIMDScalar	operator== (const Int16 value) const
	Compare this scalar to a single floating point value for equality. More...

SIMDScalar	operator!= (const SIMDScalar &scalar) const
	Compare two 4D SIMD scalars component-wise for inequality. More...

SIMDScalar	operator!= (const Int16 value) const
	Compare this scalar to a single floating point value for inequality. More...

SIMDScalar	operator< (const SIMDScalar &scalar) const
	Perform a component-wise less-than comparison between this an another 4D SIMD scalar. More...

SIMDScalar	operator< (const Int16 value) const
	Perform a component-wise less-than comparison between this 4D SIMD scalar and an expanded scalar. More...

SIMDScalar	operator> (const SIMDScalar &scalar) const
	Perform a component-wise greater-than comparison between this an another 4D SIMD scalar. More...

SIMDScalar	operator> (const Int16 value) const
	Perform a component-wise greater-than comparison between this 4D SIMD scalar and an expanded scalar. More...

SIMDScalar	operator<= (const SIMDScalar &scalar) const
	Perform a component-wise less-than-or-equal-to comparison between this an another 4D SIMD scalar. More...

SIMDScalar	operator<= (const Int16 value) const
	Perform a component-wise less-than-or-equal-to comparison between this 4D SIMD scalar and an expanded scalar. More...

SIMDScalar	operator>= (const SIMDScalar &scalar) const
	Perform a component-wise greater-than-or-equal-to comparison between this an another 4D SIMD scalar. More...

SIMDScalar	operator>= (const Int16 value) const
	Perform a component-wise greater-than-or-equal-to comparison between this 4D SIMD scalar and an expanded scalar. More...

SIMDScalar	operator<< (Int16 bitShift) const
	Shift each component of the SIMD scalar to the left by the specified amount of bits. More...

SIMDScalar	operator>> (Int16 bitShift) const
	Shift each component of the SIMD scalar to the right by the specified amount of bits. More...

SIMDScalar	operator- () const
	Negate a scalar. More...

SIMDScalar	operator+ (const SIMDScalar &scalar) const
	Add this scalar to another and return the result. More...

SIMDScalar	operator+ (const Int16 value) const
	Add a value to every component of this scalar. More...

SIMDScalar	operator- (const SIMDScalar &scalar) const
	Subtract a scalar from this scalar component-wise and return the result. More...

SIMDScalar	operator- (const Int16 value) const
	Subtract a value from every component of this scalar. More...

SIMDScalar	operator* (const SIMDScalar &scalar) const
	Multiply component-wise this scalar and another scalar. More...

SIMDScalar	operator* (const Int16 value) const
	Multiply every component of this scalar by a value and return the result. More...

SIMDScalar	operator/ (const SIMDScalar &scalar) const
	Divide this scalar by another scalar component-wise. More...

SIMDScalar	operator/ (const Int16 value) const
	Divide every component of this scalar by a value and return the result. More...

SIMDScalar &	operator+= (const SIMDScalar &scalar)
	Add a scalar to this scalar, modifying this original scalar. More...

SIMDScalar &	operator-= (const SIMDScalar &scalar)
	Subtract a scalar from this scalar, modifying this original scalar. More...

SIMDScalar &	operator*= (const SIMDScalar &scalar)
	Multiply component-wise this scalar and another scalar and modify this scalar. More...

SIMDScalar &	operator/= (const SIMDScalar &scalar)
	Divide this scalar by another scalar component-wise and modify this scalar. More...

data::String	toString () const
	Convert this SIMD scalar into a human-readable string representation. More...

	operator data::String () const
	Convert this SIMD scalar into a human-readable string representation. More...

Static Public Member Functions
static SIMDScalar	load (const Int16 *array)

static SIMDScalar	loadUnaligned (const Int16 *array)

static Size	getAlignment ()
	Return the alignment required for objects of this type. More...

static Size	getWidth ()
	Get the width of this scalar (number of components it has). More...

static Bool	isSupported ()
	Return whether or not this SIMD type is supported by the current CPU. More...

Friends
SIMDScalar	abs (const SIMDScalar &scalar)

SIMDScalar	sqrt (const SIMDScalar &scalar)

SIMDScalar	min (const SIMDScalar &scalar1, const SIMDScalar &scalar2)

SIMDScalar	max (const SIMDScalar &scalar1, const SIMDScalar &scalar2)

template<UInt i1, UInt i2, UInt i3, UInt i4>
SIMDScalar	shuffle (const SIMDScalar &scalar1)

template<UInt i1, UInt i2, UInt i3, UInt i4>
SIMDScalar	shuffle (const SIMDScalar &scalar1, const SIMDScalar &scalar2)

SIMDScalar	select (const SIMDScalar &selector, const SIMDScalar &scalar1, const SIMDScalar &scalar2)

SIMDScalar	lows (const SIMDScalar &scalar)

SIMDScalar	highs (const SIMDScalar &scalar)

Detailed Description

template<>
class om::math::SIMDScalar< Int16, 8 >

A class representing a 8-component 16-bit signed-integer SIMD scalar.

This specialization of the SIMDScalar class uses a 128-bit value to encode 8 16-bit signed-integer values. All basic arithmetic operations are supported, plus a subset of standard scalar operations: abs(), min(), max(), sqrt().

Constructor & Destructor Documentation

om::math::SIMDScalar< Int16, 8 >::SIMDScalar ( )

inline

Define the type for a 4x float scalar structure.

Create a new 4D SIMD scalar with all elements left uninitialized.

om::math::SIMDScalar< Int16, 8 >::SIMDScalar ( Int16 value )

inline

Create a new 4D SIMD scalar with all elements equal to the specified value.

om::math::SIMDScalar< Int16, 8 >::SIMDScalar	(	Int16	newA,
		Int16	newB,
		Int16	newC,
		Int16	newD,
		Int16	newE,
		Int16	newF,
		Int16	newG,
		Int16	newH
	)

inline

Create a new 4D SIMD scalar with the elements equal to the specified 4 values.

om::math::SIMDScalar< Int16, 8 >::SIMDScalar ( const Int16 * array )

inline

Create a new 4D SIMD scalar from the first 4 values stored at specified pointer's location.

om::math::SIMDScalar< Int16, 8 >::SIMDScalar ( const SIMDScalar< Int16, 8 > & other )

inline

Create a new SIMD scalar with the same contents as another.

This shouldn't have to be overloaded, but for some reason the compiler (GCC) optimizes SIMD code better with it overloaded. Before, the compiler would store the result of a SIMD operation on the stack before transfering it to the destination, resulting in an extra 8+ load/stores per computation.

Member Function Documentation

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator= ( const SIMDScalar< Int16, 8 > & other )

inline

Assign the contents of one SIMDScalar object to another.

This shouldn't have to be overloaded, but for some reason the compiler (GCC) optimizes SIMD code better with it overloaded. Before, the compiler would store the result of a SIMD operation on the stack before transfering it to the destination, resulting in an extra 8+ load/stores per computation.

static SIMDScalar om::math::SIMDScalar< Int16, 8 >::load ( const Int16 * array )

inlinestatic

static SIMDScalar om::math::SIMDScalar< Int16, 8 >::loadUnaligned ( const Int16 * array )

inlinestatic

void om::math::SIMDScalar< Int16, 8 >::store ( Int16 * destination ) const

inline

Store the contents of this SIMD scalar into the specified aligned destination pointer.

void om::math::SIMDScalar< Int16, 8 >::storeUnaligned ( Int16 * destination ) const

inline

Store the contents of this SIMD scalar into the specified unaligned destination pointer.

Int16& om::math::SIMDScalar< Int16, 8 >::operator[] ( Index i )

inline

Return a reference to the value stored at the specified component index in this scalar.

Int16 om::math::SIMDScalar< Int16, 8 >::operator[] ( Index i ) const

inline

Return the value stored at the specified component index in this scalar.

const Int16* om::math::SIMDScalar< Int16, 8 >::toArray ( ) const

inline

Return a pointer to the first element in this scalar.

The remaining values are in the next 7 locations after the first element.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator~ ( ) const

inline

Return the bitwise NOT of this 4D SIMD vector.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator& ( const SIMDScalar< Int16, 8 > & vector ) const

inline

Compute the bitwise AND of this 4D SIMD vector with another and return the result.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator| ( const SIMDScalar< Int16, 8 > & vector ) const

inline

Compute the bitwise OR of this 4D SIMD vector with another and return the result.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator^ ( const SIMDScalar< Int16, 8 > & vector ) const

inline

Compute the bitwise XOR of this 4D SIMD vector with another and return the result.

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator&= ( const SIMDScalar< Int16, 8 > & vector )

inline

Compute the logical AND of this 4D SIMD vector with another and assign it to this vector.

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator|= ( const SIMDScalar< Int16, 8 > & vector )

inline

Compute the logical OR of this 4D SIMD vector with another and assign it to this vector.

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator^= ( const SIMDScalar< Int16, 8 > & vector )

inline

Compute the bitwise XOR of this 4D SIMD vector with another and assign it to this vector.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator== ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Compare two 4D SIMD scalars component-wise for equality.

Return a 4D scalar of booleans indicating the result of the comparison. If each corresponding pair of components is equal, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator== ( const Int16 value ) const

inline

Compare this scalar to a single floating point value for equality.

Return a 4D scalar of booleans indicating the result of the comparison. The float value is expanded to a 4-wide SIMD scalar and compared with this scalar. If each corresponding pair of components is equal, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator!= ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Compare two 4D SIMD scalars component-wise for inequality.

Return a 4D scalar of booleans indicating the result of the comparison. If each corresponding pair of components is not equal, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator!= ( const Int16 value ) const

inline

Compare this scalar to a single floating point value for inequality.

Return a 4D scalar of booleans indicating the result of the comparison. The float value is expanded to a 4-wide SIMD scalar and compared with this scalar. If each corresponding pair of components is not equal, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator< ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Perform a component-wise less-than comparison between this an another 4D SIMD scalar.

Return a 4D scalar of booleans indicating the result of the comparison. If each corresponding pair of components has this scalar's component less than the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator< ( const Int16 value ) const

inline

Perform a component-wise less-than comparison between this 4D SIMD scalar and an expanded scalar.

Return a 4D scalar of booleans indicating the result of the comparison. The float value is expanded to a 4-wide SIMD scalar and compared with this scalar. If each corresponding pair of components has this scalar's component less than the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator> ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Perform a component-wise greater-than comparison between this an another 4D SIMD scalar.

Return a 4D scalar of booleans indicating the result of the comparison. If each corresponding pair of components has this scalar's component greater than the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator> ( const Int16 value ) const

inline

Perform a component-wise greater-than comparison between this 4D SIMD scalar and an expanded scalar.

Return a 4D scalar of booleans indicating the result of the comparison. The float value is expanded to a 4-wide SIMD scalar and compared with this scalar. If each corresponding pair of components has this scalar's component greater than the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator<= ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Perform a component-wise less-than-or-equal-to comparison between this an another 4D SIMD scalar.

Return a 4D scalar of booleans indicating the result of the comparison. If each corresponding pair of components has this scalar's component less than or equal to the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator<= ( const Int16 value ) const

inline

Perform a component-wise less-than-or-equal-to comparison between this 4D SIMD scalar and an expanded scalar.

Return a 4D scalar of booleans indicating the result of the comparison. The float value is expanded to a 4-wide SIMD scalar and compared with this scalar. If each corresponding pair of components has this scalar's component less than or equal to the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator>= ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Perform a component-wise greater-than-or-equal-to comparison between this an another 4D SIMD scalar.

Return a 4D scalar of booleans indicating the result of the comparison. If each corresponding pair of components has this scalar's component greater than or equal to the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator>= ( const Int16 value ) const

inline

Perform a component-wise greater-than-or-equal-to comparison between this 4D SIMD scalar and an expanded scalar.

Return a 4D scalar of booleans indicating the result of the comparison. The float value is expanded to a 4-wide SIMD scalar and compared with this scalar. If each corresponding pair of components has this scalar's component greater than or equal to the other scalar's component, the corresponding result component is non-zero. Otherwise, that result component is equal to zero.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator<< ( Int16 bitShift ) const

inline

Shift each component of the SIMD scalar to the left by the specified amount of bits.

This method shifts the contents of each component to the left by the specified amount of bits and inserts zeros.

Parameters

bitShift - the number of bits to shift this SIMD scalar by.

Returns: the shifted SIMD scalar.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator>> ( Int16 bitShift ) const

inline

Shift each component of the SIMD scalar to the right by the specified amount of bits.

This method shifts the contents of each component to the right by the specified amount of bits and sign extends the original values..

Parameters

bitShift - the number of bits to shift this SIMD scalar by.

Returns: the shifted SIMD scalar.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator- ( ) const

inline

Negate a scalar.

This method negates every component of this 4D SIMD scalar and returns the result, leaving this scalar unmodified.

Returns: the negation of the original scalar.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator+ ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Add this scalar to another and return the result.

This method adds another scalar to this one, component-wise, and returns this addition. It does not modify either of the original scalars.

Parameters

scalar - The scalar to add to this one.

Returns: The addition of this scalar and the parameter.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator+ ( const Int16 value ) const

inline

Add a value to every component of this scalar.

This method adds the value parameter to every component of the scalar, and returns a scalar representing this result. It does not modifiy the original scalar.

Parameters

value - The value to add to all components of this scalar.

Returns: The resulting scalar of this addition.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator- ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Subtract a scalar from this scalar component-wise and return the result.

This method subtracts another scalar from this one, component-wise, and returns this subtraction. It does not modify either of the original scalars.

Parameters

scalar - The scalar to subtract from this one.

Returns: The subtraction of the the parameter from this scalar.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator- ( const Int16 value ) const

inline

Subtract a value from every component of this scalar.

This method subtracts the value parameter from every component of the scalar, and returns a scalar representing this result. It does not modifiy the original scalar.

Parameters

value - The value to subtract from all components of this scalar.

Returns: The resulting scalar of this subtraction.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator* ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Multiply component-wise this scalar and another scalar.

This operator multiplies each component of this scalar by the corresponding component of the other scalar and returns a scalar representing this result. It does not modify either original scalar.

Parameters

scalar - The scalar to multiply this scalar by.

Returns: The result of the multiplication.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator* ( const Int16 value ) const

inline

Multiply every component of this scalar by a value and return the result.

This method multiplies the value parameter with every component of the scalar, and returns a scalar representing this result. It does not modifiy the original scalar.

Parameters

value - The value to multiplly with all components of this scalar.

Returns: The resulting scalar of this multiplication.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator/ ( const SIMDScalar< Int16, 8 > & scalar ) const

inline

Divide this scalar by another scalar component-wise.

This operator divides each component of this scalar by the corresponding component of the other scalar and returns a scalar representing this result. It does not modify either original scalar.

Parameters

scalar - The scalar to multiply this scalar by.

Returns: The result of the division.

SIMDScalar om::math::SIMDScalar< Int16, 8 >::operator/ ( const Int16 value ) const

inline

Divide every component of this scalar by a value and return the result.

This method Divides every component of the scalar by the value parameter, and returns a scalar representing this result. It does not modifiy the original scalar.

Parameters

value - The value to divide all components of this scalar by.

Returns: The resulting scalar of this division.

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator+= ( const SIMDScalar< Int16, 8 > & scalar )

inline

Add a scalar to this scalar, modifying this original scalar.

This method adds another scalar to this scalar, component-wise, and sets this scalar to have the result of this addition.

Parameters

scalar - The scalar to add to this scalar.

Returns: A reference to this modified scalar.

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator-= ( const SIMDScalar< Int16, 8 > & scalar )

inline

Subtract a scalar from this scalar, modifying this original scalar.

This method subtracts another scalar from this scalar, component-wise, and sets this scalar to have the result of this subtraction.

Parameters

scalar - The scalar to subtract from this scalar.

Returns: A reference to this modified scalar.

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator*= ( const SIMDScalar< Int16, 8 > & scalar )

inline

Multiply component-wise this scalar and another scalar and modify this scalar.

This operator multiplies each component of this scalar by the corresponding component of the other scalar and modifies this scalar to contain the result.

Parameters

scalar - The scalar to multiply this scalar by.

Returns: A reference to this modified scalar.

SIMDScalar& om::math::SIMDScalar< Int16, 8 >::operator/= ( const SIMDScalar< Int16, 8 > & scalar )

inline

Divide this scalar by another scalar component-wise and modify this scalar.

This operator divides each component of this scalar by the corresponding component of the other scalar and modifies this scalar to contain the result.

Parameters

scalar - The scalar to divide this scalar by.