DGtal  1.5.beta
Public Types | Public Member Functions | Data Fields
DGtal::SignedKhalimskyPreCell< dim, TInteger > Struct Template Reference

Represents a signed cell in an unbounded cellular grid space by its Khalimsky coordinates and a boolean value. More...

#include <DGtal/topology/KhalimskyPreSpaceND.h>

Inheritance diagram for DGtal::SignedKhalimskyPreCell< dim, TInteger >:
[legend]

Public Types

using Integer = TInteger
 
using UnsignedInteger = typename NumberTraits< Integer >::UnsignedVersion
 
using Point = PointVector< dim, Integer >
 
using Self = SignedKhalimskyPreCell< dim, Integer >
 
using SPreCell = Self
 
using PreCellularGridSpace = KhalimskyPreSpaceND< dim, TInteger >
 
using CellularGridSpace = PreCellularGridSpace
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CInteger< TInteger >))
 
SPreCell const & preCell () const
 Returns the underlying constant pre-cell, itself in fact. More...
 
 SignedKhalimskyPreCell (Integer dummy=0)
 Default constructor. More...
 
 SignedKhalimskyPreCell (Point const &aPoint, bool positive)
 Implicit constructor from its Khalimsky coordinates. More...
 
 SignedKhalimskyPreCell (SignedKhalimskyPreCell const &aCell)=default
 Copy constructor. More...
 
SignedKhalimskyPreCell & operator= (SignedKhalimskyPreCell const &aCell)=default
 Copy operator. More...
 
 SignedKhalimskyPreCell (SignedKhalimskyPreCell &&aCell)=default
 Move constructor. More...
 
SignedKhalimskyPreCell & operator= (SignedKhalimskyPreCell &&aCell)=default
 Move operator. More...
 
bool operator== (const SignedKhalimskyPreCell &other) const
 Equality operator. More...
 
bool operator!= (const SignedKhalimskyPreCell &other) const
 Difference operator. More...
 
bool operator< (const SignedKhalimskyPreCell &other) const
 Inferior operator. (lexicographic order). More...
 
std::string className () const
 Return the style name used for drawing this object. More...
 

Data Fields

Point coordinates
 Khalimsky coordinates of the cell. More...
 
bool positive
 Cell sign. More...
 

Detailed Description

template<Dimension dim, typename TInteger = DGtal::int32_t>
struct DGtal::SignedKhalimskyPreCell< dim, TInteger >

Represents a signed cell in an unbounded cellular grid space by its Khalimsky coordinates and a boolean value.

Template Parameters
dimthe dimension of the digital space.
TIntegerthe Integer class used to specify the arithmetic computations (default type = int32).

Definition at line 169 of file KhalimskyPreSpaceND.h.

Member Typedef Documentation

◆ CellularGridSpace

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyPreCell< dim, TInteger >::CellularGridSpace = PreCellularGridSpace

Definition at line 183 of file KhalimskyPreSpaceND.h.

◆ Integer

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyPreCell< dim, TInteger >::Integer = TInteger

Definition at line 177 of file KhalimskyPreSpaceND.h.

◆ Point

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyPreCell< dim, TInteger >::Point = PointVector< dim, Integer >

Definition at line 179 of file KhalimskyPreSpaceND.h.

◆ PreCellularGridSpace

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyPreCell< dim, TInteger >::PreCellularGridSpace = KhalimskyPreSpaceND< dim, TInteger >

Definition at line 182 of file KhalimskyPreSpaceND.h.

◆ Self

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyPreCell< dim, TInteger >::Self = SignedKhalimskyPreCell< dim, Integer >

Definition at line 180 of file KhalimskyPreSpaceND.h.

◆ SPreCell

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyPreCell< dim, TInteger >::SPreCell = Self

Definition at line 181 of file KhalimskyPreSpaceND.h.

◆ UnsignedInteger

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyPreCell< dim, TInteger >::UnsignedInteger = typename NumberTraits<Integer>::UnsignedVersion

Definition at line 178 of file KhalimskyPreSpaceND.h.

Constructor & Destructor Documentation

◆ SignedKhalimskyPreCell() [1/4]

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyPreCell< dim, TInteger >::SignedKhalimskyPreCell ( Integer  dummy = 0)
explicit

Default constructor.

◆ SignedKhalimskyPreCell() [2/4]

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyPreCell< dim, TInteger >::SignedKhalimskyPreCell ( Point const &  aPoint,
bool  positive 
)

Implicit constructor from its Khalimsky coordinates.

Parameters
aPointIts Khalimsky coordinates as a point.
positiveif cell has positive sign.

◆ SignedKhalimskyPreCell() [3/4]

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyPreCell< dim, TInteger >::SignedKhalimskyPreCell ( SignedKhalimskyPreCell< dim, TInteger > const &  aCell)
default

Copy constructor.

Parameters
aCellany other pre-cell.

◆ SignedKhalimskyPreCell() [4/4]

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyPreCell< dim, TInteger >::SignedKhalimskyPreCell ( SignedKhalimskyPreCell< dim, TInteger > &&  aCell)
default

Move constructor.

Parameters
aCellany other pre-cell.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyPreCell< dim, TInteger >::BOOST_CONCEPT_ASSERT ( (concepts::CInteger< TInteger >)  )

◆ className()

template<Dimension dim, typename TInteger = DGtal::int32_t>
std::string DGtal::SignedKhalimskyPreCell< dim, TInteger >::className ( ) const

Return the style name used for drawing this object.

Returns
the style name used for drawing this object.

◆ operator!=()

template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::SignedKhalimskyPreCell< dim, TInteger >::operator!= ( const SignedKhalimskyPreCell< dim, TInteger > &  other) const

Difference operator.

Parameters
otherany other pre-cell.

◆ operator<()

template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::SignedKhalimskyPreCell< dim, TInteger >::operator< ( const SignedKhalimskyPreCell< dim, TInteger > &  other) const

Inferior operator. (lexicographic order).

Parameters
otherany other pre-cell.

◆ operator=() [1/2]

template<Dimension dim, typename TInteger = DGtal::int32_t>
SignedKhalimskyPreCell& DGtal::SignedKhalimskyPreCell< dim, TInteger >::operator= ( SignedKhalimskyPreCell< dim, TInteger > &&  aCell)
default

Move operator.

Parameters
aCellany other pre-cell.

◆ operator=() [2/2]

template<Dimension dim, typename TInteger = DGtal::int32_t>
SignedKhalimskyPreCell& DGtal::SignedKhalimskyPreCell< dim, TInteger >::operator= ( SignedKhalimskyPreCell< dim, TInteger > const &  aCell)
default

Copy operator.

Parameters
aCellany other pre-cell.

◆ operator==()

template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::SignedKhalimskyPreCell< dim, TInteger >::operator== ( const SignedKhalimskyPreCell< dim, TInteger > &  other) const

Equality operator.

Parameters
otherany other pre-cell.

◆ preCell()

template<Dimension dim, typename TInteger = DGtal::int32_t>
SPreCell const& DGtal::SignedKhalimskyPreCell< dim, TInteger >::preCell ( ) const

Returns the underlying constant pre-cell, itself in fact.

Field Documentation

◆ coordinates

template<Dimension dim, typename TInteger = DGtal::int32_t>
Point DGtal::SignedKhalimskyPreCell< dim, TInteger >::coordinates

Khalimsky coordinates of the cell.

Definition at line 187 of file KhalimskyPreSpaceND.h.

◆ positive

template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::SignedKhalimskyPreCell< dim, TInteger >::positive

Cell sign.

Definition at line 188 of file KhalimskyPreSpaceND.h.

Referenced by std::hash< DGtal::SignedKhalimskyCell< dim, TInteger > >::operator()(), and boost::hash< DGtal::SignedKhalimskyCell< dim, TInteger > >::operator()().

The documentation for this struct was generated from the following file: