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

#include <DGtal/kernel/domains/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, std::initializer_list< 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 234 of file HyperRectDomain.h.

Member Typedef Documentation

ConstIterator

template<typename TSpace>

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

Definition at line 236 of file HyperRectDomain.h.

ConstReverseIterator

template<typename TSpace>

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

Definition at line 237 of file HyperRectDomain.h.

Constructor & Destructor Documentation

ConstSubRange() [1/5]

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 247 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::isInside(), 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, TContainer >::partialCopyInv().

Referenced by DGtal::HyperRectDomain< Space >::subRange().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
        {
          ASSERT_MSG(
              domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
              "The point must be inside the given domain or be equal to one of his bound."
          );

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

ConstSubRange() [2/5]

template<typename TSpace>

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

inline

ConstSubRange constructor from a given domain.

Parameters

domain	the domain.
permutation	an initializer_list 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 273 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::isInside(), 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, TContainer >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
        {
          ASSERT_MSG(
              domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound, 
              "The point must be inside the given domain or be equal to one of his bound."
          );

          myPermutation.reserve( permutation.size() );
          for ( const unsigned int *c = permutation.begin(); c != permutation.end(); ++c )
            {
              myPermutation.push_back( *c );
            }
          myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
          myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
        }

ConstSubRange() [3/5]

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 301 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::isInside(), 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, TContainer >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
        {
          ASSERT_MSG(
              domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
              "The point must be inside the given domain or be equal to one of his bound."
          );

          myPermutation.push_back( adim );
          myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
          myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
        }

ConstSubRange() [4/5]

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 326 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::isInside(), 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, TContainer >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
        {
          ASSERT_MSG(
              domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
              "The point must be inside the given domain or be equal to one of his bound."
          );

          myPermutation.push_back( adim1 );
          myPermutation.push_back( adim2 );
          myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
          myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
        }

ConstSubRange() [5/5]

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 353 of file HyperRectDomain.h.

References DGtal::HyperRectDomain< TSpace >::isInside(), 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, TContainer >::partialCopyInv().

        : myLowerBound(domain.myLowerBound),
          myUpperBound(domain.myUpperBound),
          myStartingPoint(startingPoint)
        {
          ASSERT_MSG(
              domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
              "The point must be inside the given domain or be equal to one of his bound."
          );
          
          myPermutation.push_back( adim1 );
          myPermutation.push_back( adim2 );
          myPermutation.push_back( adim3 );
          myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
          myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
        }

Member Function Documentation

begin() [1/2]

template<typename TSpace>

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

inline

begin method.

Returns

ConstIterator on the beginning of the range.

Definition at line 376 of file HyperRectDomain.h.

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

Referenced by DGtal::HyperRectDomain< TSpace >::ConstSubRange::rbegin(), and DGtal::HyperRectDomain< TSpace >::ConstSubRange::rend().

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

begin() [2/2]

template<typename TSpace>

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

inline

begin method from a given point.

Parameters

aPoint

the initial point.

Returns

a ConstIterator initialized to aPoint.

Precondition

aPoint must belong to the range.

Definition at line 387 of file HyperRectDomain.h.

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

        { 
          ASSERT(aPoint.partialEqualInv(myLowerBound, myPermutation) );
          ASSERT_MSG( 
            ( myLowerBound.isLower(aPoint) && aPoint.isLower(myUpperBound) ) || aPoint == myLowerBound || aPoint == myUpperBound,
            "The point must be inside the given domain or be equal to one of his bound."
          );

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

end()

template<typename TSpace>

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

inline

end method.

Returns

ConstIterator on the end of the range.

Definition at line 402 of file HyperRectDomain.h.

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

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

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

rbegin() [1/2]

template<typename TSpace>

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

inline

reverse begin method.

Returns

ConstIterator on the beginning of the reverse range.

Definition at line 413 of file HyperRectDomain.h.

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

        {
          return ConstReverseIterator(end());
        }

rbegin() [2/2]

template<typename TSpace>

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

inline

reverse begin method from a given point.

Parameters

aPoint

the initial point.

Returns

a ConstIterator initialized to aPoint.

Precondition

aPoint must belong to the range.

Definition at line 424 of file HyperRectDomain.h.

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

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

rend()

template<typename TSpace>

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

inline

reverse end method.

Returns

ConstIterator on the end of the reverse range.

Definition at line 435 of file HyperRectDomain.h.

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

        { 
          return ConstReverseIterator(begin());
        }

Field Documentation

myLowerBound

template<typename TSpace>

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

private

Lower bound of the subrange.

Definition at line 442 of file HyperRectDomain.h.

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

myPermutation

template<typename TSpace>

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

private

Permutation on dimensions used in the subrange.

Definition at line 448 of file HyperRectDomain.h.

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

myStartingPoint

template<typename TSpace>

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

private

Starting point of the subrange.

Definition at line 446 of file HyperRectDomain.h.

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

myUpperBound

template<typename TSpace>

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

private

Upper bound of the subrange.

Definition at line 444 of file HyperRectDomain.h.

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

---

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

• HyperRectDomain.h