Bucket for a chained list. More...

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

Public Member Functions
template<typename... Args>
INLINE	ListBucket (typename ListBucket< Val >::Emplace, Args &&... args)
Constructors / Destructors
	ListBucket ()=delete
	Removes empty constructor.
	ListBucket (const Val &v)
	Default constructor.
	ListBucket (Val &&v) noexcept
	Constructor for Val rvalues.
template<typename... Args>
	ListBucket (Emplace, Args &&... args)
	Emplace (universal) constructor.
	ListBucket (const ListBucket< Val > &src)
	Copy constructor.
	ListBucket (ListBucket< Val > &&src)=delete
	Move constructor should be useless.
	~ListBucket ()
	Class destructor.
Operators
ListBucket< Val > &	operator= (const ListBucket< Val > &src)
	Copy operator.
ListBucket< Val > &	operator= (ListBucket< Val > &&src)=delete
	Move operator.
bool	operator== (const ListBucket< Val > &src) const
	Equality check.
bool	operator!= (const ListBucket< Val > &src) const
	Inequality check.
Accessors / Modifiers
Val &	operator* () noexcept
	Dereferencing operator.
const Val &	operator* () const noexcept
	Dereferencing operator.
const ListBucket< Val > *	next () const noexcept
	Returns the bucket toward the next element.
const ListBucket< Val > *	previous () const noexcept
	Returns the bucket toward the preceding element.

Private Types
enum class	Emplace { EMPLACE }
	C dummy type for the emplace constructor. More...

Private Attributes
Val	_val_
	Val is the value contained in the box.

ListBucket< Val > *	_prev_ {nullptr}
	Chaining toward the adjacent elements.
ListBucket< Val > *	_next_ {nullptr}
	Chaining toward the adjacent elements.

Friends
class	List< Val >
	All the list containers and iterators should be able to access the buckets.
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 114 of file list.h.

Member Enumeration Documentation

◆ Emplace

template<typename Val>

enum class 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 121 of file list.h.

121{ EMPLACE };

Constructor & Destructor Documentation

◆ ListBucket() [1/7]

template<typename Val>

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

delete

Removes empty constructor.

Referenced by ListBucket(), ListBucket(), ListBucket(), ListBucket(), ~ListBucket(), List< Val >, next(), operator!=(), operator=(), operator=(), operator==(), and previous().

Here is the caller graph for this function:

◆ 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 63 of file list_tpl.h.

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

References ListBucket(), and _val_.

Here is the call graph for this function:

◆ 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 70 of file list_tpl.h.

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

References _val_.

◆ 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.

References ListBucket().

Here is the call graph for this function:

◆ 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 86 of file list_tpl.h.

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

References ListBucket(), and _val_.

Here is the call graph for this function:

◆ 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.

References ListBucket().

Here is the call graph for this function:

◆ ~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 105 of file list_tpl.h.

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

References ListBucket().

Here is the call graph for this function:

◆ ListBucket() [7/7]

template<typename Val>

template<typename... Args>

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

Definition at line 78 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 136 of file list_tpl.h.

                                                                         {
    return _next_;
  }

References ListBucket(), and _next_.

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 118 of file list_tpl.h.

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

References ListBucket(), and _val_.

Here is the call graph for this function:

◆ operator*() [1/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 124 of file list_tpl.h.

                                                                {
    return _val_;
  }

References _val_.

◆ operator*() [2/2]

template<typename Val>

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

noexcept

Dereferencing operator.

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

Definition at line 130 of file list_tpl.h.

                                                    {
    return _val_;
  }

References _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 93 of file list_tpl.h.

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

References ListBucket(), and _val_.

Here is the call graph for this function:

◆ 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.

References ListBucket(), and next().

Here is the call graph for this function:

◆ 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 112 of file list_tpl.h.

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

References ListBucket(), and _val_.

Here is the call graph for this function:

◆ 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 142 of file list_tpl.h.

                                                                             {
    return _prev_;
  }

References ListBucket(), and _prev_.

Referenced by List< Val >.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ List< Val >

template<typename Val>

friend class List< Val >

friend

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

Definition at line 237 of file list.h.

References ListBucket(), and previous().

◆ ListConstIterator< Val >

template<typename Val>

friend class ListConstIterator< Val >

friend

Definition at line 237 of file list.h.

◆ ListConstIteratorSafe< Val >

template<typename Val>

friend class ListConstIteratorSafe< Val >

friend

Definition at line 237 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 237 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 253 of file list.h.

253{nullptr};

Referenced by gum::List< Val >::_copy_elements_(), gum::List< Val >::_erase_(), gum::List< Val >::_getIthBucket_(), gum::List< Val >::_insertAfter_(), gum::List< Val >::_insertBefore_(), gum::List< Val >::_pushFront_(), and next().

◆ _prev_

template<typename Val>

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

private

Chaining toward the adjacent elements.

Definition at line 252 of file list.h.

252{nullptr};

Referenced by gum::List< Val >::_copy_elements_(), gum::List< Val >::_erase_(), gum::List< Val >::_getIthBucket_(), gum::List< Val >::_insertAfter_(), gum::List< Val >::_insertBefore_(), gum::List< Val >::_pushBack_(), and previous().

◆ _val_

template<typename Val>

Val gum::ListBucket< Val >::_val_

private

Val is the value contained in the box.

Definition at line 257 of file list.h.

Referenced by ListBucket(), ListBucket(), ListBucket(), gum::List< Val >::_insertAfter_(), gum::List< Val >::_insertBefore_(), gum::List< Val >::_pushBack_(), gum::List< Val >::_pushFront_(), operator!=(), operator*(), operator*(), operator=(), and operator==().

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

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

Public Member Functions

Private Types

Private Attributes

Friends

Detailed Description

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 Symbol Documentation

◆ List< Val >

◆ ListConstIterator< Val >

◆ ListConstIteratorSafe< Val >

◆ ListIterator< Val >

◆ ListIteratorSafe< Val >

Member Data Documentation

◆ _next_

◆ _prev_

◆ _val_