Hypercomplex< T, dim > Class Template Reference

#include <Hypercomplex.hpp>

Public Member Functions
	Hypercomplex (const T *ARR)
	This is the main constructor. More...
	Hypercomplex (const Hypercomplex &H)
	This is the copy constructor. More...
uint64_t	_ () const
	Dimensionality getter. More...
T	norm () const
	Calculate Euclidean norm of a number. More...
Hypercomplex	inv () const
	Calculate inverse of a given number. More...
template<const uint64_t newdim>
Hypercomplex< T, newdim >	expand () const
	Cast a number into a higher dimension. More...
Hypercomplex	operator~ () const
	Create a complex conjugate. More...
Hypercomplex	operator- () const
	Create an additive inverse of a given number. More...
Hypercomplex &	operator= (const Hypercomplex &H)
	Assignment operator. More...
T const &	operator[] (const uint64_t i) const
	Access operator (const) More...
T &	operator[] (const uint64_t i)
	Access operator (non-const) More...
Hypercomplex &	operator+= (const Hypercomplex &H)
	Addition-Assignment operator. More...
Hypercomplex &	operator-= (const Hypercomplex &H)
	Subtraction-Assignment operator. More...
Hypercomplex &	operator*= (const Hypercomplex &H)
	Multiplication-Assignment operator. More...
Hypercomplex &	operator^= (const uint64_t x)
	Power-Assignment operator. More...
Hypercomplex &	operator/= (const Hypercomplex &H)
	Division-Assignment operator. More...

Static Public Member Functions
static void	init ()
	Basis multiplication table initialiser.
static void	clear ()
	Cleanup function: free all memory.
static Hypercomplex	MUL (const Hypercomplex &H1, const Hypercomplex &H2)
	Optimised multiplication function. More...

Detailed Description

template<typename T, const uint64_t dim>
class Hypercomplex< T, dim >

Main class of the library

Constructor & Destructor Documentation

Hypercomplex() [1/2]

template<typename T , const uint64_t dim>

Hypercomplex< T, dim >::Hypercomplex ( const T *  ARR )

explicit

This is the main constructor.

Parameters

[in]

ARR

array of numbers

Template parameters are:

• base type of numbers in the argument array
• dimensionality of the algebra

Hypercomplex() [2/2]

template<typename T , const uint64_t dim>

Hypercomplex< T, dim >::Hypercomplex

(

const Hypercomplex< T, dim > &

H

)

This is the copy constructor.

Parameters

[in]

H

existing class instance

Template parameters are:

• base type of numbers in the argument array
• dimensionality of the algebra

Member Function Documentation

_()

template<typename T , const uint64_t dim>

uint64_t Hypercomplex< T, dim >::_ ( ) const

inline

Dimensionality getter.

Returns

algebraic dimension of the underlying object

expand()

template<typename T , const uint64_t dim>

template<const uint64_t newdim>

Hypercomplex< T, newdim > Hypercomplex< T, dim >::expand

Cast a number into a higher dimension.

Returns

new class instance

New dimension is passed as a function template parameter, as the return class is not the same as the caller's class.

inv()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > Hypercomplex< T, dim >::inv

Calculate inverse of a given number.

Returns

new class instance

MUL()

template<typename T , const uint64_t dim>

static Hypercomplex Hypercomplex< T, dim >::MUL ( const Hypercomplex< T, dim > &  H1, const Hypercomplex< T, dim > &  H2  )

inlinestatic

Optimised multiplication function.

Parameters

[in]	H1	LHS operand
[in]	H2	RHS operand

Returns

new class instance

norm()

template<typename T , const uint64_t dim>

T Hypercomplex< T, dim >::norm

inline

Calculate Euclidean norm of a number.

Returns

calculated norm

Note that the return type is the same as template parameter.

operator*=()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > & Hypercomplex< T, dim >::operator*=

(

const Hypercomplex< T, dim > &

H

)

Multiplication-Assignment operator.

Parameters

[in]

H

existing class instance

Returns

Reference to the caller

operator+=()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > & Hypercomplex< T, dim >::operator+=

(

const Hypercomplex< T, dim > &

H

)

Addition-Assignment operator.

Parameters

[in]

H

existing class instance

Returns

Reference to the caller

operator-()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > Hypercomplex< T, dim >::operator-

Create an additive inverse of a given number.

Returns

new class instance

operator-=()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > & Hypercomplex< T, dim >::operator-=

(

const Hypercomplex< T, dim > &

H

)

Subtraction-Assignment operator.

Parameters

[in]

H

existing class instance

Returns

Reference to the caller

operator/=()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > & Hypercomplex< T, dim >::operator/=

(

const Hypercomplex< T, dim > &

H

)

Division-Assignment operator.

Parameters

[in]

H

existing class instance

Returns

Reference to the caller

operator=()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > & Hypercomplex< T, dim >::operator= ( const Hypercomplex< T, dim > &  H )

inline

Assignment operator.

Parameters

[in]

H

existing class instance

Returns

Reference to the caller (for chained assignments)

operator[]() [1/2]

template<typename T , const uint64_t dim>

T & Hypercomplex< T, dim >::operator[] ( const uint64_t  i )

inline

Access operator (non-const)

Parameters

[in]

i

index for the element to access

Returns

i-th element of the number

Note that the return type is the same as template parameter.

operator[]() [2/2]

template<typename T , const uint64_t dim>

T const & Hypercomplex< T, dim >::operator[] ( const uint64_t  i ) const

inline

Access operator (const)

Parameters

[in]

i

index for the element to access

Returns

i-th element of the number

Note that the return type is the same as template parameter.

operator^=()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > & Hypercomplex< T, dim >::operator^=

(

const uint64_t

x

)

Power-Assignment operator.

Parameters

[in]

x

positive integer

Returns

Reference to the caller

operator~()

template<typename T , const uint64_t dim>

Hypercomplex< T, dim > Hypercomplex< T, dim >::operator~

inline

Create a complex conjugate.

Returns

new class instance