DGtal  1.5.beta
Public Types | Public Member Functions | Private Attributes
DGtal::HyperRectDomain< TSpace >::ConstSubRange Struct Reference

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. More...

#include <DGtal/kernel/domains/HyperRectDomain.h>

Public Types

typedef HyperRectDomain_subIterator< Point > ConstIterator
 
typedef HyperRectDomain_ReverseIterator< 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
 Lower bound of the subrange. More...
 
Point myUpperBound
 Upper bound of the subrange. More...
 
Point myStartingPoint
 Starting point of the subrange. More...
 
std::vector< Dimension > myPermutation
 Permutation on dimensions used in the subrange. More...
 

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

Member Typedef Documentation

◆ ConstIterator

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

Definition at line 251 of file HyperRectDomain.h.

◆ ConstReverseIterator

template<typename TSpace >
typedef HyperRectDomain_ReverseIterator<ConstIterator> DGtal::HyperRectDomain< TSpace >::ConstSubRange::ConstReverseIterator

Definition at line 252 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
domainthe domain.
permutationa vector containing the dimensions used for the subrange. Dimensions are iterated in the given order.
startingPointthe initial point.
Precondition
startingPoint must belong to the range.

Definition at line 262 of file HyperRectDomain.h.

265  : myLowerBound(domain.myLowerBound),
266  myUpperBound(domain.myUpperBound),
267  myStartingPoint(startingPoint)
268  {
269  ASSERT_MSG(
270  domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
271  "The point must be inside the given domain or be equal to one of his bound."
272  );
273 
274  myPermutation.reserve( permutation.size() );
275  std::copy(permutation.begin(), permutation.end(), std::back_inserter(myPermutation));
276  myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
277  myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
278  }
DGtal::PointVector::partialCopyInv
Self & partialCopyInv(const PointVector< dim, OtherComponent, OtherContainer > &pv, const std::vector< Dimension > &dimensions)
Partial copy of a given PointVector.
DGtal::HyperRectDomain::ConstSubRange::myStartingPoint
Point myStartingPoint
Starting point of the subrange.
Definition: HyperRectDomain.h:461
DGtal::HyperRectDomain::ConstSubRange::myUpperBound
Point myUpperBound
Upper bound of the subrange.
Definition: HyperRectDomain.h:459
DGtal::HyperRectDomain::ConstSubRange::myLowerBound
Point myLowerBound
Lower bound of the subrange.
Definition: HyperRectDomain.h:457
DGtal::HyperRectDomain::ConstSubRange::myPermutation
std::vector< Dimension > myPermutation
Permutation on dimensions used in the subrange.
Definition: HyperRectDomain.h:463
domain
Domain domain
Definition: testProjection.cpp:88

References domain, 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().

◆ 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
domainthe domain.
permutationan initializer_list containing the dimensions used for the subrange. Dimensions are iterated in the given order.
startingPointthe initial point.
Precondition
startingPoint must belong to the range.

Definition at line 288 of file HyperRectDomain.h.

291  : myLowerBound(domain.myLowerBound),
292  myUpperBound(domain.myUpperBound),
293  myStartingPoint(startingPoint)
294  {
295  ASSERT_MSG(
296  domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
297  "The point must be inside the given domain or be equal to one of his bound."
298  );
299 
300  myPermutation.reserve( permutation.size() );
301  for ( const unsigned int *c = permutation.begin(); c != permutation.end(); ++c )
302  {
303  myPermutation.push_back( *c );
304  }
305  myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
306  myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
307  }

References domain, 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().

◆ 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
domainthe domain.
adimthe dimension used for the subrange.
startingPointthe initial point.
Precondition
startingPoint must belong to the range.

Definition at line 316 of file HyperRectDomain.h.

319  : myLowerBound(domain.myLowerBound),
320  myUpperBound(domain.myUpperBound),
321  myStartingPoint(startingPoint)
322  {
323  ASSERT_MSG(
324  domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
325  "The point must be inside the given domain or be equal to one of his bound."
326  );
327 
328  myPermutation.push_back( adim );
329  myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
330  myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
331  }

References domain, 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().

◆ 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
domainthe domain.
adim1the first dimension used for the subrange.
adim2the second dimension used for the subrange.
startingPointthe initial point.
Precondition
startingPoint must belong to the range.

Definition at line 341 of file HyperRectDomain.h.

344  : myLowerBound(domain.myLowerBound),
345  myUpperBound(domain.myUpperBound),
346  myStartingPoint(startingPoint)
347  {
348  ASSERT_MSG(
349  domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
350  "The point must be inside the given domain or be equal to one of his bound."
351  );
352 
353  myPermutation.push_back( adim1 );
354  myPermutation.push_back( adim2 );
355  myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
356  myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
357  }

References domain, 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().

◆ 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
domainthe domain.
adim1the first dimension used for the subrange.
adim2the second dimension used for the subrange.
adim3the third dimension used for the subrange.
startingPointthe initial point.
Precondition
startingPoint must belong to the range.

Definition at line 368 of file HyperRectDomain.h.

371  : myLowerBound(domain.myLowerBound),
372  myUpperBound(domain.myUpperBound),
373  myStartingPoint(startingPoint)
374  {
375  ASSERT_MSG(
376  domain.isInside(startingPoint) || startingPoint == myLowerBound || startingPoint == myUpperBound,
377  "The point must be inside the given domain or be equal to one of his bound."
378  );
379 
380  myPermutation.push_back( adim1 );
381  myPermutation.push_back( adim2 );
382  myPermutation.push_back( adim3 );
383  myLowerBound.partialCopyInv(myStartingPoint, myPermutation);
384  myUpperBound.partialCopyInv(myStartingPoint, myPermutation);
385  }

References domain, 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().

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

392  {
393  return ConstIterator(myLowerBound, myLowerBound, myUpperBound, myPermutation);
394  }
DGtal::HyperRectDomain::ConstSubRange::ConstIterator
HyperRectDomain_subIterator< Point > ConstIterator
Definition: HyperRectDomain.h:251

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

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

◆ begin() [2/2]

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

begin method from a given point.

Parameters
aPointthe initial point.
Returns
a ConstIterator initialized to aPoint.
Precondition
aPoint must belong to the range.

Definition at line 402 of file HyperRectDomain.h.

403  {
404  ASSERT(aPoint.partialEqualInv(myLowerBound, myPermutation) );
405  ASSERT_MSG(
406  ( myLowerBound.isLower(aPoint) && aPoint.isLower(myUpperBound) ) || aPoint == myLowerBound || aPoint == myUpperBound,
407  "The point must be inside the given domain or be equal to one of his bound."
408  );
409 
410  return ConstIterator(aPoint, myLowerBound, myUpperBound, myPermutation);
411  }
DGtal::PointVector::isLower
bool isLower(const PointVector< dim, OtherComponent, OtherStorage > &p) const
Return true if this point is below a given point.
aPoint
const Point aPoint(3, 4)

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

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

418  {
419  ConstIterator it = ConstIterator(myUpperBound, myLowerBound, myUpperBound, myPermutation);
420  ++it;
421  return it;
422  }
ConstIterator
MyDigitalSurface::ConstIterator ConstIterator
Definition: greedy-plane-segmentation-ex2.cpp:93

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

Referenced by DGtal::ImageFactoryFromHDF5< TImageContainer >::flushImage(), and DGtal::HyperRectDomain< TSpace >::ConstSubRange::rbegin().

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

429  {
430  return ConstReverseIterator(end());
431  }
DGtal::HyperRectDomain::ConstSubRange::ConstReverseIterator
HyperRectDomain_ReverseIterator< ConstIterator > ConstReverseIterator
Definition: HyperRectDomain.h:252

References DGtal::HyperRectDomain< TSpace >::ConstSubRange::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
aPointthe initial point.
Returns
a ConstIterator initialized to aPoint.
Precondition
aPoint must belong to the range.

Definition at line 439 of file HyperRectDomain.h.

440  {
441  ConstIterator it(begin(aPoint));
442  ++it;
443  return ConstReverseIterator(it);
444  }

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

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

451  {
452  return ConstReverseIterator(begin());
453  }

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

Field Documentation

◆ myLowerBound

template<typename TSpace >
Point DGtal::HyperRectDomain< TSpace >::ConstSubRange::myLowerBound
private

Lower bound of the subrange.

Definition at line 457 of file HyperRectDomain.h.

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

◆ myPermutation

template<typename TSpace >
std::vector<Dimension> DGtal::HyperRectDomain< TSpace >::ConstSubRange::myPermutation
private

Permutation on dimensions used in the subrange.

Definition at line 463 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 461 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 459 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: