Class to handle efficiently argMaxSet. More...

#include <agrum/multidim/patterns/argMaxSet.h>

Collaboration diagram for gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >:

Public Member Functions
Idx	size () const
	Gives the size. More...

const GUM_SCALAR_VAL &	value () const
	Returns the value on which comparison are made. More...

bool	exists (const GUM_SCALAR_SEQ &elem) const

CNL
	ArgMaxSet ()
	Constructor. More...

	ArgMaxSet (const GUM_SCALAR_VAL &val, const GUM_SCALAR_SEQ &elem)
	Constructor. More...

	ArgMaxSet (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &src)
	Copy Constructor. More...

ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &	operator= (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &src)
	Constructor. More...

	~ArgMaxSet ()
	Destructor. More...

void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...

void	operator delete (void *p)
	Constructor. More...

Iterators
SequenceIteratorSafe< GUM_SCALAR_SEQ >	beginSafe () const
	Iterator beginning. More...

SequenceIteratorSafe< GUM_SCALAR_SEQ >	endSafe () const
	Iterator end. More...

Operators
ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &	operator+= (const GUM_SCALAR_SEQ &elem)
	Ajout d'un élément. More...

ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &	operator+= (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &src)
	Use to insert the content of another set inside this one. More...

const GUM_SCALAR_SEQ &	operator[] (const Idx i) const
	Gives the ith element. More...

bool	operator== (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Compares two ArgMaxSet to check if they are equals. More...

bool	operator!= (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Ajout d'un élément. More...

bool	operator< (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Checks if val is lower or higher from the compared ArgMaxSet val. More...

bool	operator> (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Ajout d'un élément. More...

bool	operator<= (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Ajout d'un élément. More...

bool	operator>= (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Ajout d'un élément. More...

Friends
std::ostream &	operator<< (std::ostream &streamy, const ArgMaxSet &objy)

Detailed Description

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>
struct gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >

Class to handle efficiently argMaxSet.

A class containing the set of object assoicated to a maximum

This set contains the ids of the obj.

Definition at line 57 of file argMaxSet.h.

Constructor & Destructor Documentation

◆ ArgMaxSet() [1/3]

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::ArgMaxSet ( )

Constructor.

Definition at line 42 of file argMaxSet_tpl.h.

                                                          {
     GUM_CONSTRUCTOR(ArgMaxSet);
     __argMaxSeq = new Sequence< GUM_SCALAR_SEQ >();
   }

◆ ArgMaxSet() [2/3]

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::ArgMaxSet	(	const GUM_SCALAR_VAL &	val,
		const GUM_SCALAR_SEQ &	elem
	)

Constructor.

Definition at line 51 of file argMaxSet_tpl.h.

References gum::SequenceImplementation< Key, Alloc, Gen >::insert().

                                                             {
     GUM_CONSTRUCTOR(ArgMaxSet);
     __argMaxSeq = new Sequence< GUM_SCALAR_SEQ >();
     __argMaxSeq->insert(elem);
     __val = val;
   }

Here is the call graph for this function:

◆ ArgMaxSet() [3/3]

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::ArgMaxSet ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & src )

Copy Constructor.

Definition at line 63 of file argMaxSet_tpl.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator=(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::value().

                                                              {
     GUM_CONS_CPY(ArgMaxSet);
     __argMaxSeq = new Sequence< GUM_SCALAR_SEQ >();
     this->operator+=(src);
     __val = src.value();
   }

Here is the call graph for this function:

◆ ~ArgMaxSet()

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::~ArgMaxSet ( )

Destructor.

Definition at line 85 of file argMaxSet_tpl.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator+=().

                                                           {
     GUM_DESTRUCTOR(ArgMaxSet);
     delete __argMaxSeq;
   }

Here is the call graph for this function:

Member Function Documentation

◆ beginSafe()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

SequenceIteratorSafe< GUM_SCALAR_SEQ > gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::beginSafe ( ) const

inline

Iterator beginning.

Definition at line 108 of file argMaxSet.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__argMaxSeq, and gum::SequenceImplementation< Key, Alloc, Gen >::beginSafe().

Referenced by gum::StructuredPlaner< double >::__transferActionIds(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator+=(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator==().

                                                              {
       return __argMaxSeq->beginSafe();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ endSafe()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

SequenceIteratorSafe< GUM_SCALAR_SEQ > gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::endSafe ( ) const

inline

Iterator end.

Definition at line 115 of file argMaxSet.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__argMaxSeq, gum::SequenceImplementation< Key, Alloc, Gen >::endSafe(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator+=().

Referenced by gum::StructuredPlaner< double >::__transferActionIds(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator+=(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator==().

                                                            {
       return __argMaxSeq->endSafe();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

bool gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::exists ( const GUM_SCALAR_SEQ & elem ) const

inline

Definition at line 187 of file argMaxSet.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__argMaxSeq, and gum::SequenceImplementation< Key, Alloc, Gen >::exists().

Referenced by gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator==().

                                                   {
       return __argMaxSeq->exists(elem);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator delete()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

void gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator delete ( void * p )

inline

Constructor.

Definition at line 93 of file argMaxSet.h.

References gum::SmallObjectAllocator::deallocate(), and gum::SmallObjectAllocator::instance().

                                   {
       SmallObjectAllocator::instance().deallocate(
          p, sizeof(ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >));
     }

Here is the call graph for this function:

◆ operator new()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

void* gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator new ( size_t s )

inline

Allocators and Deallocators redefinition.

Definition at line 90 of file argMaxSet.h.

References gum::SmallObjectAllocator::allocate(), and gum::SmallObjectAllocator::instance().

                                  {
       return SmallObjectAllocator::instance().allocate(s);
     }

Here is the call graph for this function:

◆ operator!=()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

bool gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator!= ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & compared ) const

inline

Ajout d'un élément.

Definition at line 150 of file argMaxSet.h.

                                                                           {
       return !(*this == compared);
     }

◆ operator+=() [1/2]

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator+= ( const GUM_SCALAR_SEQ & elem )

Ajout d'un élément.

Definition at line 100 of file argMaxSet_tpl.h.

Referenced by gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::endSafe(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::~ArgMaxSet().

                                                {
     __argMaxSeq->insert(elem);
     return *this;
   }

Here is the caller graph for this function:

◆ operator+=() [2/2]

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator+= ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & src )

Use to insert the content of another set inside this one.

Definition at line 111 of file argMaxSet_tpl.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::beginSafe(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::endSafe().

                                                                            {
     for (auto iter = src.beginSafe(); iter != src.endSafe(); ++iter)
       if (!__argMaxSeq->exists(*iter)) __argMaxSeq->insert(*iter);
     return *this;
   }

Here is the call graph for this function:

◆ operator<()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

bool gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator< ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & compared ) const

inline

Checks if val is lower or higher from the compared ArgMaxSet val.

Definition at line 158 of file argMaxSet.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__val, and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::value().

                                                                           {
       return __val < compared.value() ? true : false;
     }

Here is the call graph for this function:

◆ operator<=()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

bool gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator<= ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & compared ) const

inline

Ajout d'un élément.

Definition at line 166 of file argMaxSet.h.

                                                                           {
       return !(*this > compared);
     }

◆ operator=()

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator= ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & src )

Constructor.

Definition at line 74 of file argMaxSet_tpl.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::value().

Referenced by gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::ArgMaxSet().

                                                                           {
     this->__argMaxSeq->clear();
     this->operator+=(src);
     __val = src.value();
     return *this;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator==()

template<typename GUM_SCALAR_VAL , typename GUM_SCALAR_SEQ >

bool gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator== ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & compared ) const

Compares two ArgMaxSet to check if they are equals.

Definition at line 121 of file argMaxSet_tpl.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::beginSafe(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::endSafe(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::exists(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::value().

Referenced by gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator[]().

                                                                         {
     if (__val != compared.value()) return false;
     for (auto iter = compared.beginSafe(); iter != compared.endSafe(); ++iter)
       if (!__argMaxSeq->exists(*iter)) return false;
     for (auto iter = this->beginSafe(); iter != this->endSafe(); ++iter)
       if (!compared.exists(*iter)) return false;
     return true;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator>()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

bool gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator> ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & compared ) const

inline

Ajout d'un élément.

Definition at line 162 of file argMaxSet.h.

                                                                           {
       return compared < *this;
     }

◆ operator>=()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

bool gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator>= ( const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > & compared ) const

inline

Ajout d'un élément.

Definition at line 170 of file argMaxSet.h.

                                                                           {
       return !(*this < compared);
     }

◆ operator[]()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

const GUM_SCALAR_SEQ& gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator[] ( const Idx i ) const

inline

Gives the ith element.

Definition at line 141 of file argMaxSet.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__argMaxSeq, gum::SequenceImplementation< Key, Alloc, Gen >::atPos(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator==().

                                                         {
       return __argMaxSeq->atPos(i);
     }

Here is the call graph for this function:

◆ size()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

Idx gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::size ( ) const

inline

Gives the size.

Definition at line 180 of file argMaxSet.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__argMaxSeq, and gum::SequenceImplementation< Key, Alloc, Gen >::size().

180 { return __argMaxSeq->size(); }

gum::SequenceImplementation::size

Size size() const noexcept

Returns the size of the sequence.

Definition: sequence_tpl.h:38

gum::ArgMaxSet::__argMaxSeq

Sequence< GUM_SCALAR_SEQ > * __argMaxSeq

The very bone of the ArgMaxSet.

Definition: argMaxSet.h:193

Here is the call graph for this function:

◆ value()

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

const GUM_SCALAR_VAL& gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::value ( ) const

inline

Returns the value on which comparison are made.

Definition at line 185 of file argMaxSet.h.

References gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__val.

Referenced by gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::ArgMaxSet(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator<(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator=(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator==().

185 { return __val; }

gum::ArgMaxSet::__val

GUM_SCALAR_VAL __val

Definition: argMaxSet.h:194

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

std::ostream& operator<<	(	std::ostream &	streamy,
		const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &	objy
	)

friend

Definition at line 197 of file argMaxSet.h.

                                                                               {
       streamy << "Value : " << objy.value()
               << " - Set : " << objy.__argMaxSeq->toString();
       return streamy;
     }

Member Data Documentation

◆ __argMaxSeq

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

Sequence< GUM_SCALAR_SEQ >* gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__argMaxSeq

private

The very bone of the ArgMaxSet.

Definition at line 193 of file argMaxSet.h.

Referenced by gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::beginSafe(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::endSafe(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::exists(), gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator[](), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::size().

◆ __val

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>

GUM_SCALAR_VAL gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::__val

private

Definition at line 194 of file argMaxSet.h.

Referenced by gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::operator<(), and gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >::value().

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

agrum/core/argMaxSet.h
agrum/core/argMaxSet_tpl.h

Public Member Functions

Friends

Detailed Description

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ> struct gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >

Constructor & Destructor Documentation

◆ ArgMaxSet() [1/3]

◆ ArgMaxSet() [2/3]

◆ ArgMaxSet() [3/3]

◆ ~ArgMaxSet()

Member Function Documentation

◆ beginSafe()

◆ endSafe()

◆ exists()

◆ operator delete()

◆ operator new()

◆ operator!=()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]()

◆ size()

◆ value()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ __argMaxSeq

◆ __val

template<typename GUM_SCALAR_VAL, typename GUM_SCALAR_SEQ>
struct gum::ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >