Class to handle efficiently argMaxSet. More...

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

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

Public Member Functions
Idx	size () const
	Gives the size.
const GUM_SCALAR_VAL &	value () const
	Returns the value on which comparison are made.
bool	exists (const GUM_SCALAR_SEQ &elem) const
CNL
	ArgMaxSet ()
	Constructor.
	ArgMaxSet (const GUM_SCALAR_VAL &val, const GUM_SCALAR_SEQ &elem)
	Constructor.
	ArgMaxSet (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &src)
	Copy Constructor.
ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &	operator= (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &src)
	Constructor.
	~ArgMaxSet ()
	Destructor.
void *	operator new (size_t s)
	Allocators and Deallocators redefinition.
void	operator delete (void *p)
	Constructor.
Iterators
SequenceIteratorSafe< GUM_SCALAR_SEQ >	beginSafe () const
	Iterator beginning.
SequenceIteratorSafe< GUM_SCALAR_SEQ >	endSafe () const
	Iterator end.
Operators
ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &	operator+= (const GUM_SCALAR_SEQ &elem)
	Ajout d'un élément.
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.
const GUM_SCALAR_SEQ &	operator[] (const Idx i) const
	Gives the ith element.
bool	operator== (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Compares two ArgMaxSet to check if they are equals.
auto	operator<=> (const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ > &compared) const
	Ordering comparisons based on val (C++20 spaceship operator).

Private Attributes
Sequence< GUM_SCALAR_SEQ > *	_argMaxSeq_
	The very bone of the ArgMaxSet.
GUM_SCALAR_VAL	_val_

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

Detailed Description

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 78 of file argMaxSet.h.

Constructor & Destructor Documentation

◆ ArgMaxSet() [1/3]

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Constructor.

Definition at line 62 of file argMaxSet_tpl.h.

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

References ArgMaxSet(), and _argMaxSeq_.

Referenced by ArgMaxSet(), ArgMaxSet(), ArgMaxSet(), ~ArgMaxSet(), operator delete(), operator new(), operator+=(), operator<<, operator<=>(), operator=(), operator==(), and operator[]().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ArgMaxSet() [2/3]

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 71 of file argMaxSet_tpl.h.

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

References ArgMaxSet(), _argMaxSeq_, and _val_.

Here is the call graph for this function:

◆ ArgMaxSet() [3/3]

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 83 of file argMaxSet_tpl.h.

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

References ArgMaxSet(), _argMaxSeq_, _val_, gum::operator+=(), and value().

Here is the call graph for this function:

◆ ~ArgMaxSet()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Destructor.

Definition at line 105 of file argMaxSet_tpl.h.

                                                          {
    GUM_DESTRUCTOR(ArgMaxSet);
    delete _argMaxSeq_;
  }

References ArgMaxSet(), and _argMaxSeq_.

Here is the call graph for this function:

Member Function Documentation

◆ beginSafe()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Iterator beginning.

Definition at line 170 of file argMaxSet_tpl.h.

                                                                   {
    return _argMaxSeq_->beginSafe();
  }

References _argMaxSeq_.

Referenced by gum::StructuredPlaner< GUM_ELEMENT >::_transferActionIds_(), operator+=(), and operator==().

Here is the caller graph for this function:

◆ endSafe()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Iterator end.

Definition at line 176 of file argMaxSet_tpl.h.

                                                                 {
    return _argMaxSeq_->endSafe();
  }

References _argMaxSeq_.

Referenced by gum::StructuredPlaner< GUM_ELEMENT >::_transferActionIds_(), operator+=(), and operator==().

Here is the caller graph for this function:

◆ exists()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Definition at line 186 of file argMaxSet_tpl.h.

                                                                                           {
    return _argMaxSeq_->exists(elem);
  }

References _argMaxSeq_.

Referenced by operator==().

Here is the caller graph for this function:

◆ operator delete()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Constructor.

Definition at line 162 of file argMaxSet_tpl.h.

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

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

Here is the call graph for this function:

◆ operator new()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Allocators and Deallocators redefinition.

Definition at line 157 of file argMaxSet_tpl.h.

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

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

Here is the call graph for this function:

◆ operator+=() [1/2]

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 129 of file argMaxSet_tpl.h.

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

References ArgMaxSet(), _argMaxSeq_, beginSafe(), and endSafe().

Here is the call graph for this function:

◆ operator+=() [2/2]

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 119 of file argMaxSet_tpl.h.

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

References _argMaxSeq_.

◆ operator<=>()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Ordering comparisons based on val (C++20 spaceship operator).

Definition at line 151 of file argMaxSet_tpl.h.

                                                           =>(
      const ArgMaxSet< GUM_SCALAR_VAL, GUM_SCALAR_SEQ >& compared) const {
    return _val_ <=> compared.value();
  }

References ArgMaxSet(), and value().

Here is the call graph for this function:

◆ operator=()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 93 of file argMaxSet_tpl.h.

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

References ArgMaxSet(), _argMaxSeq_, _val_, gum::operator+=(), and value().

Here is the call graph for this function:

◆ operator==()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 140 of file argMaxSet_tpl.h.

                                                                         {
    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;
  }

References ArgMaxSet(), _argMaxSeq_, _val_, beginSafe(), endSafe(), exists(), and value().

Here is the call graph for this function:

◆ operator[]()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Gives the ith element.

References ArgMaxSet().

Here is the call graph for this function:

◆ size()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Gives the size.

Definition at line 191 of file argMaxSet_tpl.h.

                                                              {
    return _argMaxSeq_->size();
  }

References _argMaxSeq_.

◆ value()

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

Returns the value on which comparison are made.

Definition at line 181 of file argMaxSet_tpl.h.

                                                                                 {
    return _val_;
  }

References _val_.

Referenced by ArgMaxSet(), operator<<, operator<=>(), operator=(), and operator==().

Here is the caller graph for this function:

◆ operator<<

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

friend

Definition at line 185 of file argMaxSet.h.

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

References ArgMaxSet(), _argMaxSeq_, gum::SequenceImplementation< Key, std::is_scalar< Key >::value >::toString(), and value().

Member Data Documentation

◆ _argMaxSeq_

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric 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 181 of file argMaxSet.h.

Referenced by ArgMaxSet(), ArgMaxSet(), ArgMaxSet(), ~ArgMaxSet(), beginSafe(), endSafe(), exists(), operator+=(), operator+=(), operator<<, operator=(), operator==(), and size().

◆ _val_

template<GUM_Numeric GUM_SCALAR_VAL, GUM_Numeric GUM_SCALAR_SEQ>

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

private

Definition at line 182 of file argMaxSet.h.

Referenced by ArgMaxSet(), ArgMaxSet(), operator=(), operator==(), and value().

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

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

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ArgMaxSet() [1/3]

◆ ArgMaxSet() [2/3]

◆ ArgMaxSet() [3/3]

◆ ~ArgMaxSet()

Member Function Documentation

◆ beginSafe()

◆ endSafe()

◆ exists()

◆ operator delete()

◆ operator new()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator<=>()

◆ operator=()

◆ operator==()

◆ operator[]()

◆ size()

◆ value()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ _argMaxSeq_

◆ _val_