OpenGM  2.3.x
Discrete Graphical Model Library
subsequence_iterator.hxx
Go to the documentation of this file.
1 #ifndef OPENGM_SUBSEQUENCE_ITERATOR_HXX_
2 #define OPENGM_SUBSEQUENCE_ITERATOR_HXX_
3 
4 #include <iterator>
5 
6 namespace opengm {
7 
8 /*********************
9  * class definitions *
10  *********************/
11 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
12 class SubsequenceIterator : public std::iterator<std::random_access_iterator_tag, typename SEQUENCE_ITERATOR_TYPE::value_type > {
13 public:
14  // typedefs
15  typedef SEQUENCE_ITERATOR_TYPE SequenceIteratorType;
16  typedef SUBSEQUENCE_INDICES_ITERATOR_TYPE SubsequenceIndicesIteratorType;
17  typedef SubsequenceIterator<SequenceIteratorType, SubsequenceIndicesIteratorType> SubsequenceIteratorType;
18  typedef typename SequenceIteratorType::value_type value_type;
19  typedef std::random_access_iterator_tag iterator_category;
20  typedef typename std::iterator<std::random_access_iterator_tag, value_type>::difference_type difference_type;
21  typedef value_type& reference;
22  typedef value_type* pointer;
23 
24  // constructor
25  SubsequenceIterator();
26  SubsequenceIterator(const SubsequenceIteratorType& copy);
27  SubsequenceIterator(const SequenceIteratorType sequenceBegin, const SubsequenceIndicesIteratorType subsequenceIndicesBegin, const size_t subsequenceIndicesPosition = 0);
28 
29  // assignment
30  SubsequenceIteratorType& operator=(const SubsequenceIteratorType& copy);
31 
32  // increment
33  SubsequenceIteratorType& operator++(); // PREFIX
34  SubsequenceIteratorType operator++(int); // POSTFIX
35  SubsequenceIteratorType operator+(const difference_type& n) const;
36  SubsequenceIteratorType& operator+=(const difference_type& n);
37 
38  // decrement
39  SubsequenceIteratorType& operator--(); // PREFIX
40  SubsequenceIteratorType operator--(int); // POSTFIX
41  SubsequenceIteratorType operator-(const difference_type& n) const;
42  SubsequenceIteratorType& operator-=(const difference_type& n);
43 
44  // access
45  const value_type& operator*() const;
46  const value_type* operator->() const;
47  const value_type& operator[](const difference_type& n) const;
48 protected:
49  // storage
50  SequenceIteratorType sequenceBegin_;
51  SubsequenceIndicesIteratorType subsequenceIndicesBegin_;
52  size_t subsequenceIndicesPosition_;
53 
54  // friends
55  inline friend bool operator==(const SubsequenceIteratorType& iter1, const SubsequenceIteratorType& iter2) {
56  return (iter1.sequenceBegin_ == iter2.sequenceBegin_) && (iter1.subsequenceIndicesBegin_ == iter2.subsequenceIndicesBegin_) && (iter1.subsequenceIndicesPosition_ == iter2.subsequenceIndicesPosition_);
57  }
58  inline friend bool operator!=(const SubsequenceIteratorType& iter1, const SubsequenceIteratorType& iter2) {
59  return (iter1.sequenceBegin_ != iter2.sequenceBegin_) || (iter1.subsequenceIndicesBegin_ != iter2.subsequenceIndicesBegin_) || (iter1.subsequenceIndicesPosition_ != iter2.subsequenceIndicesPosition_);
60  }
61  inline friend bool operator<(const SubsequenceIteratorType& iter1, const SubsequenceIteratorType& iter2) {
62  return (iter1.sequenceBegin_ == iter2.sequenceBegin_) && (iter1.subsequenceIndicesBegin_ == iter2.subsequenceIndicesBegin_) && (iter1.subsequenceIndicesPosition_ < iter2.subsequenceIndicesPosition_);
63  }
64  inline friend bool operator>(const SubsequenceIteratorType& iter1, const SubsequenceIteratorType& iter2) {
65  return (iter1.sequenceBegin_ == iter2.sequenceBegin_) && (iter1.subsequenceIndicesBegin_ == iter2.subsequenceIndicesBegin_) && (iter1.subsequenceIndicesPosition_ > iter2.subsequenceIndicesPosition_);
66  }
67  inline friend bool operator<=(const SubsequenceIteratorType& iter1, const SubsequenceIteratorType& iter2) {
68  return (iter1.sequenceBegin_ == iter2.sequenceBegin_) && (iter1.subsequenceIndicesBegin_ == iter2.subsequenceIndicesBegin_) && (iter1.subsequenceIndicesPosition_ <= iter2.subsequenceIndicesPosition_);
69  }
70  inline friend bool operator>=(const SubsequenceIteratorType& iter1, const SubsequenceIteratorType& iter2) {
71  return (iter1.sequenceBegin_ == iter2.sequenceBegin_) && (iter1.subsequenceIndicesBegin_ == iter2.subsequenceIndicesBegin_) && (iter1.subsequenceIndicesPosition_ >= iter2.subsequenceIndicesPosition_);
72  }
73  inline friend difference_type operator-(const SubsequenceIteratorType& iter1, const SubsequenceIteratorType& iter2) {
74  return iter1.subsequenceIndicesPosition_ - iter2.subsequenceIndicesPosition_;
75  }
76 };
77 
78 /***********************
79  * class documentation *
80  ***********************/
346 /******************
347  * implementation *
348  ******************/
349 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
350 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::SubsequenceIterator()
351  : sequenceBegin_(), subsequenceIndicesBegin_(), subsequenceIndicesPosition_() {
352 
353 }
354 
355 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
356 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::SubsequenceIterator(const SubsequenceIteratorType& copy)
357  : sequenceBegin_(copy.sequenceBegin_),
358  subsequenceIndicesBegin_(copy.subsequenceIndicesBegin_),
359  subsequenceIndicesPosition_(copy.subsequenceIndicesPosition_) {
360 
361 }
362 
363 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
364 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::SubsequenceIterator(const SequenceIteratorType sequenceBegin, const SubsequenceIndicesIteratorType subsequenceIndicesBegin, const size_t subsequenceIndicesPosition)
365  : sequenceBegin_(sequenceBegin), subsequenceIndicesBegin_(subsequenceIndicesBegin), subsequenceIndicesPosition_(subsequenceIndicesPosition) {
366 
367 }
368 
369 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
370 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>& SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator=(const SubsequenceIteratorType& copy) {
371  sequenceBegin_ = copy.sequenceBegin_;
372  subsequenceIndicesBegin_ = copy.subsequenceIndicesBegin_;
373  subsequenceIndicesPosition_ = copy.subsequenceIndicesPosition_;
374  return *this;
375 }
376 
377 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
378 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>& SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator++() {
379  ++subsequenceIndicesPosition_;
380  return *this;
381 }
382 
383 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
384 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE> SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator++(int) {
385  return SubsequenceIteratorType(sequenceBegin_, subsequenceIndicesBegin_, subsequenceIndicesPosition_++);
386 }
387 
388 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
389 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE> SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator+(const difference_type& n) const {
390  return SubsequenceIteratorType(sequenceBegin_, subsequenceIndicesBegin_, subsequenceIndicesPosition_ + n);
391 }
392 
393 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
394 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>& SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator+=(const difference_type& n) {
395  subsequenceIndicesPosition_ += n;
396  return *this;
397 }
398 
399 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
400 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>& SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator--() {
401  --subsequenceIndicesPosition_;
402  return *this;
403 }
404 
405 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
406 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE> SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator--(int) {
407  return SubsequenceIteratorType(sequenceBegin_, subsequenceIndicesBegin_, subsequenceIndicesPosition_--);
408 }
409 
410 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
411 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE> SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator-(const difference_type& n) const {
412  return SubsequenceIteratorType(sequenceBegin_, subsequenceIndicesBegin_, subsequenceIndicesPosition_ - n);
413 }
414 
415 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
416 inline SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>& SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator-=(const difference_type& n) {
417  subsequenceIndicesPosition_ -= n;
418  return *this;
419 }
420 
421 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
422 inline const typename SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::value_type& SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator*() const {
423  return sequenceBegin_[subsequenceIndicesBegin_[subsequenceIndicesPosition_]];
424 }
425 
426 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
427 inline const typename SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::value_type* SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator->() const {
428  return &(sequenceBegin_[subsequenceIndicesBegin_[subsequenceIndicesPosition_]]);
429 }
430 
431 template<class SEQUENCE_ITERATOR_TYPE, class SUBSEQUENCE_INDICES_ITERATOR_TYPE>
432 inline const typename SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::value_type& SubsequenceIterator<SEQUENCE_ITERATOR_TYPE, SUBSEQUENCE_INDICES_ITERATOR_TYPE>::operator[](const difference_type& n) const {
433  return sequenceBegin_[subsequenceIndicesBegin_[subsequenceIndicesPosition_ + n]];
434 }
435 
436 } // namespace opengm
437 
438 #endif /* OPENGM_SUBSEQUENCE_ITERATOR_HXX_ */
opengm::SubsequenceIterator::SubsequenceIndicesIteratorType
SUBSEQUENCE_INDICES_ITERATOR_TYPE SubsequenceIndicesIteratorType
Typedef of the SUBSEQUENCE_INDICES_ITERATOR_TYPE template parameter from the class SubsequenceIterato...
Definition: subsequence_iterator.hxx:16
opengm::SubsequenceIterator::subsequenceIndicesPosition_
size_t subsequenceIndicesPosition_
Current Position of the iterator. Hence subsequenceIndicesPosition_ contains the number of the elemen...
Definition: subsequence_iterator.hxx:52
opengm::SubsequenceIterator::difference_type
std::iterator< std::random_access_iterator_tag, value_type >::difference_type difference_type
STL compliant typedef of the iterator difference type.
Definition: subsequence_iterator.hxx:20
opengm::SubsequenceIterator::operator=
SubsequenceIteratorType & operator=(const SubsequenceIteratorType &copy)
SubsequenceIterator assignment operator.
Definition: subsequence_iterator.hxx:370
opengm
The OpenGM namespace.
Definition: config.hxx:43
opengm::SubsequenceIterator::SubsequenceIterator
SubsequenceIterator()
SubsequenceIterator constructor.
Definition: subsequence_iterator.hxx:350
opengm::SubsequenceIterator::value_type
SequenceIteratorType::value_type value_type
Value type of the sequence adapted from SubsequenceIterator::SequenceIteratorType.
Definition: subsequence_iterator.hxx:18
opengm::SubsequenceIterator::operator[]
const value_type & operator[](const difference_type &n) const
Offset dereference operator.
Definition: subsequence_iterator.hxx:432
opengm::SubsequenceIterator
Defines the const iterator type to iterate over the subset of a sequence.
Definition: subsequence_iterator.hxx:12
opengm::SubsequenceIterator::operator>=
friend bool operator>=(const SubsequenceIteratorType &iter1, const SubsequenceIteratorType &iter2)
Greater or equal comparison operator for two SubsequenceIterator iterators.
Definition: subsequence_iterator.hxx:70
opengm::SubsequenceIterator::reference
value_type & reference
STL compliant typedef of the iterator reference type.
Definition: subsequence_iterator.hxx:21
opengm::SubsequenceIterator::subsequenceIndicesBegin_
SubsequenceIndicesIteratorType subsequenceIndicesBegin_
Iterator pointing to the begin of a sequence where the indices for the elements of the subsequence ar...
Definition: subsequence_iterator.hxx:51
opengm::SubsequenceIterator::pointer
value_type * pointer
STL compliant typedef of the iterator pointer type.
Definition: subsequence_iterator.hxx:22
opengm::SubsequenceIterator::operator--
SubsequenceIteratorType & operator--()
Prefix decrement operator.
Definition: subsequence_iterator.hxx:400
opengm::SubsequenceIterator::operator-=
SubsequenceIteratorType & operator-=(const difference_type &n)
Compound assignment operator to decrement iterator by an integer value.
Definition: subsequence_iterator.hxx:416
opengm::SubsequenceIterator::operator!=
friend bool operator!=(const SubsequenceIteratorType &iter1, const SubsequenceIteratorType &iter2)
Inequality comparison operator for two SubsequenceIterator iterators.
Definition: subsequence_iterator.hxx:58
opengm::SubsequenceIterator::operator++
SubsequenceIteratorType & operator++()
Prefix increment operator.
Definition: subsequence_iterator.hxx:378
opengm::SubsequenceIterator::operator+=
SubsequenceIteratorType & operator+=(const difference_type &n)
Compound assignment operator to increment iterator by an integer value.
Definition: subsequence_iterator.hxx:394
opengm::SubsequenceIterator::iterator_category
std::random_access_iterator_tag iterator_category
STL compliant typedef of the iterator category.
Definition: subsequence_iterator.hxx:19
opengm::SubsequenceIterator::SequenceIteratorType
SEQUENCE_ITERATOR_TYPE SequenceIteratorType
Typedef of the SEQUENCE_ITERATOR_TYPE template parameter from the class SubsequenceIterator.
Definition: subsequence_iterator.hxx:15
opengm::SubsequenceIterator::operator->
const value_type * operator->() const
Pointer operator.
Definition: subsequence_iterator.hxx:427
opengm::SubsequenceIterator::operator>
friend bool operator>(const SubsequenceIteratorType &iter1, const SubsequenceIteratorType &iter2)
Greater comparison operator for two SubsequenceIterator iterators.
Definition: subsequence_iterator.hxx:64
opengm::SubsequenceIterator::operator+
SubsequenceIteratorType operator+(const difference_type &n) const
Arithmetic operator to increment iterator by an integer value.
Definition: subsequence_iterator.hxx:389
opengm::SubsequenceIterator::operator*
const value_type & operator*() const
Dereference operator.
Definition: subsequence_iterator.hxx:422
opengm::SubsequenceIterator::operator<=
friend bool operator<=(const SubsequenceIteratorType &iter1, const SubsequenceIteratorType &iter2)
Less or equal comparison operator for two SubsequenceIterator iterators.
Definition: subsequence_iterator.hxx:67
opengm::SubsequenceIterator::sequenceBegin_
SequenceIteratorType sequenceBegin_
Iterator pointing to the begin of a sequence of values. The subsequence iterator will iterate over th...
Definition: subsequence_iterator.hxx:50
opengm::SubsequenceIterator::operator==
friend bool operator==(const SubsequenceIteratorType &iter1, const SubsequenceIteratorType &iter2)
Equality comparison operator for two SubsequenceIterator iterators.
Definition: subsequence_iterator.hxx:55
opengm::SubsequenceIterator::operator-
friend difference_type operator-(const SubsequenceIteratorType &iter1, const SubsequenceIteratorType &iter2)
Difference operator for two subsequence iterators.
Definition: subsequence_iterator.hxx:73
opengm::SubsequenceIterator::SubsequenceIteratorType
SubsequenceIterator< SequenceIteratorType, SubsequenceIndicesIteratorType > SubsequenceIteratorType
Typedef of the class SubsequenceIterator with appropriate template parameter.
Definition: subsequence_iterator.hxx:17
opengm::SubsequenceIterator::operator-
SubsequenceIteratorType operator-(const difference_type &n) const
Arithmetic operator to decrement iterator by an integer value.
Definition: subsequence_iterator.hxx:411
opengm::SubsequenceIterator::operator<
friend bool operator<(const SubsequenceIteratorType &iter1, const SubsequenceIteratorType &iter2)
Less comparison operator for two SubsequenceIterator iterators.
Definition: subsequence_iterator.hxx:61
Generated by   doxygen 1.8.9.1