Bucket for a chained list. More...

#include <agrum/core/list.h>

Public Member Functions
template<typename... Args>
INLINE	ListBucket (typename ListBucket< Val >::Emplace, Args &&... args)

Constructors / Destructors
	ListBucket ()=delete
	Removes empty constructor. More...

	ListBucket (const Val &v)
	Default constructor. More...

	ListBucket (Val &&v) noexcept
	Constructor for Val rvalues. More...

template<typename... Args>
	ListBucket (Emplace, Args &&... args)
	Emplace (universal) constructor. More...

	ListBucket (const ListBucket< Val > &src)
	Copy constructor. More...

	ListBucket (ListBucket< Val > &&src)=delete
	Move constructor should be useless. More...

	~ListBucket ()
	Class destructor. More...

Operators
ListBucket< Val > &	operator= (const ListBucket< Val > &src)
	Copy operator. More...

ListBucket< Val > &	operator= (ListBucket< Val > &&src)=delete
	Move operator. More...

bool	operator== (const ListBucket< Val > &src) const
	Equality check. More...

bool	operator!= (const ListBucket< Val > &src) const
	Inequality check. More...

Accessors / Modifiers
Val &	operator* () noexcept
	Dereferencing operator. More...

const Val &	operator* () const noexcept
	Dereferencing operator. More...

const ListBucket< Val > *	next () const noexcept
	Returns the bucket toward the next element. More...

const ListBucket< Val > *	previous () const noexcept
	Returns the bucket toward the preceding element. More...

Friends
template<typename T , typename A >
class	List
	All the list containers and iterators should be able to access the buckets. More...

class	ListIterator< Val >

class	ListConstIterator< Val >

class	ListIteratorSafe< Val >

class	ListConstIteratorSafe< Val >

Detailed Description

template<typename Val>
class gum::ListBucket< Val >

Bucket for a chained list.

In aGrUM, each box of a chained list is called a bucket. Lists are doubly linked bucket lists so as to enable efficient rbegin/rend iterators.

Warning: Values stored in buckets are ALWAYS COPIES.

Template Parameters

Val	The values type stored in the gum::ListBucket.

Definition at line 105 of file list.h.

Member Enumeration Documentation

◆ Emplace

template<typename Val>

enum gum::ListBucket::Emplace

strongprivate

C dummy type for the emplace constructor.

This type is used to prevent the list emplace (int) to compile.

Enumerator
EMPLACE

Definition at line 112 of file list.h.

112 { EMPLACE };

Constructor & Destructor Documentation

◆ ListBucket() [1/7]

template<typename Val>

gum::ListBucket< Val >::ListBucket ( )

delete

Removes empty constructor.

◆ ListBucket() [2/7]

template<typename Val>

INLINE gum::ListBucket< Val >::ListBucket ( const Val & v )

explicit

Default constructor.

Parameters

v	The value stored in the gum::ListBucket.

Definition at line 43 of file list_tpl.h.

                                                    : __val{v} {
     // for debugging purposes
     GUM_CONSTRUCTOR(ListBucket);
   }

◆ ListBucket() [3/7]

template<typename Val>

INLINE gum::ListBucket< Val >::ListBucket ( Val && v )

explicitnoexcept

Constructor for Val rvalues.

Parameters

v	The value stored in the gum::ListBucket.

Definition at line 50 of file list_tpl.h.

                                                        : __val{std::move(v)} {
     // for debugging purposes
     GUM_CONSTRUCTOR(ListBucket);
   }

◆ ListBucket() [4/7]

template<typename Val>

template<typename... Args>

gum::ListBucket< Val >::ListBucket	(	Emplace	,
		Args &&...	args
	)

explicit

Emplace (universal) constructor.

Template Parameters

Args	The emplace values type.

Parameters

args	The emplace values.

◆ ListBucket() [5/7]

template<typename Val>

INLINE gum::ListBucket< Val >::ListBucket ( const ListBucket< Val > & src )

Copy constructor.

Parameters

src	The gum::ListBucket to copy.

Definition at line 67 of file list_tpl.h.

                                                                    :
       __val{src.__val} {
     // for debugging purposes
     GUM_CONS_CPY(ListBucket);
   }

◆ ListBucket() [6/7]

template<typename Val>

gum::ListBucket< Val >::ListBucket ( ListBucket< Val > && src )

delete

Move constructor should be useless.

Parameters

src	The gum::ListBucket to move.

◆ ~ListBucket()

template<typename Val >

INLINE gum::ListBucket< Val >::~ListBucket ( )

Class destructor.

Warning: during its deletion, the bucket takes care of properly rechaining the chained list. However, it has no knowledge about the variables that keep track of the beginning/end of the chained list, hence it cannot update them properly. This should be done by the List itself.

Definition at line 88 of file list_tpl.h.

                                         {
     // for debugging purposes
     GUM_DESTRUCTOR(ListBucket);
   }

◆ ListBucket() [7/7]

template<typename Val>

template<typename... Args>

INLINE gum::ListBucket< Val >::ListBucket	(	typename ListBucket< Val >::Emplace	,
		Args &&...	args
	)

Definition at line 58 of file list_tpl.h.

                                                        :
       __val(std::forward< Args >(args)...) {
     // for debugging purposes
     GUM_CONSTRUCTOR(ListBucket);
   }

Member Function Documentation

◆ next()

template<typename Val >

INLINE const ListBucket< Val > * gum::ListBucket< Val >::next ( ) const

noexcept

Returns the bucket toward the next element.

Returns: Returns the bucket toward the next element.

Definition at line 119 of file list_tpl.h.

                                                                          {
     return __next;
   }

◆ operator!=()

template<typename Val>

INLINE bool gum::ListBucket< Val >::operator!= ( const ListBucket< Val > & src ) const

Inequality check.

Parameters

src	The gum::ListBucket to test for inequality.

Returns: Returns true if src and this gum::ListBucket are not equal.

Definition at line 101 of file list_tpl.h.

                                                                               {
     return (src.__val != __val);
   }

◆ operator*() [1/2]

template<typename Val >

INLINE Val & gum::ListBucket< Val >::operator* ( )

noexcept

Dereferencing operator.

Returns: The value stored in this gum::ListBucket.

Definition at line 113 of file list_tpl.h.

                                                     {
     return __val;
   }

◆ operator*() [2/2]

template<typename Val >

INLINE const Val & gum::ListBucket< Val >::operator* ( ) const

noexcept

Dereferencing operator.

Returns: The value stored in this gum::ListBucket.

Definition at line 107 of file list_tpl.h.

                                                                 {
     return __val;
   }

◆ operator=() [1/2]

template<typename Val>

INLINE ListBucket< Val > & gum::ListBucket< Val >::operator= ( const ListBucket< Val > & src )

Copy operator.

Parameters

src	The gum::ListBucket to copy.

Returns: This gum::ListBucket.

Definition at line 76 of file list_tpl.h.

                                                                     {
     // for debugging purposes
     GUM_OP_CPY(ListBucket);
 
     // no need to avoid self assignment
     __val = src.__val;
     return *this;
   }

◆ operator=() [2/2]

template<typename Val>

ListBucket< Val >& gum::ListBucket< Val >::operator= ( ListBucket< Val > && src )

delete

Move operator.

Parameters

src	The gum::ListBucket to move.

Returns: This gum::ListBucket.

◆ operator==()

template<typename Val>

INLINE bool gum::ListBucket< Val >::operator== ( const ListBucket< Val > & src ) const

Equality check.

Parameters

src	The gum::ListBucket to test for equality.

Returns: Returns true if src and this gum::ListBucket are equal.

Definition at line 95 of file list_tpl.h.

                                                                               {
     return (src.__val == __val);
   }

◆ previous()

template<typename Val >

INLINE const ListBucket< Val > * gum::ListBucket< Val >::previous ( ) const

noexcept

Returns the bucket toward the preceding element.

Returns: Returns the bucket toward the preceding element.

Definition at line 125 of file list_tpl.h.

                                                                              {
     return __prev;
   }

Friends And Related Function Documentation

◆ List

template<typename Val>

template<typename T , typename A >

friend class List

friend

All the list containers and iterators should be able to access the buckets.

Definition at line 236 of file list.h.

◆ ListConstIterator< Val >

template<typename Val>

friend class ListConstIterator< Val >

friend

Definition at line 238 of file list.h.

◆ ListConstIteratorSafe< Val >

template<typename Val>

friend class ListConstIteratorSafe< Val >

friend

Definition at line 240 of file list.h.

◆ ListIterator< Val >

template<typename Val>

friend class ListIterator< Val >

friend

Definition at line 237 of file list.h.

◆ ListIteratorSafe< Val >

template<typename Val>

friend class ListIteratorSafe< Val >

friend

Definition at line 239 of file list.h.

Member Data Documentation

◆ __next

template<typename Val>

ListBucket< Val >* gum::ListBucket< Val >::__next {nullptr}

private

Chaining toward the adjacent elements.

Definition at line 245 of file list.h.

◆ __prev

template<typename Val>

ListBucket< Val >* gum::ListBucket< Val >::__prev {nullptr}

private

Chaining toward the adjacent elements.

Definition at line 244 of file list.h.

Referenced by gum::List< const gum::Potential< GUM_SCALAR > * >::__copy_elements(), gum::List< const gum::Potential< GUM_SCALAR > * >::__erase(), gum::List< const gum::Potential< GUM_SCALAR > * >::__getIthBucket(), gum::List< const gum::Potential< GUM_SCALAR > * >::__insertAfter(), gum::List< const gum::Potential< GUM_SCALAR > * >::__insertBefore(), and gum::List< const gum::Potential< GUM_SCALAR > * >::__pushBack().

◆ __val

template<typename Val>

Val gum::ListBucket< Val >::__val

private

Val is the value contained in the box.

Definition at line 249 of file list.h.

Referenced by gum::List< const gum::Potential< GUM_SCALAR > * >::__insertAfter(), gum::List< const gum::Potential< GUM_SCALAR > * >::__insertBefore(), gum::List< const gum::Potential< GUM_SCALAR > * >::__pushBack(), gum::List< const gum::Potential< GUM_SCALAR > * >::__pushFront(), gum::ListBucket< const gum::Potential< GUM_SCALAR > *>::ListBucket(), gum::ListBucket< const gum::Potential< GUM_SCALAR > *>::operator!=(), gum::ListBucket< const gum::Potential< GUM_SCALAR > *>::operator=(), and gum::ListBucket< const gum::Potential< GUM_SCALAR > *>::operator==().

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

agrum/core/list.h
agrum/core/list_tpl.h

Public Member Functions

Friends

Detailed Description

template<typename Val> class gum::ListBucket< Val >

Member Enumeration Documentation

◆ Emplace

Constructor & Destructor Documentation

◆ ListBucket() [1/7]

◆ ListBucket() [2/7]

◆ ListBucket() [3/7]

◆ ListBucket() [4/7]

◆ ListBucket() [5/7]

◆ ListBucket() [6/7]

◆ ~ListBucket()

◆ ListBucket() [7/7]

Member Function Documentation

◆ next()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ previous()

Friends And Related Function Documentation

◆ List

◆ ListConstIterator< Val >

◆ ListConstIteratorSafe< Val >

◆ ListIterator< Val >

◆ ListIteratorSafe< Val >

Member Data Documentation

◆ __next

◆ __prev

◆ __val

template<typename Val>
class gum::ListBucket< Val >