Simulacrum  1.2
Public Types | Public Member Functions | List of all members
Simulacrum::SCoordinate Class Reference

#include <sprimitives.h>

Collaboration diagram for Simulacrum::SCoordinate:
Collaboration graph

Public Types

typedef BaseIntSign Precision
 

Public Member Functions

 SCoordinate ()
 
 SCoordinate (SCoordinate::Precision)
 
 SCoordinate (const SCoordinate &)
 
 SCoordinate (std::initializer_list< SCoordinate::Precision >)
 
 ~SCoordinate ()
 
void reset ()
 
SCoordinate::Precision getDim () const
 
void setDim (SCoordinate::Precision)
 
SCoordinate::Precision popDim ()
 
void promote ()
 
SCoordinate::Precision getCoord (SCoordinate::Precision) const
 
void setCoord (SCoordinate::Precision, SCoordinate::Precision)
 
void append (const SCoordinate &)
 
SCoordinate::Precision volume () const
 
SCoordinate::Precision toLinear (const SCoordinate &constraint) const
 
void fromLinear (SCoordinate::Precision, const SCoordinate &constraint)
 
std::string toString () const
 
bool tabincrement (const SCoordinate &)
 
bool tabdecrement (const SCoordinate &)
 
SCoordinate::Precision x () const
 
SCoordinatex (SCoordinate::Precision)
 
SCoordinate::Precision y () const
 
SCoordinatey (SCoordinate::Precision)
 
SCoordinate::Precision z () const
 
SCoordinatez (SCoordinate::Precision)
 
SCoordinate::Precision t () const
 
SCoordinatet (SCoordinate::Precision)
 
SCoordinatexy (SCoordinate::Precision, SCoordinate::Precision)
 
SCoordinatexyz (SCoordinate::Precision, SCoordinate::Precision, SCoordinate::Precision)
 
SCoordinate::Precisionoperator[] (const SCoordinate::Precision)
 
const SCoordinate::Precisionoperator[] (const SCoordinate::Precision) const
 
SCoordinateoperator= (const SCoordinate &)
 
SCoordinateoperator+= (const SCoordinate &)
 
SCoordinateoperator-= (const SCoordinate &)
 
SCoordinateoperator*= (const SCoordinate &)
 
SCoordinate operator+ (const SCoordinate &) const
 
SCoordinate operator- (const SCoordinate &) const
 
SCoordinate operator* (const SCoordinate &) const
 
bool operator== (const SCoordinate &) const
 
bool operator!= (const SCoordinate &) const
 
SCoordinateclamp_floor (const SVector &)
 
SCoordinateclamp_ceiling (const SVector &)
 
SCoordinateclamp_round (const SVector &)
 
bool withinSpace (const SCoordinate &) const
 
std::vector< SCoordinate::PrecisionprecalcLinearIndices () const
 
SCoordinate::Precision toLinear (const std::vector< SCoordinate::Precision > &) const
 
std::vector< std::pair< SCoordinate, SCoordinate > > decompose (const SCoordinate &) const
 

Member Typedef Documentation

◆ Precision

Constructor & Destructor Documentation

◆ SCoordinate() [1/4]

SCoordinate::SCoordinate ( )

◆ SCoordinate() [2/4]

SCoordinate::SCoordinate ( SCoordinate::Precision  dims)

◆ SCoordinate() [3/4]

SCoordinate::SCoordinate ( const SCoordinate rhs)

◆ SCoordinate() [4/4]

SCoordinate::SCoordinate ( std::initializer_list< SCoordinate::Precision coordlist)

◆ ~SCoordinate()

SCoordinate::~SCoordinate ( )

Member Function Documentation

◆ append()

void SCoordinate::append ( const SCoordinate newcoord)

◆ clamp_ceiling()

SCoordinate & SCoordinate::clamp_ceiling ( const SVector source)

◆ clamp_floor()

SCoordinate & SCoordinate::clamp_floor ( const SVector source)

◆ clamp_round()

SCoordinate & SCoordinate::clamp_round ( const SVector source)

◆ decompose()

std::vector< std::pair< SCoordinate, SCoordinate > > SCoordinate::decompose ( const SCoordinate dsize) const

◆ fromLinear()

void SCoordinate::fromLinear ( SCoordinate::Precision  lin,
const SCoordinate constraint 
)

◆ getCoord()

SCoordinate::Precision SCoordinate::getCoord ( SCoordinate::Precision  dim) const

◆ getDim()

SCoordinate::Precision SCoordinate::getDim ( ) const

◆ operator!=()

bool SCoordinate::operator!= ( const SCoordinate rhs) const

◆ operator*()

SCoordinate SCoordinate::operator* ( const SCoordinate rhs) const

◆ operator*=()

SCoordinate & SCoordinate::operator*= ( const SCoordinate rhs)

◆ operator+()

SCoordinate SCoordinate::operator+ ( const SCoordinate rhs) const

◆ operator+=()

SCoordinate & SCoordinate::operator+= ( const SCoordinate rhs)

◆ operator-()

SCoordinate SCoordinate::operator- ( const SCoordinate rhs) const

◆ operator-=()

SCoordinate & SCoordinate::operator-= ( const SCoordinate rhs)

◆ operator=()

SCoordinate & SCoordinate::operator= ( const SCoordinate rhs)

◆ operator==()

bool SCoordinate::operator== ( const SCoordinate rhs) const

◆ operator[]() [1/2]

SCoordinate::Precision & SCoordinate::operator[] ( const SCoordinate::Precision  index)

◆ operator[]() [2/2]

const SCoordinate::Precision & SCoordinate::operator[] ( const SCoordinate::Precision  index) const

◆ popDim()

SCoordinate::Precision SCoordinate::popDim ( )

◆ precalcLinearIndices()

std::vector< SCoordinate::Precision > SCoordinate::precalcLinearIndices ( ) const

◆ promote()

void SCoordinate::promote ( )

◆ reset()

void SCoordinate::reset ( )

◆ setCoord()

void SCoordinate::setCoord ( SCoordinate::Precision  dim,
SCoordinate::Precision  loc 
)

◆ setDim()

void SCoordinate::setDim ( SCoordinate::Precision  newdims)

◆ t() [1/2]

SCoordinate::Precision SCoordinate::t ( ) const

◆ t() [2/2]

SCoordinate & SCoordinate::t ( SCoordinate::Precision  newt)

◆ tabdecrement()

bool SCoordinate::tabdecrement ( const SCoordinate constraint)

◆ tabincrement()

bool SCoordinate::tabincrement ( const SCoordinate constraint)

◆ toLinear() [1/2]

SCoordinate::Precision SCoordinate::toLinear ( const SCoordinate constraint) const

◆ toLinear() [2/2]

SCoordinate::Precision SCoordinate::toLinear ( const std::vector< SCoordinate::Precision > &  indiccache) const

◆ toString()

std::string SCoordinate::toString ( ) const

◆ volume()

SCoordinate::Precision SCoordinate::volume ( ) const

◆ withinSpace()

bool SCoordinate::withinSpace ( const SCoordinate coordref) const

◆ x() [1/2]

SCoordinate::Precision SCoordinate::x ( ) const

◆ x() [2/2]

SCoordinate & SCoordinate::x ( SCoordinate::Precision  newx)

◆ xy()

SCoordinate & SCoordinate::xy ( SCoordinate::Precision  x1,
SCoordinate::Precision  y1 
)

◆ xyz()

◆ y() [1/2]

SCoordinate::Precision SCoordinate::y ( ) const

◆ y() [2/2]

SCoordinate & SCoordinate::y ( SCoordinate::Precision  newy)

◆ z() [1/2]

SCoordinate::Precision SCoordinate::z ( ) const

◆ z() [2/2]

SCoordinate & SCoordinate::z ( SCoordinate::Precision  newz)

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