gstlrn::Rotation Class Reference

TODO : public ASpaceObject. More...

#include <Rotation.hpp>

Inheritance diagram for gstlrn::Rotation:

Detailed Description

TODO : public ASpaceObject.

Public Member Functions
	Rotation (size_t ndim=2)
	Rotation (const Rotation &r)
Rotation &	operator= (const Rotation &r)
virtual	~Rotation ()
size_t	getNDim () const
bool	isRotated () const
const MatrixSquare &	getMatrixDirect () const
const MatrixSquare &	getMatrixInverse () const
const &	getAngles () const
double	getAngle (Id idim) const
Id	getDerivativesInPlace (std::vector< MatrixSquare > &res) const
std::vector< MatrixSquare >	getDerivatives () const
void	resetFromSpaceDimension (size_t ndim)
String	toString (const AStringFormat *strfmt=nullptr) const override
Id	setMatrixDirect (const MatrixSquare &rotmat)
Id	setMatrixDirectVec (const 1 &rotmat)
Id	setAngles (const 1 &angles)
void	setIdentity ()
void	rotateDirect (const 1 &inv, 1 &outv) const
void	rotateInverse (const 1 &inv, 1 &outv) const
bool	isIdentity () const
bool	isSame (const Rotation &rot) const
	getMatrixDirectVec () const
	getMatrixInverseVec () const
double	getMatrixDirect (Id idim, Id jdim) const
double	getMatrixInverse (Id idim, Id jdim) const
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final

Static Public Member Functions
static bool	isMatrixRotation (const MatrixSquare &rotmat, bool verbose)

Constructor & Destructor Documentation

Rotation() [1/2]

gstlrn::Rotation::Rotation

(

size_t

ndim = 2

)

Rotation() [2/2]

gstlrn::Rotation::Rotation

(

const Rotation &

r

)

~Rotation()

gstlrn::Rotation::~Rotation ( )

virtual

Member Function Documentation

getAngle()

double gstlrn::Rotation::getAngle ( Id  idim ) const

inline

getAngles()

const & gstlrn::Rotation::getAngles ( ) const

inline

getDerivatives()

std::vector< MatrixSquare > gstlrn::Rotation::getDerivatives

(

)

const

getDerivativesInPlace()

Id gstlrn::Rotation::getDerivativesInPlace

(

std::vector< MatrixSquare > &

res

)

const

getMatrixDirect() [1/2]

const MatrixSquare & gstlrn::Rotation::getMatrixDirect ( ) const

inline

getMatrixDirect() [2/2]

double gstlrn::Rotation::getMatrixDirect ( Id  idim, Id  jdim  ) const

inline

getMatrixDirectVec()

gstlrn::Rotation::getMatrixDirectVec ( ) const

inline

getMatrixInverse() [1/2]

const MatrixSquare & gstlrn::Rotation::getMatrixInverse ( ) const

inline

getMatrixInverse() [2/2]

double gstlrn::Rotation::getMatrixInverse ( Id  idim, Id  jdim  ) const

inline

getMatrixInverseVec()

gstlrn::Rotation::getMatrixInverseVec ( ) const

inline

getNDim()

size_t gstlrn::Rotation::getNDim ( ) const

inline

isIdentity()

bool gstlrn::Rotation::isIdentity ( ) const

inline

isMatrixRotation()

bool gstlrn::Rotation::isMatrixRotation ( const MatrixSquare &  rotmat, bool  verbose  )

static

Check if a matrix is a rotation matrix

Returns

true if the matrix is a rotation matrix; false otherwise

Parameters

[in]	rotmat	Square matrix to be checked
[in]	verbose	1 for the verbose option

Remarks

A rotation matrix must be orthogonal with determinant equal to 1

isRotated()

bool gstlrn::Rotation::isRotated ( ) const

inline

isSame()

bool gstlrn::Rotation::isSame

(

const Rotation &

rot

)

const

operator=()

Rotation & gstlrn::Rotation::operator=

(

const Rotation &

r

)

resetFromSpaceDimension()

void gstlrn::Rotation::resetFromSpaceDimension

(

size_t

ndim

)

rotateDirect()

void gstlrn::Rotation::rotateDirect	(	const 1 &	inv,
		1 &	outv
	)		const

rotateInverse()

void gstlrn::Rotation::rotateInverse	(	const 1 &	inv,
		1 &	outv
	)		const

setAngles()

Id gstlrn::Rotation::setAngles

(

const 1 &

angles

)

setIdentity()

void gstlrn::Rotation::setIdentity

(

)

setMatrixDirect()

Id gstlrn::Rotation::setMatrixDirect

(

const MatrixSquare &

rotmat

)

setMatrixDirectVec()

Id gstlrn::Rotation::setMatrixDirectVec

(

const 1 &

rotmat

)

toString()

String gstlrn::Rotation::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Reimplemented from gstlrn::AStringable.

---

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

• include/Geometry/Rotation.hpp
• src/Basic/Rotation.cpp