shift< dim, T > Class Template Reference

Detailed Description

template<unsigned int dim, typename T>
class shift< dim, T >

This Class apply a shift transformation before converting to Cell-ID

Definition at line 26 of file CellDecomposer.hpp.

#include <CellDecomposer.hpp>

Public Member Functions
	shift (const Matrix< dim, T > &t, const Point< dim, T > &s)
	Constructor. More...
T	transform (const T(&s)[dim], const size_t i) const
	Shift the point transformation. More...
T	transform (const Point< dim, T > &s, const size_t i) const
	Shift the point transformation. More...
template<typename Mem >
T	transform (const encapc< 1, Point< dim, T >, Mem > &s, const size_t i) const
	Shift the point transformation. More...
void	setTransform (const Matrix< dim, T > &mat, const Point< dim, T > &orig)
	Set the transformation Matrix and shift. More...
const Point< dim, T > &	getOrig () const
	Get the shift vector. More...
const Matrix< dim, T > &	getMat () const
	Get the transformation Matrix. More...
bool	operator== (const shift< dim, T > &s)
	It return true if the shift match. More...
bool	operator!= (const shift< dim, T > &s)
	It return true if the shift is different. More...

Private Attributes
Point< dim, T >	sh
	Shift point.
Matrix< dim, T >	mat
	Matrix transformation.

Constructor & Destructor Documentation

template<unsigned int dim, typename T>

shift< dim, T >::shift ( const Matrix< dim, T > &  t, const Point< dim, T > &  s  )

inline

Constructor.

Parameters

t	Matrix transformation
s	shift

Definition at line 42 of file CellDecomposer.hpp.

Member Function Documentation

template<unsigned int dim, typename T>

const Matrix<dim,T>& shift< dim, T >::getMat ( ) const

inline

Get the transformation Matrix.

Returns

the transformation matrix

Definition at line 114 of file CellDecomposer.hpp.

template<unsigned int dim, typename T>

const Point<dim,T>& shift< dim, T >::getOrig ( ) const

inline

Get the shift vector.

Returns

the shift vector

Definition at line 104 of file CellDecomposer.hpp.

template<unsigned int dim, typename T>

bool shift< dim, T >::operator!= ( const shift< dim, T > &  s )

inline

It return true if the shift is different.

Parameters

s	shift to compare with

Returns

true if the shift is different

Definition at line 138 of file CellDecomposer.hpp.

template<unsigned int dim, typename T>

bool shift< dim, T >::operator== ( const shift< dim, T > &  s )

inline

It return true if the shift match.

Parameters

s	shift to compare with

Returns

true if it match

Definition at line 126 of file CellDecomposer.hpp.

template<unsigned int dim, typename T>

void shift< dim, T >::setTransform ( const Matrix< dim, T > &  mat, const Point< dim, T > &  orig  )

inline

Set the transformation Matrix and shift.

Parameters

mat	Matrix transformation
orig	origin point

Definition at line 93 of file CellDecomposer.hpp.

template<unsigned int dim, typename T>

T shift< dim, T >::transform ( const T(&)  s[dim], const size_t  i  ) const

inline

Shift the point transformation.

Parameters

s	source point
i	coordinate

Returns

the transformed coordinate

Definition at line 56 of file CellDecomposer.hpp.

template<unsigned int dim, typename T>

T shift< dim, T >::transform ( const Point< dim, T > &  s, const size_t  i  ) const

inline

Shift the point transformation.

Parameters

s	source point
i	coordinate

Returns

the transformed coordinate

Definition at line 69 of file CellDecomposer.hpp.

template<unsigned int dim, typename T>

template<typename Mem >

T shift< dim, T >::transform ( const encapc< 1, Point< dim, T >, Mem > &  s, const size_t  i  ) const

inline

Shift the point transformation.

Parameters

s	source point
i	coordinate

Returns

the transformed coordinate

Definition at line 82 of file CellDecomposer.hpp.

---

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

• openfpm_data/src/NN/CellList/CellDecomposer.hpp