SpaceComposite Class Reference

#include <SpaceComposite.hpp>

Inheritance diagram for SpaceComposite:

Public Member Functions
virtual	~SpaceComposite ()
ESpaceType	getType () const override
	Return the concrete space type.
void	setOrigin (const VectorDouble &origin) override
	Update the origin of the space.
unsigned int	getNDim (int ispace=-1) const override
	Get the number of dimensions.
unsigned int	getOffset (int ispace=-1) const override
	Get the offset index for coordinates.
const VectorDouble &	getOrigin (int ispace=-1) const override
	Return the space origin coordinates.
unsigned int	getNComponents () const override
	Get the number of space components.
ASpaceSharedPtr	getComponent (int ispace=-1) const override
	Return the space component at index ispace.
String	toString (const AStringFormat *strfmt=nullptr, int ispace=0) const override
	Dump a space in a string (given the space index)
bool	isEqual (const ASpace *space) const override
	Return true if the given space is equal to me (same dimension and space definition)
VectorDouble	getDistances (const SpacePoint &p1, const SpacePoint &p2) const override
	Return all the distances (one by space component) between two space points.
void	addSpaceComponent (const ASpaceSharedPtr &comp)
	Add a space component to me (for exemple RN(1) for time dimension)
Public Member Functions inherited from ASpace
virtual	~ASpace ()
String	toString (const AStringFormat *strfmt=nullptr) const final
	Interface for AStringable.
virtual void	getDistancePointVectInPlace (const SpacePoint &p1, const std::vector< SpacePoint > &p2, VectorDouble &res, const VectorInt &ranks) const
void	move (SpacePoint &p1, const VectorDouble &vec) const
	Not to be overriden.
double	getDistance (const SpacePoint &p1, const SpacePoint &p2, int ispace=-1) const
	Return the distance between two space points.
double	getDistance (const SpacePoint &p1, const SpacePoint &p2, const Tensor &tensor, int ispace=-1) const
	Return the distance between two space points with the given tensor.
double	getFrequentialDistance (const SpacePoint &p1, const SpacePoint &p2, const Tensor &tensor, int ispace=-1) const
	Return the distance in frequential domain between two space points with the given tensor.
VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2, int ispace=-1) const
	Return the increment vector between two space points.
virtual VectorDouble	projCoord (const VectorDouble &coord, int ispace=-1) const
	Project the coordinates in the given space.
void	setOffset (unsigned int offset)
	Customize the dimension offset index of the current space TODO : to be made private.
Public Member Functions inherited from 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 (int level) const final
Public Member Functions inherited from ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0

Static Public Member Functions
static std::shared_ptr< SpaceComposite >	create (const ASpaceSharedPtrVector &vectspace=ASpaceSharedPtrVector())
	ICloneable interface.
Static Public Member Functions inherited from ASpace
static std::shared_ptr< const ASpace >	getDefaultSpaceIfNull (const std::shared_ptr< const ASpace > &space)

Constructor & Destructor Documentation

~SpaceComposite()

SpaceComposite::~SpaceComposite ( )

virtual

Member Function Documentation

addSpaceComponent()

void SpaceComposite::addSpaceComponent

(

const ASpaceSharedPtr &

comp

)

Add a space component to me (for exemple RN(1) for time dimension)

create()

std::shared_ptr< SpaceComposite > SpaceComposite::create ( const ASpaceSharedPtrVector &  vectspace = ASpaceSharedPtrVector() )

static

ICloneable interface.

getComponent()

ASpaceSharedPtr SpaceComposite::getComponent ( int  ispace = -1 ) const

overridevirtual

Return the space component at index ispace.

Reimplemented from ASpace.

getDistances()

VectorDouble SpaceComposite::getDistances ( const SpacePoint &  p1, const SpacePoint &  p2  ) const

overridevirtual

Return all the distances (one by space component) between two space points.

Reimplemented from ASpace.

getNComponents()

unsigned int SpaceComposite::getNComponents ( ) const

overridevirtual

Get the number of space components.

Reimplemented from ASpace.

getNDim()

unsigned int SpaceComposite::getNDim ( int  ispace = -1 ) const

overridevirtual

Get the number of dimensions.

Reimplemented from ASpace.

getOffset()

unsigned int SpaceComposite::getOffset ( int  ispace = -1 ) const

overridevirtual

Get the offset index for coordinates.

Reimplemented from ASpace.

getOrigin()

const VectorDouble & SpaceComposite::getOrigin ( int  ispace = -1 ) const

overridevirtual

Return the space origin coordinates.

Reimplemented from ASpace.

getType()

ESpaceType SpaceComposite::getType ( ) const

inlineoverridevirtual

Return the concrete space type.

Implements ASpace.

isEqual()

bool SpaceComposite::isEqual ( const ASpace *  space ) const

overridevirtual

Return true if the given space is equal to me (same dimension and space definition)

Reimplemented from ASpace.

setOrigin()

void SpaceComposite::setOrigin ( const VectorDouble &  origin )

overridevirtual

Update the origin of the space.

Reimplemented from ASpace.

toString()

String SpaceComposite::toString ( const AStringFormat *  strfmt = nullptr, int  ispace = 0  ) const

overridevirtual

Dump a space in a string (given the space index)

Reimplemented from ASpace.

---

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

• include/Space/SpaceComposite.hpp
• src/Space/SpaceComposite.cpp