IteratorRange< Iterator > Struct Template Reference

A convenience for use with range-for. More...

#include <IteratorX.h>

Inheritance diagram for IteratorRange< Iterator >:

Collaboration diagram for IteratorRange< Iterator >:

Classes
struct	identity

Public Types
using	iterator = Iterator
using	reverse_iterator = std::reverse_iterator< Iterator >

Public Member Functions
	IteratorRange (const Iterator &a, const Iterator &b)
	IteratorRange (Iterator &&a, Iterator &&b)
IteratorRange< reverse_iterator >	reversal () const
Iterator	begin () const
Iterator	end () const
reverse_iterator	rbegin () const
reverse_iterator	rend () const
bool	empty () const
	operator bool () const
size_t	size () const
template<typename T >
iterator	find (const T &t) const
template<typename T >
long	index (const T &t) const
template<typename T >
bool	contains (const T &t) const
template<typename F >
iterator	find_if (const F &f) const
template<typename F >
long	index_if (const F &f) const
template<typename F >
bool	all_of (const F &f) const
template<typename F >
bool	any_of (const F &f) const
template<typename F >
bool	none_of (const F &f) const
template<typename R , typename Binary = std::plus< R >, typename Unary = identity< decltype( *std::declval<Iterator>() ) >>
R	accumulate (R init, Binary binary_op={}, Unary unary_op={}) const
template<typename R , typename Binary = std::plus< R >, typename R2 , typename C >
R	accumulate (R init, Binary binary_op, R2(C ::*pmf)() const) const
template<typename Unary = identity< decltype( *std::declval<Iterator>() ) >, typename R = decltype( std::declval<Unary>()( *std::declval<Iterator>() ) )>
R	min (Unary unary_op={}) const
template<typename R2 , typename C , typename R = R2>
R	min (R2(C ::*pmf)() const) const
template<typename Unary = identity< decltype( *std::declval<Iterator>() ) >, typename R = decltype( std::declval<Unary>()( *std::declval<Iterator>() ) )>
R	max (Unary unary_op={}) const
template<typename R2 , typename C , typename R = R2>
R	max (R2(C ::*pmf)() const) const
template<typename Unary = identity< decltype( *std::declval<Iterator>() ) >, typename R = decltype( std::declval<Unary>()( *std::declval<Iterator>() ) )>
R	sum (Unary unary_op={}) const
template<typename R2 , typename C , typename R = R2>
R	sum (R2(C ::*pmf)() const) const

Detailed Description

template<typename Iterator>
struct IteratorRange< Iterator >

A convenience for use with range-for.

Definition at line 39 of file IteratorX.h.

Member Typedef Documentation

iterator

template<typename Iterator >

using IteratorRange< Iterator >::iterator = Iterator

Definition at line 40 of file IteratorX.h.

reverse_iterator

template<typename Iterator >

using IteratorRange< Iterator >::reverse_iterator = std::reverse_iterator<Iterator>

Definition at line 41 of file IteratorX.h.

Constructor & Destructor Documentation

IteratorRange() [1/2]

template<typename Iterator >

IteratorRange< Iterator >::IteratorRange ( const Iterator &  a, const Iterator &  b  )

inline

Definition at line 43 of file IteratorX.h.

   : std::pair<Iterator, Iterator> ( a, b ) {}

IteratorRange() [2/2]

template<typename Iterator >

IteratorRange< Iterator >::IteratorRange ( Iterator &&  a, Iterator &&  b  )

inline

Definition at line 46 of file IteratorX.h.

   : std::pair<Iterator, Iterator> ( std::move(a), std::move(b) ) {}

Member Function Documentation

accumulate() [1/2]

template<typename Iterator >

template<typename R , typename Binary = std::plus< R >, typename R2 , typename C >

R IteratorRange< Iterator >::accumulate ( R  init, Binary  binary_op, R2(C ::*)() const  pmf  ) const

inline

Definition at line 131 of file IteratorX.h.

   {
      return this->accumulate( init, binary_op, std::mem_fn( pmf ) );
   }

References IteratorRange< Iterator >::accumulate().

Here is the call graph for this function:

accumulate() [2/2]

template<typename Iterator >

template<typename R , typename Binary = std::plus< R >, typename Unary = identity< decltype( *std::declval<Iterator>() ) >>

R IteratorRange< Iterator >::accumulate ( R  init, Binary  binary_op = {}, Unary  unary_op = {}  ) const

inline

Definition at line 112 of file IteratorX.h.

                         {},
      Unary unary_op = {}
   ) const
   {
      R result = init;
      for (auto&& v : *this)
         result = binary_op(result, unary_op(v));
      return result;
   }

Referenced by IteratorRange< Iterator >::accumulate().

Here is the caller graph for this function:

all_of()

template<typename Iterator >

template<typename F >

bool IteratorRange< Iterator >::all_of ( const F &  f ) const

inline

Definition at line 88 of file IteratorX.h.

   {
      auto notF =
         [&](typename std::iterator_traits<Iterator>::reference v)
            { return !f(v); };
      return !this->any_of( notF );
   }

References IteratorRange< Iterator >::any_of().

Here is the call graph for this function:

any_of()

template<typename Iterator >

template<typename F >

bool IteratorRange< Iterator >::any_of ( const F &  f ) const

inline

Definition at line 96 of file IteratorX.h.

   { return this->end() != this->find_if(f); }

References IteratorRange< Iterator >::end(), and IteratorRange< Iterator >::find_if().

Referenced by IteratorRange< Iterator >::all_of(), and IteratorRange< Iterator >::none_of().

Here is the call graph for this function:

Here is the caller graph for this function:

begin()

template<typename Iterator >

Iterator IteratorRange< Iterator >::begin ( ) const

inline

Definition at line 52 of file IteratorX.h.

{ return this->first; }

Referenced by IteratorRange< Iterator >::empty(), IteratorRange< Iterator >::find(), IteratorRange< Iterator >::find_if(), IteratorRange< Iterator >::index(), IteratorRange< Iterator >::index_if(), MixAndRender(), and IteratorRange< Iterator >::size().

Here is the caller graph for this function:

contains()

template<typename Iterator >

template<typename T >

bool IteratorRange< Iterator >::contains ( const T &  t ) const

inline

Definition at line 73 of file IteratorX.h.

   { return this->end() != this->find(t); }

References IteratorRange< Iterator >::end(), and IteratorRange< Iterator >::find().

Here is the call graph for this function:

empty()

template<typename Iterator >

bool IteratorRange< Iterator >::empty ( ) const

inline

Definition at line 58 of file IteratorX.h.

{ return this->begin() == this->end(); }

References IteratorRange< Iterator >::begin(), and IteratorRange< Iterator >::end().

Referenced by MixAndRender(), and IteratorRange< Iterator >::operator bool().

Here is the call graph for this function:

Here is the caller graph for this function:

end()

template<typename Iterator >

Iterator IteratorRange< Iterator >::end ( ) const

inline

Definition at line 53 of file IteratorX.h.

{ return this->second; }

Referenced by IteratorRange< Iterator >::any_of(), IteratorRange< Iterator >::contains(), IteratorRange< Iterator >::empty(), IteratorRange< Iterator >::find(), IteratorRange< Iterator >::find_if(), IteratorRange< Iterator >::index(), IteratorRange< Iterator >::index_if(), and IteratorRange< Iterator >::size().

Here is the caller graph for this function:

find()

template<typename Iterator >

template<typename T >

iterator IteratorRange< Iterator >::find ( const T &  t ) const

inline

Definition at line 62 of file IteratorX.h.

   { return std::find(this->begin(), this->end(), t); }

References IteratorRange< Iterator >::begin(), and IteratorRange< Iterator >::end().

Referenced by IteratorRange< Iterator >::contains(), and IteratorRange< Iterator >::index().

Here is the call graph for this function:

Here is the caller graph for this function:

find_if()

template<typename Iterator >

template<typename F >

iterator IteratorRange< Iterator >::find_if ( const F &  f ) const

inline

Definition at line 76 of file IteratorX.h.

   { return std::find_if(this->begin(), this->end(), f); }

References IteratorRange< Iterator >::begin(), and IteratorRange< Iterator >::end().

Referenced by IteratorRange< Iterator >::any_of(), and IteratorRange< Iterator >::index_if().

Here is the call graph for this function:

Here is the caller graph for this function:

index()

template<typename Iterator >

template<typename T >

long IteratorRange< Iterator >::index ( const T &  t ) const

inline

Definition at line 65 of file IteratorX.h.

   {
      auto iter = this->find(t);
      if (iter == this->end())
         return -1;
      return std::distance(this->begin(), iter);
   }

References IteratorRange< Iterator >::begin(), IteratorRange< Iterator >::end(), and IteratorRange< Iterator >::find().

Here is the call graph for this function:

index_if()

template<typename Iterator >

template<typename F >

long IteratorRange< Iterator >::index_if ( const F &  f ) const

inline

Definition at line 79 of file IteratorX.h.

   {
      auto iter = this->find_if(f);
      if (iter == this->end())
         return -1;
      return std::distance(this->begin(), iter);
   }

References IteratorRange< Iterator >::begin(), IteratorRange< Iterator >::end(), and IteratorRange< Iterator >::find_if().

Here is the call graph for this function:

max() [1/2]

template<typename Iterator >

template<typename R2 , typename C , typename R = R2>

R IteratorRange< Iterator >::max ( R2(C ::*)() const  pmf ) const

inline

Definition at line 180 of file IteratorX.h.

   {
      return this->max( std::mem_fn( pmf ) );
   }

References IteratorRange< Iterator >::max().

Here is the call graph for this function:

max() [2/2]

template<typename Iterator >

template<typename Unary = identity< decltype( *std::declval<Iterator>() ) >, typename R = decltype( std::declval<Unary>()( *std::declval<Iterator>() ) )>

R IteratorRange< Iterator >::max ( Unary  unary_op = {} ) const

inline

Definition at line 167 of file IteratorX.h.

                           {} ) const
   {
      return this->accumulate(
         std::numeric_limits< R >::lowest(),
         (const R&(*)(const R&, const R&)) std::max,
         unary_op
      );
   }

Referenced by IteratorRange< Iterator >::max().

Here is the caller graph for this function:

min() [1/2]

template<typename Iterator >

template<typename R2 , typename C , typename R = R2>

R IteratorRange< Iterator >::min ( R2(C ::*)() const  pmf ) const

inline

Definition at line 158 of file IteratorX.h.

   {
      return this->min( std::mem_fn( pmf ) );
   }

References IteratorRange< Iterator >::min().

Here is the call graph for this function:

min() [2/2]

template<typename Iterator >

template<typename Unary = identity< decltype( *std::declval<Iterator>() ) >, typename R = decltype( std::declval<Unary>()( *std::declval<Iterator>() ) )>

R IteratorRange< Iterator >::min ( Unary  unary_op = {} ) const

inline

Definition at line 145 of file IteratorX.h.

                           {} ) const
   {
      return this->accumulate(
         std::numeric_limits< R >::max(),
         (const R&(*)(const R&, const R&)) std::min,
         unary_op
      );
   }

Referenced by IteratorRange< Iterator >::min().

Here is the caller graph for this function:

none_of()

template<typename Iterator >

template<typename F >

bool IteratorRange< Iterator >::none_of ( const F &  f ) const

inline

Definition at line 99 of file IteratorX.h.

   { return !this->any_of(f); }

References IteratorRange< Iterator >::any_of().

Here is the call graph for this function:

operator bool()

template<typename Iterator >

IteratorRange< Iterator >::operator bool ( ) const

inlineexplicit

Definition at line 59 of file IteratorX.h.

{ return !this->empty(); }

References IteratorRange< Iterator >::empty().

Here is the call graph for this function:

rbegin()

template<typename Iterator >

reverse_iterator IteratorRange< Iterator >::rbegin ( ) const

inline

Definition at line 55 of file IteratorX.h.

{ return reverse_iterator{ this->second }; }

Referenced by IteratorRange< Iterator >::reversal().

Here is the caller graph for this function:

rend()

template<typename Iterator >

reverse_iterator IteratorRange< Iterator >::rend ( ) const

inline

Definition at line 56 of file IteratorX.h.

{ return reverse_iterator{ this->first }; }

Referenced by IteratorRange< Iterator >::reversal().

Here is the caller graph for this function:

reversal()

template<typename Iterator >

IteratorRange< reverse_iterator > IteratorRange< Iterator >::reversal ( ) const

inline

Definition at line 49 of file IteratorX.h.

   { return { this->rbegin(), this->rend() }; }

References IteratorRange< Iterator >::rbegin(), and IteratorRange< Iterator >::rend().

Here is the call graph for this function:

size()

template<typename Iterator >

size_t IteratorRange< Iterator >::size ( ) const

inline

Definition at line 60 of file IteratorX.h.

{ return std::distance(this->begin(), this->end()); }

References IteratorRange< Iterator >::begin(), and IteratorRange< Iterator >::end().

Here is the call graph for this function:

sum() [1/2]

template<typename Iterator >

template<typename R2 , typename C , typename R = R2>

R IteratorRange< Iterator >::sum ( R2(C ::*)() const  pmf ) const

inline

Definition at line 202 of file IteratorX.h.

   {
      return this->sum( std::mem_fn( pmf ) );
   }

References IteratorRange< Iterator >::sum().

Here is the call graph for this function:

sum() [2/2]

template<typename Iterator >

template<typename Unary = identity< decltype( *std::declval<Iterator>() ) >, typename R = decltype( std::declval<Unary>()( *std::declval<Iterator>() ) )>

R IteratorRange< Iterator >::sum ( Unary  unary_op = {} ) const

inline

Definition at line 189 of file IteratorX.h.

                           {} ) const
   {
      return this->accumulate(
         R{ 0 },
         std::plus< R >{},
         unary_op
      );
   }

Referenced by IteratorRange< Iterator >::sum().

Here is the caller graph for this function:

---

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

• IteratorX.h