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

Represents an unsigned cell in an unbounded cellular grid space by its Khalimsky coordinates. More...

#include <DGtal/topology/KhalimskyPreSpaceND.h>

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

Public Types

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

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CInteger< TInteger >))
 Integer must be a model of the concept CInteger. More...
 
PreCell const & preCell () const
 Returns the underlying constant pre-cell, itself in fact. More...
 
 KhalimskyPreCell (Integer dummy=0)
 Default constructor. More...
 
 KhalimskyPreCell (Point const &aPoint)
 Implicit constructor from its Khalimsky coordinates. More...
 
 KhalimskyPreCell (KhalimskyPreCell const &aCell)=default
 Copy constructor. More...
 
KhalimskyPreCelloperator= (KhalimskyPreCell const &aCell)=default
 Copy operator. More...
 
 KhalimskyPreCell (KhalimskyPreCell &&aCell)=default
 Move constructor. More...
 
KhalimskyPreCelloperator= (KhalimskyPreCell &&aCell)=default
 Move operator. More...
 
bool operator== (const KhalimskyPreCell &other) const
 Equality operator. More...
 
bool operator!= (const KhalimskyPreCell &other) const
 Difference operator. More...
 
bool operator< (const KhalimskyPreCell &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. Public to allow easy coordinate manipulations. More...
 

Detailed Description

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

Represents an unsigned cell in an unbounded cellular grid space by its Khalimsky coordinates.

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

Definition at line 72 of file KhalimskyPreSpaceND.h.

Member Typedef Documentation

◆ CellularGridSpace

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

Definition at line 86 of file KhalimskyPreSpaceND.h.

◆ Integer

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

Definition at line 80 of file KhalimskyPreSpaceND.h.

◆ Point

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

Definition at line 82 of file KhalimskyPreSpaceND.h.

◆ PreCell

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyPreCell< dim, TInteger >::PreCell = Self

Definition at line 84 of file KhalimskyPreSpaceND.h.

◆ PreCellularGridSpace

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

Definition at line 85 of file KhalimskyPreSpaceND.h.

◆ Self

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

Definition at line 83 of file KhalimskyPreSpaceND.h.

◆ UnsignedInteger

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

Definition at line 81 of file KhalimskyPreSpaceND.h.

Constructor & Destructor Documentation

◆ KhalimskyPreCell() [1/4]

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

Default constructor.

◆ KhalimskyPreCell() [2/4]

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

Implicit constructor from its Khalimsky coordinates.

Parameters
aPointIts Khalimsky coordinates as a point.

◆ KhalimskyPreCell() [3/4]

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

Copy constructor.

Parameters
aCellany other pre-cell.

◆ KhalimskyPreCell() [4/4]

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyPreCell< dim, TInteger >::KhalimskyPreCell ( KhalimskyPreCell< 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::KhalimskyPreCell< dim, TInteger >::BOOST_CONCEPT_ASSERT ( (concepts::CInteger< TInteger >)  )

Integer must be a model of the concept CInteger.

◆ className()

template<Dimension dim, typename TInteger = DGtal::int32_t>
std::string DGtal::KhalimskyPreCell< 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::KhalimskyPreCell< dim, TInteger >::operator!= ( const KhalimskyPreCell< dim, TInteger > &  other) const

Difference operator.

Parameters
otherany other pre-cell.

◆ operator<()

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

Inferior operator. (lexicographic order).

Parameters
otherany other pre-cell.

◆ operator=() [1/2]

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

Move operator.

Parameters
aCellany other pre-cell.

◆ operator=() [2/2]

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

Copy operator.

Parameters
aCellany other pre-cell.

◆ operator==()

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

Equality operator.

Parameters
otherany other pre-cell.

◆ preCell()

template<Dimension dim, typename TInteger = DGtal::int32_t>
PreCell const& DGtal::KhalimskyPreCell< 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::KhalimskyPreCell< dim, TInteger >::coordinates

Khalimsky coordinates of the cell. Public to allow easy coordinate manipulations.

Definition at line 90 of file KhalimskyPreSpaceND.h.


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