DGtal::SignedKhalimskyCell< dim, TInteger > Struct Template Reference

#include <KhalimskySpaceND.h>

Collaboration diagram for DGtal::SignedKhalimskyCell< dim, TInteger >:

Public Types
typedef TInteger	Integer
typedef NumberTraits< Integer > ::UnsignedVersion	UnsignedInteger
typedef PointVector< dim, Integer >	Point

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CInteger< TInteger >))
	BOOST_CONCEPT_ASSERT ((CSignedInteger< TInteger >))
	SignedKhalimskyCell ()
	SignedKhalimskyCell (const SignedKhalimskyCell &other)
	SignedKhalimskyCell (const Point &point, bool positive)
SignedKhalimskyCell &	operator= (const SignedKhalimskyCell &other)
bool	operator== (const SignedKhalimskyCell &other) const
bool	operator!= (const SignedKhalimskyCell &other) const
bool	operator< (const SignedKhalimskyCell &other) const
std::string	className () const

Data Fields
Point	myCoordinates
bool	myPositive

---

Detailed Description

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

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

Examples:

topology/ctopo-1s-3d.cpp, topology/ctopo-2-3d.cpp, and topology/ctopo-2.cpp.

Definition at line 168 of file KhalimskySpaceND.h.

---

Member Typedef Documentation

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

typedef TInteger DGtal::SignedKhalimskyCell< dim, TInteger >::Integer

Definition at line 176 of file KhalimskySpaceND.h.

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

typedef PointVector< dim, Integer > DGtal::SignedKhalimskyCell< dim, TInteger >::Point

Definition at line 178 of file KhalimskySpaceND.h.

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

typedef NumberTraits<Integer>::UnsignedVersion DGtal::SignedKhalimskyCell< dim, TInteger >::UnsignedInteger

Definition at line 177 of file KhalimskySpaceND.h.

---

Constructor & Destructor Documentation

template<Dimension dim, typename TInteger >

DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( )

inline

Constructor.

Definition at line 153 of file KhalimskySpaceND.ih.

{
}

template<Dimension dim, typename TInteger >

DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( const SignedKhalimskyCell< dim, TInteger > &  other )

inline

Copy constructor.

Parameters:

other

any other cell.

Definition at line 160 of file KhalimskySpaceND.ih.

  : myCoordinates( other.myCoordinates), myPositive( other.myPositive )
{
}

template<Dimension dim, typename TInteger >

DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( const Point &  point, bool  positive  )

inline

constructor from point.

Parameters:

other	any point.
'true'	if cell has positive sign.

Definition at line 168 of file KhalimskySpaceND.ih.

  : myCoordinates( p ), myPositive( positive )
{
}

---

Member Function Documentation

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

DGtal::SignedKhalimskyCell< dim, TInteger >::BOOST_CONCEPT_ASSERT

(

(CInteger< TInteger >)

)

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

DGtal::SignedKhalimskyCell< dim, TInteger >::BOOST_CONCEPT_ASSERT

(

(CSignedInteger< TInteger >)

)

template<Dimension dim, typename TInteger >

std::string DGtal::SignedKhalimskyCell< dim, TInteger >::className ( ) const

inline

Default drawing style object.

Returns:

the dyn. alloc. default style for this object.

the style name used for drawing this object.

Definition at line 238 of file KhalimskySpaceND.ih.

Referenced by DGtal::Display3DFactory::draw().

{
  return "SignedKhalimskyCell";
}

template<Dimension dim, typename TInteger >

bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator!= ( const SignedKhalimskyCell< dim, TInteger > &  other ) const

inline

Difference operator.

Parameters:

other

any other cell.

Definition at line 201 of file KhalimskySpaceND.ih.

References DGtal::SignedKhalimskyCell< dim, TInteger >::myCoordinates, and DGtal::SignedKhalimskyCell< dim, TInteger >::myPositive.

{
  return ( myPositive != other.myPositive )
    || ( myCoordinates != other.myCoordinates );
}

template<Dimension dim, typename TInteger >

bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator< ( const SignedKhalimskyCell< dim, TInteger > &  other ) const

inline

Inferior operator. (lexicographic order).

Parameters:

other

any other cell.

Definition at line 211 of file KhalimskySpaceND.ih.

References DGtal::SignedKhalimskyCell< dim, TInteger >::myCoordinates, and DGtal::SignedKhalimskyCell< dim, TInteger >::myPositive.

{
  return ( myPositive < other.myPositive )
    || ( ( myPositive == other.myPositive )
   && ( myCoordinates < other.myCoordinates ) );
}

template<Dimension dim, typename TInteger >

DGtal::SignedKhalimskyCell< dim, TInteger > & DGtal::SignedKhalimskyCell< dim, TInteger >::operator= ( const SignedKhalimskyCell< dim, TInteger > &  other )

inline

Copy constructor.

Parameters:

other

any other cell.

Definition at line 177 of file KhalimskySpaceND.ih.

References DGtal::SignedKhalimskyCell< dim, TInteger >::myCoordinates, and DGtal::SignedKhalimskyCell< dim, TInteger >::myPositive.

{
  if ( this != &other )
    {
      myCoordinates = other.myCoordinates;
      myPositive = other.myPositive;
    }
  return *this;
}

template<Dimension dim, typename TInteger >

bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator== ( const SignedKhalimskyCell< dim, TInteger > &  other ) const

inline

Equality operator.

Parameters:

other

any other cell.

Definition at line 191 of file KhalimskySpaceND.ih.

References DGtal::SignedKhalimskyCell< dim, TInteger >::myCoordinates, and DGtal::SignedKhalimskyCell< dim, TInteger >::myPositive.

{
  return ( myPositive == other.myPositive )
    && ( myCoordinates == other.myCoordinates );
}

---

Field Documentation

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

Point DGtal::SignedKhalimskyCell< dim, TInteger >::myCoordinates

Definition at line 180 of file KhalimskySpaceND.h.

Referenced by DGtal::Display3DFactory::draw(), DGtal::Display2DFactory::draw(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator!=(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator<(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator=(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator==(), DGtal::KhalimskySpaceND< dim, TInteger >::sCell(), DGtal::KhalimskySpaceND< dim, TInteger >::sCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::sCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::sDim(), DGtal::KhalimskySpaceND< dim, TInteger >::sDirectIncident(), DGtal::KhalimskySpaceND< dim, TInteger >::sDistanceToMax(), DGtal::KhalimskySpaceND< dim, TInteger >::sDistanceToMin(), DGtal::KhalimskySpaceND< dim, TInteger >::sGetAdd(), DGtal::KhalimskySpaceND< dim, TInteger >::sGetDecr(), DGtal::KhalimskySpaceND< dim, TInteger >::sGetIncr(), DGtal::KhalimskySpaceND< dim, TInteger >::sGetSub(), DGtal::KhalimskySpaceND< dim, TInteger >::sIncident(), DGtal::KhalimskySpaceND< dim, TInteger >::sIndirectIncident(), DGtal::KhalimskySpaceND< dim, TInteger >::sIsInside(), DGtal::KhalimskySpaceND< dim, TInteger >::sIsMax(), DGtal::KhalimskySpaceND< dim, TInteger >::sIsMin(), DGtal::KhalimskySpaceND< dim, TInteger >::sIsOpen(), DGtal::KhalimskySpaceND< dim, TInteger >::sKCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::sKCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::sNext(), DGtal::KhalimskySpaceND< dim, TInteger >::sOpp(), DGtal::KhalimskySpaceND< dim, TInteger >::sPointel(), DGtal::KhalimskySpaceND< dim, TInteger >::sProject(), DGtal::KhalimskySpaceND< dim, TInteger >::sProjection(), DGtal::KhalimskySpaceND< dim, TInteger >::sSetCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::sSetCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::sSetKCoord(), DGtal::KhalimskySpaceND< dim, TInteger >::sSetKCoords(), DGtal::KhalimskySpaceND< dim, TInteger >::sSpel(), DGtal::KhalimskySpaceND< dim, TInteger >::sTopology(), DGtal::KhalimskySpaceND< dim, TInteger >::sTranslation(), DGtal::TransformedKSSurfel::TransformedKSSurfel(), and DGtal::KhalimskySpaceND< dim, TInteger >::unsigns().

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

bool DGtal::SignedKhalimskyCell< dim, TInteger >::myPositive

Definition at line 181 of file KhalimskySpaceND.h.

Referenced by DGtal::Display3DFactory::draw(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator!=(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator<(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator=(), DGtal::SignedKhalimskyCell< dim, TInteger >::operator==(), DGtal::KhalimskySpaceND< dim, TInteger >::sCell(), DGtal::KhalimskySpaceND< dim, TInteger >::sDirect(), DGtal::KhalimskySpaceND< dim, TInteger >::sDirectIncident(), DGtal::KhalimskySpaceND< dim, TInteger >::sIncident(), DGtal::KhalimskySpaceND< dim, TInteger >::sIndirectIncident(), DGtal::KhalimskySpaceND< dim, TInteger >::sOpp(), DGtal::KhalimskySpaceND< dim, TInteger >::sSetSign(), and DGtal::KhalimskySpaceND< dim, TInteger >::sSign().

---

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

• KhalimskySpaceND.h
• KhalimskySpaceND.ih