tarch::la::Vector< size, T > Class Template Reference

#include <Vector.h>

Public Member Functions
KOKKOS_FUNCTION	Vector (const T &t)
	init. vector with a scalar value.
KOKKOS_FUNCTION	Vector (const T &t0, const T &t1)
	special constructor for 2D left empty for general purpose vector
KOKKOS_FUNCTION	Vector (const T &t0, const T &t1, const T &t2)
	special constructor for 3D; left empty for general purpose vector
KOKKOS_FUNCTION	Vector (const Vector< size, T > &v)
	constructor init. vector from vector
KOKKOS_FUNCTION void	assign (const T &t)
	assigns a value to all vector entries.
KOKKOS_FUNCTION Vector< size, T > &	operator= (const Vector< size, T > &v)
	operator overloading for vector assignment
KOKKOS_FUNCTION T &	operator[] (int i)
	operator overloading; access to vector entries; both () and [] are allowed
KOKKOS_FUNCTION const T &	operator[] (int i) const
	operator overloading; access to vector entries; both () and [] are allowed; !!! Attention: const
KOKKOS_FUNCTION Vector< size, T > &	operator+= (const Vector< size, T > &v)
	operator overloading; add a vector to this existing one (this)
KOKKOS_FUNCTION Vector< size, T > &	operator-= (const Vector< size, T > &v)
	operator overloading; subtracts a vector from the existing one (this)
template<class convert_to_T>
KOKKOS_FUNCTION	operator Vector< size, convert_to_T > () const

Private Attributes
T	_entries [size]

Detailed Description

template<int size, class T>
class tarch::la::Vector< size, T >

light-weight implementation of a vector class.

Template Parameters

size	Size
T	Data type

Author

Philipp Neumann

Constructor & Destructor Documentation

Vector() [1/4]

template<int size, class T>

KOKKOS_FUNCTION tarch::la::Vector< size, T >::Vector ( const T & t )

inline

init. vector with a scalar value.

Parameters

t	scalar value for the initialization

Vector() [2/4]

template<int size, class T>

KOKKOS_FUNCTION tarch::la::Vector< size, T >::Vector ( const T & t0, const T & t1 )

inline

special constructor for 2D left empty for general purpose vector

Parameters

t0	scalar value for the initialization
t1	scalar value for the initialization

Vector() [3/4]

template<int size, class T>

KOKKOS_FUNCTION tarch::la::Vector< size, T >::Vector ( const T & t0, const T & t1, const T & t2 )

inline

special constructor for 3D; left empty for general purpose vector

Parameters

t0	scalar value for the initialization
t1	scalar value for the initialization
t2	scalar value for the initialization

Vector() [4/4]

template<int size, class T>

KOKKOS_FUNCTION tarch::la::Vector< size, T >::Vector ( const Vector< size, T > & v )

inline

constructor init. vector from vector

Parameters

v	Vector for the initialization

Member Function Documentation

assign()

template<int size, class T>

KOKKOS_FUNCTION void tarch::la::Vector< size, T >::assign ( const T & t )

inline

assigns a value to all vector entries.

Parameters

t	scalar value for the assignment

operator Vector< size, convert_to_T >()

template<int size, class T>

template<class convert_to_T>

KOKKOS_FUNCTION tarch::la::Vector< size, T >::operator Vector< size, convert_to_T > ( ) const

inlineexplicit

cast Vector<size, T> to Vector<size, convert_to_T>

operator+=()

template<int size, class T>

KOKKOS_FUNCTION Vector< size, T > & tarch::la::Vector< size, T >::operator+= ( const Vector< size, T > & v )

inline

operator overloading; add a vector to this existing one (this)

Parameters

v	vector that has to be added

operator-=()

template<int size, class T>

KOKKOS_FUNCTION Vector< size, T > & tarch::la::Vector< size, T >::operator-= ( const Vector< size, T > & v )

inline

operator overloading; subtracts a vector from the existing one (this)

Parameters

v	vector that has to be subtracted

operator=()

template<int size, class T>

KOKKOS_FUNCTION Vector< size, T > & tarch::la::Vector< size, T >::operator= ( const Vector< size, T > & v )

inline

operator overloading for vector assignment

Parameters

v	Vector for the assignment

operator[]() [1/2]

template<int size, class T>

KOKKOS_FUNCTION T & tarch::la::Vector< size, T >::operator[] ( int i )

inline

operator overloading; access to vector entries; both () and [] are allowed

Parameters

i

index

operator[]() [2/2]

template<int size, class T>

KOKKOS_FUNCTION const T & tarch::la::Vector< size, T >::operator[] ( int i ) const

inline

operator overloading; access to vector entries; both () and [] are allowed; !!! Attention: const

Parameters

i

index

---

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

• tarch/la/Vector.h