1.5.1
CCC
 
SpaceSN Class Reference

#include <SpaceSN.hpp>

Inheritance diagram for SpaceSN:
ASpace AStringable ICloneable

Public Member Functions

 SpaceSN (unsigned int ndim, double radius)
 
 SpaceSN (const SpaceSN &r)
 
SpaceSNoperator= (const SpaceSN &r)
 
virtual ~SpaceSN ()
 
ESpaceType getType () const override
 ICloneable interface. More...
 
double getRadius () const
 Return the sphere radius. More...
 
virtual String toString (const AStringFormat *strfmt, int idx=-1) const override
 Dump a space in a string. More...
 
virtual bool isEqual (const ASpace *space) const override
 Return true if the given space is equal to me. More...
 
- Public Member Functions inherited from ASpace
 ASpace (unsigned int ndim)
 
 ASpace (const ASpace &r)
 
ASpaceoperator= (const ASpace &r)
 
virtual ~ASpace ()
 
String toString (const AStringFormat *strfmt=nullptr) const final
 Interface for AStringable. More...
 
virtual void setOrigin (const VectorDouble &origin)
 Update the origin of the space. More...
 
virtual unsigned int getNDim (int ispace=-1) const
 Get the number of dimensions. More...
 
virtual unsigned int getOffset (int ispace=-1) const
 Get the offset index for coordinates. More...
 
virtual const VectorDoublegetOrigin (int ispace=-1) const
 Return the space origin coordinates. More...
 
virtual unsigned int getNComponents () const
 Get the number of space components. More...
 
virtual const ASpacegetComponent (int ispace=-1) const
 Return the space component at index ispace. More...
 
virtual VectorDouble getDistances (const SpacePoint &p1, const SpacePoint &p2) const
 Return all the distances (one by space component) between two space points. More...
 
void move (SpacePoint &p1, const VectorDouble &vec) const
 Not to be overriden. More...
 
double getDistance (const SpacePoint &p1, const SpacePoint &p2, int ispace=-1) const
 Return the distance between two space points. More...
 
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. More...
 
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. More...
 
VectorDouble getIncrement (const SpacePoint &p1, const SpacePoint &p2, int ispace=-1) const
 Return the increment vector between two space points. More...
 
virtual VectorDouble projCoord (const VectorDouble &coord, int ispace=-1) const
 Project the coordinates in the given space. More...
 
void setOffset (unsigned int offset)
 Customize the dimension offset index of the current space TODO : to be made private. More...
 
- 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
 

Constructor & Destructor Documentation

◆ SpaceSN() [1/2]

SpaceSN::SpaceSN ( unsigned int  ndim,
double  radius 
)

◆ SpaceSN() [2/2]

SpaceSN::SpaceSN ( const SpaceSN r)

◆ ~SpaceSN()

SpaceSN::~SpaceSN ( )
virtual

Member Function Documentation

◆ getRadius()

double SpaceSN::getRadius ( ) const
inline

Return the sphere radius.

◆ getType()

ESpaceType SpaceSN::getType ( ) const
inlineoverridevirtual

ICloneable interface.

Return the concrete space type

Implements ASpace.

◆ isEqual()

bool SpaceSN::isEqual ( const ASpace space) const
overridevirtual

Return true if the given space is equal to me.

Reimplemented from ASpace.

◆ operator=()

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

◆ toString()

String SpaceSN::toString ( const AStringFormat strfmt,
int  idx = -1 
) const
overridevirtual

Dump a space in a string.

Reimplemented from ASpace.


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