Class to handle efficiently argMaxSet. More...

#include <agrum/tools/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 41 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 50 of file argMaxSet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                  {
     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::Set< Key, Alloc >::emplace().

                                                              {
     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::Set< Key, Alloc >::emplace().

                                                           {
     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 109 of file argMaxSet.h.

                                                              {
       return argMaxSeq__->beginSafe();
     }

◆ 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 116 of file argMaxSet.h.

                                                            {
       return argMaxSeq__->endSafe();
     }

◆ 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 188 of file argMaxSet.h.

                                                   {
       return argMaxSeq__->exists(elem);
     }

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

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

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

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

◆ 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 151 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 99 of file argMaxSet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call 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 110 of file argMaxSet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                 {
     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 159 of file argMaxSet.h.

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

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

◆ 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 167 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 73 of file argMaxSet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                 {
     this->argMaxSeq__->clear();
     this->operator+=(src);
     val__ = src.value();
     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

Compares two ArgMaxSet to check if they are equals.

Definition at line 121 of file argMaxSet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                         {
     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:

◆ 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 163 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 171 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 142 of file argMaxSet.h.

                                                         {
       return argMaxSeq__->atPos(i);
     }

◆ 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 181 of file argMaxSet.h.

181 { return argMaxSeq__->size(); }

gum::SequenceImplementation::size

Size size() const noexcept

Returns the size of the sequence.

Definition: sequence_tpl.h:37

gum::ArgMaxSet::argMaxSeq__

Sequence< GUM_SCALAR_SEQ > * argMaxSeq__

The very bone of the ArgMaxSet.

Definition: argMaxSet.h:194

◆ 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 186 of file argMaxSet.h.

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

186 { return val__; }

gum::ArgMaxSet::val__

GUM_SCALAR_VAL val__

Definition: argMaxSet.h:195

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 198 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 194 of file argMaxSet.h.

◆ 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 195 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/tools/core/argMaxSet.h
agrum/tools/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 >