DGtal::HyperRectDomain< TSpace >::ConstSubRange Struct Reference

#include <HyperRectDomain.h>

Collaboration diagram for DGtal::HyperRectDomain< TSpace >::ConstSubRange:

Public Types
typedef HyperRectDomain_subIterator < Point >	ConstIterator
typedef myreverse_iterator < ConstIterator >	ConstReverseIterator

Public Member Functions
	ConstSubRange (const HyperRectDomain< TSpace > &domain, const std::vector< Dimension > &permutation, const Point &startingPoint)
	ConstSubRange (const HyperRectDomain< TSpace > &domain, Dimension adim, const Point &startingPoint)
	ConstSubRange (const HyperRectDomain< TSpace > &domain, Dimension adim1, Dimension adim2, const Point &startingPoint)
	ConstSubRange (const HyperRectDomain< TSpace > &domain, Dimension adim1, Dimension adim2, Dimension adim3, const Point &startingPoint)
ConstIterator	begin () const
ConstIterator	begin (const Point &aPoint) const
ConstIterator	end () const
ConstReverseIterator	rbegin () const
ConstReverseIterator	rbegin (const Point &aPoint) const
ConstReverseIterator	rend () const

Private Attributes
Point	myLowerBound
Point	myUpperBound
Point	myStartingPoint
std::vector< Dimension >	myPermutation

---

Detailed Description

template<typename TSpace>
struct DGtal::HyperRectDomain< TSpace >::ConstSubRange

Aim: range through some subdomain of all the points in the domain. Defines a constructor taking a domain in parameter plus some additional parameters to specify the subdomain, begin and end methods returning ConstIterator, and rbegin and rend methods returning ConstReverseIterator.

Description of class 'ConstSubRange'

Definition at line 216 of file HyperRectDomain.h.

---

Member Typedef Documentation

template<typename TSpace>

typedef HyperRectDomain_subIterator<Point> DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstIterator

Definition at line 218 of file HyperRectDomain.h.

template<typename TSpace>

typedef myreverse_iterator<ConstIterator> DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstReverseIterator

Definition at line 219 of file HyperRectDomain.h.

---

Constructor & Destructor Documentation

template<typename TSpace>

DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange ( const HyperRectDomain< TSpace > &  domain, const std::vector< Dimension > &  permutation, const Point &  startingPoint  )

inline

ConstSubRange constructor from a given domain.

Parameters:

domain	the domain.
permutation	a vector containing the dimensions used for the subrange. Dimensions are iterated in the given order.
startingPoint	the initial point.

Precondition:

startingPoint must belong to the range.

Definition at line 229 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myStartingPoint, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound, and DGtal::PointVector< dim, TEuclideanRing >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
      {
        myPermutation.reserve( permutation.size() );
        std::copy(permutation.begin(),permutation.end(),
                  std::back_inserter(myPermutation));
        myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
        myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
      }

template<typename TSpace>

DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange ( const HyperRectDomain< TSpace > &  domain, Dimension  adim, const Point &  startingPoint  )

inline

ConstSubRange constructor from a given domain for one dimension.

Parameters:

domain	the domain.
adim	the dimension used for the subrange.
startingPoint	the initial point.

Precondition:

startingPoint must belong to the range.

Definition at line 277 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myStartingPoint, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound, and DGtal::PointVector< dim, TEuclideanRing >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
      {
        myPermutation.push_back( adim );
        myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
        myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
      }

template<typename TSpace>

DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange ( const HyperRectDomain< TSpace > &  domain, Dimension  adim1, Dimension  adim2, const Point &  startingPoint  )

inline

ConstSubRange constructor from a given domain for two dimensions.

Parameters:

domain	the domain.
adim1	the first dimension used for the subrange.
adim2	the second dimension used for the subrange.
startingPoint	the initial point.

Precondition:

startingPoint must belong to the range.

Definition at line 297 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myStartingPoint, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound, and DGtal::PointVector< dim, TEuclideanRing >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
      {
        myPermutation.push_back( adim1 );
        myPermutation.push_back( adim2 );
        myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
        myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
      }

template<typename TSpace>

DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange ( const HyperRectDomain< TSpace > &  domain, Dimension  adim1, Dimension  adim2, Dimension  adim3, const Point &  startingPoint  )

inline

ConstSubRange constructor from a given domain for two dimensions.

Parameters:

domain	the domain.
adim1	the first dimension used for the subrange.
adim2	the second dimension used for the subrange.
adim3	the third dimension used for the subrange.
startingPoint	the initial point.

Precondition:

startingPoint must belong to the range.

Definition at line 319 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myStartingPoint, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound, and DGtal::PointVector< dim, TEuclideanRing >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
      {
        myPermutation.push_back( adim1 );
        myPermutation.push_back( adim2 );
        myPermutation.push_back( adim3 );
        myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
        myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
      }

---

Member Function Documentation

template<typename TSpace>

ConstIterator DGtal::HyperRectDomain< TSpace >::ConstSubRange::begin ( ) const

inline

Definition at line 337 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation, and DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound.

Referenced by DGtal::DistanceTransformation< TSpace, TPointPredicate, p, IntegerLong >::computeFirstStep(), DGtal::VoronoiMap< TSpace, TPointPredicate, p >::computeOtherSteps(), DGtal::DistanceTransformation< TSpace, TPointPredicate, p, IntegerLong >::computeOtherSteps(), DGtal::HyperRectDomain< TSpace >::ConstSubRange::rbegin(), and DGtal::HyperRectDomain< TSpace >::ConstSubRange::rend().

      {  return ConstIterator(myLowerBound, myLowerBound,
                              myUpperBound, myPermutation); }

template<typename TSpace>

ConstIterator DGtal::HyperRectDomain< TSpace >::ConstSubRange::begin ( const Point &  aPoint ) const

inline

Definition at line 347 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound, and DGtal::PointVector< dim, TEuclideanRing >::partialEqualInv().

      { 
        ASSERT(aPoint.partialEqualInv(myLowerBound, myPermutation) );
        ASSERT(myLowerBound<=aPoint && aPoint<=myUpperBound);
        return ConstIterator(aPoint, myLowerBound,
                             myUpperBound, myPermutation);
      }

template<typename TSpace>

ConstIterator DGtal::HyperRectDomain< TSpace >::ConstSubRange::end ( ) const

inline

Definition at line 359 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound, DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation, and DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound.

Referenced by DGtal::DistanceTransformation< TSpace, TPointPredicate, p, IntegerLong >::computeFirstStep(), DGtal::VoronoiMap< TSpace, TPointPredicate, p >::computeOtherSteps(), DGtal::DistanceTransformation< TSpace, TPointPredicate, p, IntegerLong >::computeOtherSteps(), and DGtal::HyperRectDomain< TSpace >::ConstSubRange::rbegin().

      {
        ConstIterator it = ConstIterator(myUpperBound, myLowerBound,
                                         myUpperBound, myPermutation);
        ++it;
        return it;
      }

template<typename TSpace>

ConstReverseIterator DGtal::HyperRectDomain< TSpace >::ConstSubRange::rbegin ( ) const

inline

Definition at line 371 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::end().

      { return ConstReverseIterator(end()); }

template<typename TSpace>

ConstReverseIterator DGtal::HyperRectDomain< TSpace >::ConstSubRange::rbegin ( const Point &  aPoint ) const

inline

Definition at line 380 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::begin().

      { ConstIterator it(begin(aPoint)); ++it;
        return ConstReverseIterator(it); }

template<typename TSpace>

ConstReverseIterator DGtal::HyperRectDomain< TSpace >::ConstSubRange::rend ( ) const

inline

Definition at line 388 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::begin().

      { return ConstReverseIterator(begin()); }

---

Field Documentation

template<typename TSpace>

Point DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound

private

Lower bound of the subrange.

Definition at line 393 of file HyperRectDomain.h.

Referenced by DGtal::HyperRectDomain< TSpace >::ConstSubRange::begin(), DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange(), and DGtal::HyperRectDomain< TSpace >::ConstSubRange::end().

template<typename TSpace>

std::vector<Dimension> DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation

private

Permutation on dimensions used in the subrange.

Definition at line 399 of file HyperRectDomain.h.

Referenced by DGtal::HyperRectDomain< TSpace >::ConstSubRange::begin(), DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange(), and DGtal::HyperRectDomain< TSpace >::ConstSubRange::end().

template<typename TSpace>

Point DGtal::HyperRectDomain< TSpace >::ConstSubRange::myStartingPoint

private

Starting point of the subrange.

Definition at line 397 of file HyperRectDomain.h.

Referenced by DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange().

template<typename TSpace>

Point DGtal::HyperRectDomain< TSpace >::ConstSubRange::myUpperBound

private

Upper bound of the subrange.

Definition at line 395 of file HyperRectDomain.h.

Referenced by DGtal::HyperRectDomain< TSpace >::ConstSubRange::begin(), DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstSubRange(), and DGtal::HyperRectDomain< TSpace >::ConstSubRange::end().

---

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

• HyperRectDomain.h