Value array implementation. The object does not hold ownership of its memory. More...

#include <ValueBundle.hpp>

Public Member Functions
	ValueBundle ()
	Construct an empty ValueBundle object.

	ValueBundle (T *data, const int size)
	Construct a new ValueBundle object. More...

ValueBundle &	operator= (const ValueBundle< T > &rhs)
	Assignment operator. More...

T &	operator[] (const int n)
	Access the nth value stored in the value bundle. More...

int	size () const
	Retrieve the number of elements in the value bundle. More...

T *	data () const
	Retrieve the pointer to the first value stored in the bundle. More...

ValueBundle &	multAdd (const T &rhs1, const ValueBundle< T > &rhs2)
	Fused multiply-add, equivalent to operator+=(rhs1 * rhs2). More...

ValueBundle &	multAdd (const ValueBundle< T > &rhs1, const T &rhs2)
	Fused multiply-add for scalar right-multiplication, equivalent to operator+=(rhs1 * rhs2). More...

ValueBundle &	multAdd (const ValueBundle< T > &rhs1, const ValueBundle< T > &rhs2)
	Elementwise fused multiply-add. Equivalent to elementwise operator+=(rhs1 * rhs2). More...

ValueBundle &	multAdd (const T &rhs1, const ValueBundle< T > &rhs2, const ValueBundle< T > &rhs3)
	Elementwise double-multiply add. Equivalent to elementwise operator+=(rhs1 * rhs2 * rhs3). More...

ValueBundle &	multSub (const T &rhs1, const ValueBundle< T > &rhs2)
	Fused multiply-sub, equivalent to operator-=(rhs1 * rhs2). More...

ValueBundle &	multSub (const ValueBundle< T > &rhs1, const T &rhs2)
	Fused multiply-sub for scalar right-multiplication, equivalent to operator-=(rhs1 * rhs2). More...

ValueBundle &	multSub (const ValueBundle< T > &rhs1, const ValueBundle< T > &rhs2)
	Elementwise fused multiply-sub. Equivalent to elementwise operator-=(rhs1 * rhs2). More...

ValueBundle &	multSub (const T &rhs1, const ValueBundle< T > &rhs2, const ValueBundle< T > &rhs3)
	Elementwise double-multiply sub. Equivalent to elementwise operator-=(rhs1 * rhs2 * rhs3). More...

ValueBundle &	operator+= (const ValueBundle &rhs)
	Addition assignment. More...

ValueBundle &	operator-= (const ValueBundle &rhs)
	Subtraction assignment. More...

ValueBundle &	operator*= (const T &rhs)
	Multiplication assignment. More...

ValueBundle &	operator/= (const T &rhs)
	Division assignment. More...

Detailed Description

template<class T>
struct ValueBundle< T >

Value array implementation. The object does not hold ownership of its memory.

Template Parameters

T	Underlying fundamental data type.

Constructor & Destructor Documentation

◆ ValueBundle()

template<class T >

ValueBundle< T >::ValueBundle	(	T *	data,
		const int	size
	)

inline

Construct a new ValueBundle object.

Parameters

data	Storage memory, size should at least be size * sizeof(T). Memory is not deleted on destruction of the ValueBundle.
size	Number of elemenets in the ValueBundle.

Member Function Documentation

◆ data()

template<class T >

T* ValueBundle< T >::data ( ) const

inline

Retrieve the pointer to the first value stored in the bundle.

Returns: const T* Pointer to the first vlaue stored in the bundle.

◆ multAdd() [1/4]

template<class T >

ValueBundle& ValueBundle< T >::multAdd	(	const T &	rhs1,
		const ValueBundle< T > &	rhs2
	)

inline

Fused multiply-add, equivalent to operator+=(rhs1 * rhs2).

Parameters

rhs1	Scalar operand.
rhs2	Array operand.

Returns: ValueBundle& Reference to self.

◆ multAdd() [2/4]

template<class T >

ValueBundle& ValueBundle< T >::multAdd	(	const T &	rhs1,
		const ValueBundle< T > &	rhs2,
		const ValueBundle< T > &	rhs3
	)

inline

Elementwise double-multiply add. Equivalent to elementwise operator+=(rhs1 * rhs2 * rhs3).

Parameters

rhs1	Scalar operand.
rhs2	Left array operand.
rhs3	Right array operand.

Returns: ValueBundle& Reference to self.

◆ multAdd() [3/4]

template<class T >

ValueBundle& ValueBundle< T >::multAdd	(	const ValueBundle< T > &	rhs1,
		const T &	rhs2
	)

inline

Fused multiply-add for scalar right-multiplication, equivalent to operator+=(rhs1 * rhs2).

Parameters

rhs1	Array operand.
rhs2	Scalar operand.

Returns: ValueBundle& Reference to self.

◆ multAdd() [4/4]

template<class T >

ValueBundle& ValueBundle< T >::multAdd	(	const ValueBundle< T > &	rhs1,
		const ValueBundle< T > &	rhs2
	)

inline

Elementwise fused multiply-add. Equivalent to elementwise operator+=(rhs1 * rhs2).

Parameters

rhs1	Left array operand.
rhs2	Right array operand.

Returns: ValueBundle& Reference to self.

◆ multSub() [1/4]

template<class T >

ValueBundle& ValueBundle< T >::multSub	(	const T &	rhs1,
		const ValueBundle< T > &	rhs2
	)

inline

Fused multiply-sub, equivalent to operator-=(rhs1 * rhs2).

Parameters

rhs1	Scalar operand.
rhs2	Array operand.

Returns: ValueBundle& Reference to self.

◆ multSub() [2/4]

template<class T >

ValueBundle& ValueBundle< T >::multSub	(	const T &	rhs1,
		const ValueBundle< T > &	rhs2,
		const ValueBundle< T > &	rhs3
	)

inline

Elementwise double-multiply sub. Equivalent to elementwise operator-=(rhs1 * rhs2 * rhs3).

Parameters

rhs1	Scalar operand.
rhs2	Left array operand.
rhs3	Right array operand.

Returns: ValueBundle& Reference to self.

◆ multSub() [3/4]

template<class T >

ValueBundle& ValueBundle< T >::multSub	(	const ValueBundle< T > &	rhs1,
		const T &	rhs2
	)

inline

Fused multiply-sub for scalar right-multiplication, equivalent to operator-=(rhs1 * rhs2).

Parameters

rhs1	Array operand.
rhs2	Scalar operand.

Returns: ValueBundle& Reference to self.

◆ multSub() [4/4]

template<class T >

ValueBundle& ValueBundle< T >::multSub	(	const ValueBundle< T > &	rhs1,
		const ValueBundle< T > &	rhs2
	)

inline

Elementwise fused multiply-sub. Equivalent to elementwise operator-=(rhs1 * rhs2).

Parameters

rhs1	Left array operand.
rhs2	Right array operand.

Returns: ValueBundle& Reference to self.

◆ operator*=()

template<class T >

ValueBundle& ValueBundle< T >::operator*= ( const T & rhs )

inline

Multiplication assignment.

Parameters

rhs	Right hand side operand.

Returns: ValueBundle& Reference to self.

◆ operator+=()

template<class T >

ValueBundle& ValueBundle< T >::operator+= ( const ValueBundle< T > & rhs )

inline

Addition assignment.

Parameters

rhs	Right hand side operand.

Returns: ValueBundle& Reference to self.

◆ operator-=()

template<class T >

ValueBundle& ValueBundle< T >::operator-= ( const ValueBundle< T > & rhs )

inline

Subtraction assignment.

Parameters

rhs	Right hand side operand.

Returns: ValueBundle& Reference to self.

◆ operator/=()

template<class T >

ValueBundle& ValueBundle< T >::operator/= ( const T & rhs )

inline

Division assignment.

Parameters

rhs	Right hand side operand.

Returns: ValueBundle& Reference to self.

◆ operator=()

template<class T >

ValueBundle& ValueBundle< T >::operator= ( const ValueBundle< T > & rhs )

inline

Assignment operator.

Parameters

rhs	Right hand size operand.

Returns: ValueBundle& Reference to self.

◆ operator[]()

template<class T >

T& ValueBundle< T >::operator[] ( const int n )

inline

Access the nth value stored in the value bundle.

Parameters

n	Element number.

Returns: T& Reference to nth element.

◆ size()

template<class T >

int ValueBundle< T >::size ( ) const

inline

Retrieve the number of elements in the value bundle.

Returns: int Number of elements in the value bundle.

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

/home/runner/work/SpinParser/SpinParser/src/lib/ValueBundle.hpp

Public Member Functions

Detailed Description

template<class T> struct ValueBundle< T >

Constructor & Destructor Documentation

◆ ValueBundle()

Member Function Documentation

◆ data()

◆ multAdd() [1/4]

◆ multAdd() [2/4]

◆ multAdd() [3/4]

◆ multAdd() [4/4]

◆ multSub() [1/4]

◆ multSub() [2/4]

◆ multSub() [3/4]

◆ multSub() [4/4]

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator=()

◆ operator[]()

◆ size()

template<class T>
struct ValueBundle< T >