gstlearn  1.0.0
CCC
SpaceRN Class Reference

#include <SpaceRN.hpp>

Inheritance diagram for SpaceRN:
ASpace AStringable ICloneable

Public Member Functions

 SpaceRN (unsigned int ndim)
 
 SpaceRN (const SpaceRN &r)
 
SpaceRNoperator= (const SpaceRN &r)
 
virtual ~SpaceRN ()
 
ESpaceType getType () const override
 Return the concrete space type. More...
 
void move (SpacePoint &p1, const VectorDouble &vec) const override
 Move the given space point by the given vector. More...
 
double getDistance (const SpacePoint &p1, const SpacePoint &p2) const override
 Return the distance between two space points. More...
 
double getDistance (const SpacePoint &p1, const SpacePoint &p2, const Tensor &tensor) const override
 Return the distance between two space points with the given tensor. More...
 
double getDistance1D (const SpacePoint &p1, const SpacePoint &p2, int idim=0) const override
 Return the distance along one direction between two space points. More...
 
double getFrequentialDistance (const SpacePoint &p1, const SpacePoint &p2, const Tensor &tensor) const override
 Return the distance in frequential domain between two space points with the given tensor. More...
 
VectorDouble getIncrement (const SpacePoint &p1, const SpacePoint &p2) const override
 Return the increment vector between two space points for the current space context. More...
 
- Public Member Functions inherited from ASpace
 ASpace (unsigned int ndim)
 
 ASpace (const ASpace &r)
 
ASpaceoperator= (const ASpace &r)
 
virtual ~ASpace ()
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 
void setOrigin (const VectorDouble &origin)
 Update the origin coordinates. More...
 
unsigned int getNDim () const
 Get the number of dimensions. More...
 
const VectorDoublegetOrigin () const
 Return the space origin coordinates. More...
 
virtual bool isEqual (const ASpace *space) const
 Return true if the given space is equal to me. More...
 
void _getIncrementInPlaceVect (const SpacePoint &p1, const std::vector< SpacePoint > &pv, VectorVectorDouble &res) const
 
- Public Member Functions inherited from AStringable
 AStringable ()
 
 AStringable (const AStringable &r)
 
AStringableoperator= (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 ICloneableclone () const =0
 

Static Public Member Functions

static SpaceRNcreate (unsigned int ndim)
 ICloneable interface. More...
 

Private Member Functions

void _getIncrementInPlace (const SpacePoint &p1, const SpacePoint &p2, VectorDouble &ptemp) const override
 

Additional Inherited Members

- Protected Attributes inherited from ASpace
unsigned int _nDim
 Number of space dimensions. More...
 
VectorDouble _origin
 Coordinates of the origin (not a space point... ex: sphere center in a long/lat space) More...
 
VectorDouble _work1
 
VectorDouble _work2
 

Constructor & Destructor Documentation

◆ SpaceRN() [1/2]

SpaceRN::SpaceRN ( unsigned int  ndim)

◆ SpaceRN() [2/2]

SpaceRN::SpaceRN ( const SpaceRN r)

◆ ~SpaceRN()

SpaceRN::~SpaceRN ( )
virtual

Member Function Documentation

◆ _getIncrementInPlace()

void SpaceRN::_getIncrementInPlace ( const SpacePoint p1,
const SpacePoint p2,
VectorDouble ptemp 
) const
overrideprivatevirtual

Reimplemented from ASpace.

◆ create()

SpaceRN * SpaceRN::create ( unsigned int  ndim)
static

ICloneable interface.

◆ getDistance() [1/2]

double SpaceRN::getDistance ( const SpacePoint p1,
const SpacePoint p2 
) const
overridevirtual

Return the distance between two space points.

Return the distance between two space points in RN Space The distance between $p1=(x_1,y_1)$ and $p2=(x_2,y_2)$ is $\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}$.

Parameters
[in]p1First point
[in]p2Second point
Returns
The distance between p1 and p2

Implements ASpace.

◆ getDistance() [2/2]

double SpaceRN::getDistance ( const SpacePoint p1,
const SpacePoint p2,
const Tensor tensor 
) const
overridevirtual

Return the distance between two space points with the given tensor.

Implements ASpace.

◆ getDistance1D()

double SpaceRN::getDistance1D ( const SpacePoint p1,
const SpacePoint p2,
int  idim = 0 
) const
overridevirtual

Return the distance along one direction between two space points.

Implements ASpace.

◆ getFrequentialDistance()

double SpaceRN::getFrequentialDistance ( const SpacePoint p1,
const SpacePoint p2,
const Tensor tensor 
) const
overridevirtual

Return the distance in frequential domain between two space points with the given tensor.

Implements ASpace.

◆ getIncrement()

VectorDouble SpaceRN::getIncrement ( const SpacePoint p1,
const SpacePoint p2 
) const
overridevirtual

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

Implements ASpace.

◆ getType()

ESpaceType SpaceRN::getType ( ) const
inlineoverridevirtual

Return the concrete space type.

Implements ASpace.

◆ move()

void SpaceRN::move ( SpacePoint p1,
const VectorDouble vec 
) const
overridevirtual

Move the given space point by the given vector.

Implements ASpace.

◆ operator=()

SpaceRN & SpaceRN::operator= ( const SpaceRN r)

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