Safe iterators for bijectionIterator. More...

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

Public Member Functions
template<typename Alloc , bool Gen>
INLINE	BijectionIteratorSafe (const BijectionImplementation< T1, T2, Alloc, Gen > &bijection)
	Constructor. More...

template<typename Alloc >
INLINE	BijectionIteratorSafe (const Bijection< T1, T2, Alloc > &bijection)
	Constructor. More...

Constructors and destructors
	BijectionIteratorSafe () noexcept
	Default constructor. More...

template<typename Alloc >
	BijectionIteratorSafe (const Bijection< T1, T2, Alloc > &bijection)
	Genereliazed default constructor. More...

	BijectionIteratorSafe (const BijectionIteratorSafe< T1, T2 > &from)
	Copy constructor. More...

	BijectionIteratorSafe (BijectionIteratorSafe< T1, T2 > &&from) noexcept
	Move constructor. More...

	~BijectionIteratorSafe () noexcept
	Class destructor. More...

Operators
BijectionIteratorSafe< T1, T2 > &	operator= (const BijectionIteratorSafe< T1, T2 > &toCopy)
	Copy operator. More...

BijectionIteratorSafe< T1, T2 > &	operator= (BijectionIteratorSafe< T1, T2 > &&toMove) noexcept
	Move operator. More...

BijectionIteratorSafe< T1, T2 > &	operator++ () noexcept
	Go to the next association, if it exists. More...

BijectionIteratorSafe< T1, T2 > &	operator+= (Size nb) noexcept
	Moves the iterator by nb elements. More...

BijectionIteratorSafe< T1, T2 >	operator+ (Size nb) noexcept
	Returns a new iterator. More...

bool	operator!= (const BijectionIteratorSafe< T1, T2 > &toCompare) const noexcept
	Inequality operator. More...

bool	operator== (const BijectionIteratorSafe< T1, T2 > &toCompare) const noexcept
	Equality operator. More...

Accessors/Modifiers
const T1 &	first () const
	Returns the first element of the current association. More...

const T2 &	second () const
	Returns the second element of the current association. More...

Public Types

using	iterator_category = std::forward_iterator_tag
	types for STL compliance More...

using	type1_type = T1
	types for STL compliance More...

using	type1_reference = T1 &
	types for STL compliance More...

using	type1_const_reference = const T1 &
	types for STL compliance More...

using	type1_pointer = T1 *
	types for STL compliance More...

using	type1_const_pointer = const T1 *
	types for STL compliance More...

using	type2_type = T2
	types for STL compliance More...

using	type2_reference = T2 &
	types for STL compliance More...

using	type2_const_reference = const T2 &
	types for STL compliance More...

using	type2_pointer = T2 *
	types for STL compliance More...

using	type2_const_pointer = const T2 *
	types for STL compliance More...

using	difference_type = std::ptrdiff_t
	types for STL compliance More...

Friends
template<typename TT1 , typename TT2 , typename Alloc , 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 1410 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 1428 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 1437 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 1589 of file bijection.h.

◆ HashTable12

template<typename T1, typename T2>

using gum::BijectionIteratorSafe< T1, T2 >::HashTable12 = typename std::conditional< std::is_scalar< T1 >::value && std::is_scalar< T2 >::value, HashTable< T1, T2, std::allocator< std::pair< T1, T2 > > >, HashTable< T1, T2*, std::allocator< std::pair< T1, T2* > > > >::type

private

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

Definition at line 1585 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 1417 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 1422 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 1420 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 1421 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 1419 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 1418 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 1427 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 1425 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 1426 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 1424 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 1423 of file bijection.h.

Constructor & Destructor Documentation

◆ BijectionIteratorSafe() [1/7]

template<typename T1, typename T2>

template<typename Alloc , bool Gen>

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

private

Begin constructor.

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

Parameters

bijection The gum::Bijection to iterate onto.

◆ BijectionIteratorSafe() [2/7]

template<typename T1 , typename T2 >

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

noexcept

Default constructor.

Definition at line 929 of file bijection_tpl.h.

                                                                          {
     GUM_CONSTRUCTOR(BijectionIteratorSafe);
   }

◆ BijectionIteratorSafe() [3/7]

template<typename T1, typename T2>

template<typename Alloc >

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

Genereliazed default constructor.

Template Parameters

Alloc The gum::Bijection allocator's type.

◆ BijectionIteratorSafe() [4/7]

template<typename T1, typename T2>

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

Copy constructor.

Parameters

from	The gum::BijectionIteratorSafe to copy.

Definition at line 953 of file bijection_tpl.h.

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

◆ BijectionIteratorSafe() [5/7]

template<typename T1, typename T2>

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

noexcept

Move constructor.

move constructor

Parameters

from	The gum::BijectionIteratorSafe to move.

Definition at line 961 of file bijection_tpl.h.

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

◆ ~BijectionIteratorSafe()

template<typename T1 , typename T2 >

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

noexcept

Class destructor.

Destructor.

Definition at line 969 of file bijection_tpl.h.

                                                                           {
     GUM_DESTRUCTOR(BijectionIteratorSafe);
   }

◆ BijectionIteratorSafe() [6/7]

template<typename T1, typename T2>

template<typename Alloc , bool Gen>

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

Constructor.

Definition at line 936 of file bijection_tpl.h.

                                                                      :
       iter__{bijection.firstToSecond__.cbeginSafe()} {
     GUM_CONSTRUCTOR(BijectionIteratorSafe);
   }

◆ BijectionIteratorSafe() [7/7]

template<typename T1, typename T2>

template<typename Alloc >

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

Constructor.

Definition at line 945 of file bijection_tpl.h.

                                                   :
       iter__{bijection.firstToSecond__.cbeginSafe()} {
     GUM_CONSTRUCTOR(BijectionIteratorSafe);
   }

Member Function Documentation

◆ first()

template<typename T1 , typename T2 >

INLINE 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 1030 of file bijection_tpl.h.

                                                                 {
     return iter__.key();
   }

◆ operator!=()

template<typename T1, typename T2>

INLINE 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 1016 of file bijection_tpl.h.

                                                                       {
     return iter__ != toCompare.iter__;
   }

◆ operator+()

template<typename T1 , typename T2 >

INLINE 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 wich the iterator moves.

Returns: Returns this gum::BijectionIteratorSafe.

Definition at line 1010 of file bijection_tpl.h.

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

◆ operator++()

template<typename T1 , typename T2 >

INLINE 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 994 of file bijection_tpl.h.

                                                           {
     ++iter__;
     return *this;
   }

◆ operator+=()

template<typename T1 , typename T2 >

INLINE 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 wich the iterator moves.

Returns: Returns this gum::BijectionIteratorSafe.

Definition at line 1002 of file bijection_tpl.h.

                                                                  {
     iter__ += nb;
     return *this;
   }

◆ operator=() [1/2]

template<typename T1, typename T2>

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

Copy operator.

Parameters

toCopy The gum::BijectionIteratorSafe to copy.

Returns: Returns this gum::BijectionIteratorSafe.

Definition at line 976 of file bijection_tpl.h.

                                                        {
     iter__ = toCopy.iter__;
     return *this;
   }

◆ operator=() [2/2]

template<typename T1, typename T2>

INLINE 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 985 of file bijection_tpl.h.

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

◆ operator==()

template<typename T1, typename T2>

INLINE 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 1023 of file bijection_tpl.h.

                                                                       {
     return iter__ == toCompare.iter__;
   }

◆ second()

template<typename T1 , typename T2 >

INLINE 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 1036 of file bijection_tpl.h.

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

Friends And Related Function Documentation

◆ BijectionImplementation

template<typename T1, typename T2>

template<typename TT1 , typename TT2 , typename Alloc , bool >

friend class BijectionImplementation

friend

Definition at line 1412 of file bijection.h.

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 1592 of file bijection.h.

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

agrum/tools/core/bijection.h
agrum/tools/core/bijection_tpl.h

Public Member Functions

Public Types

Friends

Detailed Description

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

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/7]

◆ BijectionIteratorSafe() [2/7]

◆ BijectionIteratorSafe() [3/7]

◆ BijectionIteratorSafe() [4/7]

◆ BijectionIteratorSafe() [5/7]

◆ ~BijectionIteratorSafe()

◆ BijectionIteratorSafe() [6/7]

◆ BijectionIteratorSafe() [7/7]

Member Function Documentation

◆ first()

◆ operator!=()

◆ operator+()

◆ operator++()

◆ operator+=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ second()

Friends And Related Function Documentation

◆ BijectionImplementation

Member Data Documentation

◆ iter__

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