Safe iterators for bijectionIterator. More...

#include <agrum/base/core/bijection.h>

Public Types

using	iterator_category = std::forward_iterator_tag
	types for STL compliance
using	type1_type = T1
	types for STL compliance
using	type1_reference = T1&
	types for STL compliance
using	type1_const_reference = const T1&
	types for STL compliance
using	type1_pointer = T1*
	types for STL compliance
using	type1_const_pointer = const T1*
	types for STL compliance
using	type2_type = T2
	types for STL compliance
using	type2_reference = T2&
	types for STL compliance
using	type2_const_reference = const T2&
	types for STL compliance
using	type2_pointer = T2*
	types for STL compliance
using	type2_const_pointer = const T2*
	types for STL compliance
using	difference_type = std::ptrdiff_t
	types for STL compliance

Public Member Functions
Constructors and destructors
	BijectionIteratorSafe () noexcept
	Default constructor.
	BijectionIteratorSafe (const Bijection< T1, T2 > &bijection)
	Begin constructor.
	BijectionIteratorSafe (const BijectionIteratorSafe< T1, T2 > &from)
	Copy constructor.
	BijectionIteratorSafe (BijectionIteratorSafe< T1, T2 > &&from) noexcept
	Move constructor.
	~BijectionIteratorSafe () noexcept
	Class destructor.
Operators
BijectionIteratorSafe< T1, T2 > &	operator= (const BijectionIteratorSafe< T1, T2 > &toCopy)
	Copy operator.
BijectionIteratorSafe< T1, T2 > &	operator= (BijectionIteratorSafe< T1, T2 > &&toMove) noexcept
	Move operator.
BijectionIteratorSafe< T1, T2 > &	operator++ () noexcept
	Go to the next association, if it exists.
BijectionIteratorSafe< T1, T2 > &	operator+= (Size nb) noexcept
	Moves the iterator by nb elements.
BijectionIteratorSafe< T1, T2 >	operator+ (Size nb) noexcept
	Returns a new iterator.
bool	operator!= (const BijectionIteratorSafe< T1, T2 > &toCompare) const noexcept
	Inequality operator.
bool	operator== (const BijectionIteratorSafe< T1, T2 > &toCompare) const noexcept
	Equality operator.
Accessors/Modifiers
const T1 &	first () const
	Returns the first element of the current association.
const T2 &	second () const
	Returns the second element of the current association.

Private Types
using	Getter = BijectionIteratorGet< std::is_scalar< T1 >::value && std::is_scalar< T2 >::value >
	Dummy classes that will enable discriminate without overhead between scalars and non-scalars functions second in iterators.
using	HashTable12
	Alias for one of the internal gum::HashTable of the gum::Bijection.
using	HashIter = typename HashTable12::const_iterator_safe
	Alias for one of the internal gum::HastTableIterator of the gum::Bijection.

Private Member Functions
template<bool Gen>
	BijectionIteratorSafe (const BijectionImplementation< T1, T2, Gen > &bijection)
	Begin constructor.

Private Attributes
HashIter	_iter_
	The hashTable iterator that actually does all the job.

Friends
template<typename TT1, typename TT2, bool>
class	BijectionImplementation

Detailed Description

template<typename T1, typename T2>
class gum::BijectionIteratorSafe< T1, T2 >

Safe iterators for bijectionIterator.

Template Parameters

T1	The first type of elements in the gum::Bjection.
T2	The second type of elements in the gum::Bjection.

Definition at line 1240 of file bijection.h.

Member Typedef Documentation

◆ difference_type

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::difference_type = std::ptrdiff_t

types for STL compliance

Definition at line 1258 of file bijection.h.

◆ Getter

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::Getter = BijectionIteratorGet< std::is_scalar< T1 >::value && std::is_scalar< T2 >::value >

private

Dummy classes that will enable discriminate without overhead between scalars and non-scalars functions second in iterators.

Definition at line 1266 of file bijection.h.

◆ HashIter

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::HashIter = typename HashTable12::const_iterator_safe

private

Alias for one of the internal gum::HastTableIterator of the gum::Bijection.

Definition at line 1420 of file bijection.h.

◆ HashTable12

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::HashTable12

private

Initial value:

 
typename std::conditional< std::is_scalar< T1 >::value && std::is_scalar< T2 >::value,
                           HashTable< T1, T2 >,
                           HashTable< T1, T2* > >::type

Alias for one of the internal gum::HashTable of the gum::Bijection.

Definition at line 1413 of file bijection.h.

◆ iterator_category

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::iterator_category = std::forward_iterator_tag

types for STL compliance

Definition at line 1247 of file bijection.h.

◆ type1_const_pointer

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type1_const_pointer = const T1*

types for STL compliance

Definition at line 1252 of file bijection.h.

◆ type1_const_reference

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type1_const_reference = const T1&

types for STL compliance

Definition at line 1250 of file bijection.h.

◆ type1_pointer

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type1_pointer = T1*

types for STL compliance

Definition at line 1251 of file bijection.h.

◆ type1_reference

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type1_reference = T1&

types for STL compliance

Definition at line 1249 of file bijection.h.

◆ type1_type

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type1_type = T1

types for STL compliance

Definition at line 1248 of file bijection.h.

◆ type2_const_pointer

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type2_const_pointer = const T2*

types for STL compliance

Definition at line 1257 of file bijection.h.

◆ type2_const_reference

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type2_const_reference = const T2&

types for STL compliance

Definition at line 1255 of file bijection.h.

◆ type2_pointer

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type2_pointer = T2*

types for STL compliance

Definition at line 1256 of file bijection.h.

◆ type2_reference

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type2_reference = T2&

types for STL compliance

Definition at line 1254 of file bijection.h.

◆ type2_type

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::type2_type = T2

types for STL compliance

Definition at line 1253 of file bijection.h.

Constructor & Destructor Documentation

◆ BijectionIteratorSafe() [1/5]

template<typename T1, typename T2>

template<bool Gen>

gum::BijectionIteratorSafe< T1, T2 >::BijectionIteratorSafe ( const BijectionImplementation< T1, T2, Gen > & bijection )

private

Begin constructor.

Constructor.

By default, the iterator points to the starting point of the gum::Bijection.

Parameters

bijection The gum::Bijection to iterate onto.

Definition at line 823 of file bijection_tpl.h.

                                                               :
      _iter_{bijection._firstToSecond_.cbeginSafe()} {
    GUM_CONSTRUCTOR(BijectionIteratorSafe);
  }

References BijectionIteratorSafe(), _iter_, and BijectionImplementation.

Referenced by BijectionIteratorSafe(), BijectionIteratorSafe(), BijectionIteratorSafe(), BijectionIteratorSafe(), BijectionIteratorSafe(), ~BijectionIteratorSafe(), operator!=(), operator+(), operator++(), operator+=(), operator=(), operator=(), and operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BijectionIteratorSafe() [2/5]

template<typename T1, typename T2>

gum::BijectionIteratorSafe< T1, T2 >::BijectionIteratorSafe ( )

explicitnoexcept

Default constructor.

Definition at line 816 of file bijection_tpl.h.

                                                                  {
    GUM_CONSTRUCTOR(BijectionIteratorSafe);
  }

References BijectionIteratorSafe().

Here is the call graph for this function:

◆ BijectionIteratorSafe() [3/5]

template<typename T1, typename T2>

gum::BijectionIteratorSafe< T1, T2 >::BijectionIteratorSafe ( const Bijection< T1, T2 > & bijection )

Begin constructor.

Constructor.

By default, the iterator points to the starting point of the gum::Bijection.

Parameters

bijection The gum::Bijection to iterate onto.

Definition at line 831 of file bijection_tpl.h.

                                                                                             :
      _iter_{bijection._firstToSecond_.cbeginSafe()} {
    GUM_CONSTRUCTOR(BijectionIteratorSafe);
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ BijectionIteratorSafe() [4/5]

template<typename T1, typename T2>

gum::BijectionIteratorSafe< T1, T2 >::BijectionIteratorSafe ( const BijectionIteratorSafe< T1, T2 > & from )

Copy constructor.

Parameters

from	The gum::BijectionIteratorSafe to copy.

Definition at line 838 of file bijection_tpl.h.

                                                     : _iter_{toCopy._iter_} {
    GUM_CONS_CPY(BijectionIteratorSafe);
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ BijectionIteratorSafe() [5/5]

template<typename T1, typename T2>

gum::BijectionIteratorSafe< T1, T2 >::BijectionIteratorSafe ( BijectionIteratorSafe< T1, T2 > && from )

noexcept

Move constructor.

move constructor

Parameters

from	The gum::BijectionIteratorSafe to move.

Definition at line 845 of file bijection_tpl.h.

                                                       : _iter_{std::move(from._iter_)} {
    GUM_CONS_MOV(BijectionIteratorSafe);
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ ~BijectionIteratorSafe()

template<typename T1, typename T2>

gum::BijectionIteratorSafe< T1, T2 >::~BijectionIteratorSafe ( )

noexcept

Class destructor.

Destructor.

Definition at line 852 of file bijection_tpl.h.

                                                                   {
    GUM_DESTRUCTOR(BijectionIteratorSafe);
  }

References BijectionIteratorSafe().

Here is the call graph for this function:

Member Function Documentation

◆ first()

template<typename T1, typename T2>

const T1 & gum::BijectionIteratorSafe< T1, T2 >::first ( ) const

Returns the first element of the current association.

return the first element of the current association

Returns: Returns the first element of the current association.

Exceptions

UndefinedIteratorValue Raised when the iterator does not point to a valid element of the bijection.

Definition at line 906 of file bijection_tpl.h.

                                                         {
    return _iter_.key();
  }

References _iter_.

Referenced by operator=().

Here is the caller graph for this function:

◆ operator!=()

template<typename T1, typename T2>

bool gum::BijectionIteratorSafe< T1, T2 >::operator!= ( const BijectionIteratorSafe< T1, T2 > & toCompare ) const

noexcept

Inequality operator.

Comparison of iterators.

Parameters

toCompare The gum::BijectionIteratorSafe to compare.

Returns: Returns true if they differ.

Definition at line 892 of file bijection_tpl.h.

                                                                       {
    return _iter_ != toCompare._iter_;
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ operator+()

template<typename T1, typename T2>

BijectionIteratorSafe< T1, T2 > gum::BijectionIteratorSafe< T1, T2 >::operator+ ( Size nb )

noexcept

Returns a new iterator.

returns a new iterator

If the iterator points to end(), the resulting iterator also points to end (). If there are nb or fewer elements to parse to reach the end of the bijection, then the resulting iterator points to gum::BijectionIteratorSafe::end().

Parameters

nb	The number of steps by which the iterator moves.

Returns: Returns this gum::BijectionIteratorSafe.

Definition at line 886 of file bijection_tpl.h.

                                                                                             {
    return BijectionIteratorSafe< T1, T2 >{*this} += nb;
  }

References BijectionIteratorSafe().

Here is the call graph for this function:

◆ operator++()

template<typename T1, typename T2>

BijectionIteratorSafe< T1, T2 > & gum::BijectionIteratorSafe< T1, T2 >::operator++ ( )

noexcept

Go to the next association, if it exists.

Go to the next association (if exists).

If the iterator points to end(), nothing happens.

Returns: Returns this gum::BijectionIteratorSafe.

Definition at line 872 of file bijection_tpl.h.

                                                                                        {
    ++_iter_;
    return *this;
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ operator+=()

template<typename T1, typename T2>

BijectionIteratorSafe< T1, T2 > & gum::BijectionIteratorSafe< T1, T2 >::operator+= ( Size nb )

noexcept

Moves the iterator by nb elements.

moves the iterator by nb elements

If the iterator points to end(), nothing is done. If there are nb or fewer elements to parse to reach the end of the bijection, then this method makes the iterator point to gum::BijectionIteratorSafe::end().

Parameters

nb	The number of steps by which the iterator moves.

Returns: Returns this gum::BijectionIteratorSafe.

Definition at line 879 of file bijection_tpl.h.

                                                                                             {
    _iter_ += nb;
    return *this;
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename T1, typename T2>

BijectionIteratorSafe< T1, T2 > & gum::BijectionIteratorSafe< T1, T2 >::operator= ( BijectionIteratorSafe< T1, T2 > && toMove )

noexcept

Move operator.

move operator

Parameters

toMove The gum::BijectionIteratorSafe to move.

Returns: Returns this gum::BijectionIteratorSafe.

Definition at line 864 of file bijection_tpl.h.

                                                         {
    _iter_ = std::move(toCopy._iter_);
    return *this;
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename T1, typename T2>

BijectionIteratorSafe< T1, T2 > & gum::BijectionIteratorSafe< T1, T2 >::operator= ( const BijectionIteratorSafe< T1, T2 > & toCopy )

default

Copy operator.

Parameters

toCopy The gum::BijectionIteratorSafe to copy.

Returns: Returns this gum::BijectionIteratorSafe.

References BijectionIteratorSafe(), first(), and second().

Here is the call graph for this function:

◆ operator==()

template<typename T1, typename T2>

bool gum::BijectionIteratorSafe< T1, T2 >::operator== ( const BijectionIteratorSafe< T1, T2 > & toCompare ) const

noexcept

Equality operator.

Comparison of iterators.

Parameters

toCompare The gum::BijectionIteratorSafe to compare.

Returns: Returns true if they are equal.

Definition at line 899 of file bijection_tpl.h.

                                                                       {
    return _iter_ == toCompare._iter_;
  }

References BijectionIteratorSafe(), and _iter_.

Here is the call graph for this function:

◆ second()

template<typename T1, typename T2>

const T2 & gum::BijectionIteratorSafe< T1, T2 >::second ( ) const

Returns the second element of the current association.

return the second element of the current association

Returns: Returns the second element of the current association.

Exceptions

UndefinedIteratorValue Raised when the iterator does not point to a valid element of the bijection.

Definition at line 912 of file bijection_tpl.h.

                                                          {
    return Getter::op_second(_iter_.val());
  }

References _iter_, and gum::BijectionIteratorGet< gen >::op_second().

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BijectionImplementation

template<typename T1, typename T2>

template<typename TT1, typename TT2, bool>

friend class BijectionImplementation

friend

Definition at line 1242 of file bijection.h.

References BijectionImplementation.

Referenced by BijectionIteratorSafe(), and BijectionImplementation.

Member Data Documentation

◆ _iter_

template<typename T1, typename T2>

HashIter gum::BijectionIteratorSafe< T1, T2 >::_iter_

private

The hashTable iterator that actually does all the job.

Definition at line 1423 of file bijection.h.

Referenced by BijectionIteratorSafe(), BijectionIteratorSafe(), BijectionIteratorSafe(), BijectionIteratorSafe(), first(), operator!=(), operator++(), operator+=(), operator=(), operator==(), and second().

The documentation for this class was generated from the following files:

agrum/base/core/bijection.h
agrum/base/core/bijection_tpl.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ Getter

◆ HashIter

◆ HashTable12

◆ iterator_category

◆ type1_const_pointer

◆ type1_const_reference

◆ type1_pointer

◆ type1_reference

◆ type1_type

◆ type2_const_pointer

◆ type2_const_reference

◆ type2_pointer

◆ type2_reference

◆ type2_type

Constructor & Destructor Documentation

◆ BijectionIteratorSafe() [1/5]

◆ BijectionIteratorSafe() [2/5]

◆ BijectionIteratorSafe() [3/5]

◆ BijectionIteratorSafe() [4/5]

◆ BijectionIteratorSafe() [5/5]

◆ ~BijectionIteratorSafe()

Member Function Documentation

◆ first()

◆ operator!=()

◆ operator+()

◆ operator++()

◆ operator+=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ second()

Friends And Related Symbol Documentation

◆ BijectionImplementation

Member Data Documentation

◆ _iter_