ASpaceObject Class Reference

#include <ASpaceObject.hpp>

Inheritance diagram for ASpaceObject:

Detailed Description

This class is the base class for all objects that need to know what is its space definition. All ASpaceObject can access to the number of space dimensions and can ask to calculate a distance between two ASpaceObjects.

This class also stores a unique (static) default global space that will be used as default space when creating a ASpaceObject (without a predefined space). It is possible to modify the default space definition at any time. Space definition of pre-existing ASpaceObjects remains the same. (no more shared pointer)

Public Member Functions
	ASpaceObject (const ASpaceSharedPtr &space=ASpaceSharedPtr())
	ASpaceObject (const ASpaceObject &r)
ASpaceObject &	operator= (const ASpaceObject &r)
virtual	~ASpaceObject ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable interface.
ASpaceSharedPtr	getSpace () const
	Accessor to the current object space context.
bool	isConsistent () const
	Indicate if I am consistent with my current space context.
VectorDouble	getUnitaryVector () const
	Return unitary vector for the current space context.
bool	isConsistent (const ASpaceSharedPtr &space) const
	Indicate if I am consistent with the provided space.
virtual bool	isConsistent (const ASpace *space) const =0
unsigned int	getNDim (int ispace=-1) const
	Shortcuts to ASpace methods.
const VectorDouble &	getOrigin (int ispace=-1) const
	Return the current space context origin coordinates.
double	getDistance (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) const
	Return the distance between two space points for the current space context.
VectorDouble	getDistances (const SpacePoint &p1, const SpacePoint &p2) const
	Return all the distances (space composits) between two space points for the current space context.
VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) const
	Return the increment vector between two space points for the current space context.
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

Constructor & Destructor Documentation

ASpaceObject() [1/2]

ASpaceObject::ASpaceObject

(

const ASpaceSharedPtr &

space = ASpaceSharedPtr()

)

ASpaceObject() [2/2]

ASpaceObject::ASpaceObject

(

const ASpaceObject &

r

)

~ASpaceObject()

ASpaceObject::~ASpaceObject ( )

virtual

Member Function Documentation

getDistance()

double ASpaceObject::getDistance	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		int	ispace = 0
	)		const

Return the distance between two space points for the current space context.

getDistances()

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

Return all the distances (space composits) between two space points for the current space context.

getIncrement()

VectorDouble ASpaceObject::getIncrement	(	const SpacePoint &	p1,
		const SpacePoint &	p2,
		int	ispace = 0
	)		const

Return the increment vector between two space points for the current space context.

getNDim()

unsigned int ASpaceObject::getNDim

(

int

ispace = -1

)

const

Shortcuts to ASpace methods.

Return the number of dimension of the current space context

getOrigin()

const VectorDouble & ASpaceObject::getOrigin

(

int

ispace = -1

)

const

Return the current space context origin coordinates.

getSpace()

ASpaceSharedPtr ASpaceObject::getSpace ( ) const

inline

Accessor to the current object space context.

getUnitaryVector()

VectorDouble ASpaceObject::getUnitaryVector

(

)

const

Return unitary vector for the current space context.

isConsistent() [1/3]

bool ASpaceObject::isConsistent ( ) const

inline

Indicate if I am consistent with my current space context.

isConsistent() [2/3]

virtual bool ASpaceObject::isConsistent ( const ASpace *  space ) const

pure virtual

Implemented in CorAniso, CorGneiting, CorMatern, CovAnisoList, CovBase, CovContext, CovList, ANeigh, SpacePoint, and DirParam.

isConsistent() [3/3]

bool ASpaceObject::isConsistent

(

const ASpaceSharedPtr &

space

)

const

Indicate if I am consistent with the provided space.

operator=()

ASpaceObject & ASpaceObject::operator=

(

const ASpaceObject &

r

)

toString()

String ASpaceObject::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

AStringable interface.

Reimplemented from AStringable.

Reimplemented in CorAniso, CovAniso, CovAnisoList, CovContext, CovList, CovLMCAnamorphosis, CovLMCConvolution, CovLMCTapering, NeighBench, NeighCell, NeighImage, NeighMoving, NeighUnique, SpacePoint, SpaceTarget, and DirParam.

---

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

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