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 62 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 84 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 107 of file argMaxSet.h.

107 { return _argMaxSeq_->beginSafe(); }

gum::ArgMaxSet::_argMaxSeq_

Sequence< GUM_SCALAR_SEQ > * _argMaxSeq_

The very bone of the ArgMaxSet.

Definition: argMaxSet.h:177

gum::SequenceImplementation::beginSafe

iterator_safe beginSafe() const

Returns a safe begin iterator.

Definition: sequence_tpl.h:603

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

112 { return _argMaxSeq_->endSafe(); }

gum::SequenceImplementation::endSafe

const iterator_safe & endSafe() const noexcept

Returns the safe end iterator.

Definition: sequence_tpl.h:610

gum::ArgMaxSet::_argMaxSeq_

Sequence< GUM_SCALAR_SEQ > * _argMaxSeq_

The very bone of the ArgMaxSet.

Definition: argMaxSet.h:177

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

173 { return _argMaxSeq_->exists(elem); }

gum::ArgMaxSet::_argMaxSeq_

Sequence< GUM_SCALAR_SEQ > * _argMaxSeq_

The very bone of the ArgMaxSet.

Definition: argMaxSet.h:177

gum::SequenceImplementation::exists

bool exists(const Key &k) const

Check the existence of k in the sequence.

Definition: sequence_tpl.h:387

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

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

gum::SmallObjectAllocator::allocate

void * allocate(const size_t &objectSize)

Allocates a block.

Definition: smallObjectAllocator_inl.h:86

gum::SmallObjectAllocator::instance

static SmallObjectAllocator & instance()

Definition: smallObjectAllocator_inl.h:73

◆ 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 141 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 98 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 108 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 148 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 154 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 72 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 119 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 151 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 157 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 135 of file argMaxSet.h.

135 { return _argMaxSeq_->atPos(i); }

gum::ArgMaxSet::_argMaxSeq_

Sequence< GUM_SCALAR_SEQ > * _argMaxSeq_

The very bone of the ArgMaxSet.

Definition: argMaxSet.h:177

gum::SequenceImplementation::atPos

const Key & atPos(Idx i) const

Returns the object at the pos i.

Definition: sequence_tpl.h:483

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

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

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

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

171 { return _val_; }

gum::ArgMaxSet::_val_

GUM_SCALAR_VAL _val_

Definition: argMaxSet.h:178

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 181 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 177 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 178 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 >