gum::Set< Key > Class Template Reference

Representation of a set. More...

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

Collaboration diagram for gum::Set< Key >:

Public Types
using	value_type = Key
	Types for STL compliance.
using	reference = Key&
	Types for STL compliance.
using	const_reference = const Key&
	Types for STL compliance.
using	pointer = Key*
	Types for STL compliance.
using	const_pointer = const Key*
	Types for STL compliance.
using	size_type = std::size_t
	Types for STL compliance.
using	difference_type = std::ptrdiff_t
	Types for STL compliance.
using	iterator = SetIterator< Key >
	Types for STL compliance.
using	const_iterator = SetIterator< Key >
	Types for STL compliance.
using	iterator_safe = SetIteratorSafe< Key >
	Types for STL compliance.
using	const_iterator_safe = SetIteratorSafe< Key >
	Types for STL compliance.

Public Member Functions
Constructors / Destructors
	Set (Size capacity=HashTableConst::default_size, bool resize_policy=true)
	Default constructor.
	Set (std::initializer_list< Key > list)
	Initializer list constructor.
	Set (const Set< Key > &aHT)
	Copy constructor.
	Set (Set< Key > &&aHT) noexcept
	Move constructor.
	~Set ()
	Class destructor.
Operators
Set< Key > &	operator= (const Set< Key > &from)
	Copy operator.
Set< Key > &	operator= (Set< Key > &&from) noexcept
	Move operator.
bool	operator== (const Set< Key > &s2) const
	Mathematical equality between two sets.
const Set< Key > &	operator*= (const Set< Key > &s2)
	Intersection update operator.
Set< Key >	operator* (const Set< Key > &s2) const
	Intersection operator.
const Set< Key > &	operator+= (const Set< Key > &s2)
	Union update operator.
Set< Key >	operator+ (const Set< Key > &s2) const
	Union operator.
Set< Key >	operator- (const Set< Key > &s2) const
	Disjunction operator.
Set< Key > &	operator<< (const Key &k)
	Adds a new element to the set (alias for insert).
Set< Key > &	operator<< (Key &&k)
	Adds a new element to the set (alias for insert).
Set< Key > &	operator>> (const Key &k)
	Removes an element from the set (alias for erase).
Accessors / Modifiers
void	insert (const Key &k)
	Inserts a new element into the set.
void	insert (Key &&k)
	Inserts a new element into the set.
template<typename... Args>
void	emplace (Args &&... args)
	Emplace a new element in the set.
void	erase (const Key &k)
	Erases an element from the set.
Key	popFirst ()
	Removes and returns an arbitrary element from the set.
void	erase (const iterator_safe &k)
	Erases an element from the set.
void	clear ()
	Removes all the elements, if any, from the set.
Size	size () const noexcept
	Returns the number of elements in the set.
bool	contains (const Key &k) const
	Indicates whether a given elements belong to the set.
bool	isStrictSubsetOf (const Set< Key > &s) const
bool	isStrictSupersetOf (const Set< Key > &s) const
bool	isSubsetOrEqual (const Set< Key > &s) const
bool	isSupersetOrEqual (const Set< Key > &s) const
bool	exists (const Key &k) const
	Indicates whether a given elements belong to the set.
bool	empty () const noexcept
	Indicates whether the set is the empty set.
std::string	toString () const
	Prints the content of the set.
Fine tuning
Size	capacity () const
	Returns the capacity of the underlying hash table containing the set.
void	resize (Size new_capacity)
	Changes the size of the underlying hash table containing the set.
void	setResizePolicy (const bool new_policy)
	Enables the user to change dynamically the resizing policy of the underlying hash table.
bool	resizePolicy () const
	Returns the current resizing policy of the underlying hash table.
Mapper
template<typename NewKey>
HashTable< Key, NewKey >	hashMap (NewKey(*f)(const Key &), Size capacity=0) const
	Creates a hashtable of NewKey from the set.
template<typename NewKey>
HashTable< Key, NewKey >	hashMap (const NewKey &val, Size size=0) const
	Creates a hash table of NewKey from the set.
template<typename NewKey>
List< NewKey >	listMap (NewKey(*f)(const Key &)) const
	A method to create a List of NewKey from the set.

Private Member Functions
	Set (const HashTable< Key, bool > &h)
	Convert a hash table into a set of keys.

Private Attributes
HashTable< Key, bool >	_inside_
	A set of X's is actually a hash table whose keys are the X's.

Friends
class	SetIterator< Key >
	Friends to speed up access.
class	SetIteratorSafe< Key >
	Friends to speed up access.

Iterators
iterator_safe	beginSafe () const
	The usual safe begin iterator to parse the set.
const_iterator_safe	cbeginSafe () const
	The usual safe begin iterator to parse the set.
iterator	begin () const
	The usual unsafe begin iterator to parse the set.
const_iterator	cbegin () const
	The usual unsafe begin iterator to parse the set.
static const iterator_safe &	endSafe () noexcept
	The usual safe end iterator to parse the set.
static const const_iterator_safe &	cendSafe () noexcept
	The usual safe end iterator to parse the set.
static const iterator &	end () noexcept
	The usual unsafe end iterator to parse the set.
static const const_iterator &	cend () noexcept
	The usual unsafe end iterator to parse the set.

Detailed Description

template<typename Key>
class gum::Set< Key >

Representation of a set.

A Set is a structure that contains arbitrary elements. Note that, as in mathematics, an element cannot appear twice in a given set. Sets have unsafe and safe iterators. The safe iterators (SetIteratorSafe<> a.k.a. Set<>::iterator_safe are slightly slower than the unsafe ones (SetIterator<> a.k.a. Set<>::iterator) but they guarantee that even if they point to a deleted element, using their operators ++ or * cannot produce a segfault. In such cases, they simply raise an exception. On the contrary, unsafe iterators should never be used on elements that can be deleted because, as in the STL, they will most probably produce a segfault.

Usage example:

// creation of a set with 10 elements
Set<int> set;
for (int i = 0; i< 10; ++i)
  set<<i;
Set<int> set2 { 1, 2, 3 };
 
// parse the set
for (const auto iter = set.begin (); iter != set.end (); ++iter) {
  // display the values
  cerr <<  *iter << endl;
}
 
// use an iterator to point the element we wish to erase
Set<int>::iterator iter = set.begin ();
set.erase ( iter );
 
// check whether two iterators point toward the same element
Set<int>::iterator iter1 = set.begin();
Set<int>::iterator iter2 = set.end();
if (iter1 != iter2)
  cerr << "iter1 and iter2 point toward different elements";

Template Parameters

Key	The elements type.

Definition at line 129 of file set.h.

Member Typedef Documentation

const_iterator

template<typename Key>

using gum::Set< Key >::const_iterator = SetIterator< Key >

Types for STL compliance.

Definition at line 141 of file set.h.

const_iterator_safe

template<typename Key>

using gum::Set< Key >::const_iterator_safe = SetIteratorSafe< Key >

Types for STL compliance.

Definition at line 143 of file set.h.

const_pointer

template<typename Key>

using gum::Set< Key >::const_pointer = const Key*

Types for STL compliance.

Definition at line 137 of file set.h.

const_reference

template<typename Key>

using gum::Set< Key >::const_reference = const Key&

Types for STL compliance.

Definition at line 135 of file set.h.

difference_type

template<typename Key>

using gum::Set< Key >::difference_type = std::ptrdiff_t

Types for STL compliance.

Definition at line 139 of file set.h.

iterator

template<typename Key>

using gum::Set< Key >::iterator = SetIterator< Key >

Types for STL compliance.

Definition at line 140 of file set.h.

iterator_safe

template<typename Key>

using gum::Set< Key >::iterator_safe = SetIteratorSafe< Key >

Types for STL compliance.

Definition at line 142 of file set.h.

pointer

template<typename Key>

using gum::Set< Key >::pointer = Key*

Types for STL compliance.

Definition at line 136 of file set.h.

reference

template<typename Key>

using gum::Set< Key >::reference = Key&

Types for STL compliance.

Definition at line 134 of file set.h.

size_type

template<typename Key>

using gum::Set< Key >::size_type = std::size_t

Types for STL compliance.

Definition at line 138 of file set.h.

value_type

template<typename Key>

using gum::Set< Key >::value_type = Key

Types for STL compliance.

Definition at line 133 of file set.h.

Constructor & Destructor Documentation

Set() [1/5]

template<typename Key>

gum::Set< Key >::Set ( Size capacity = HashTableConst::default_size, bool resize_policy = true )

explicit

Default constructor.

Sets rely on hashtables to store their items. The optional parameters of this constructor enable a fine memory management of these hashtables.

Parameters

capacity	The number of slots allocated to the hashtable (see the HashTable default constructor)
resize_policy	Enables the hashtable to resize itself automatically when its number of elements is sufficiently high that it induces slow retrievals of elements.

Definition at line 277 of file set_tpl.h.

                                                   :
      // create the hash table without key uniqueness policy (as we will
      // check
      // ourselves the uniqueness of Keys before inserting new elements)
      _inside_(capacity, resize_policy, false) {
    GUM_CONSTRUCTOR(Set);
  }

References Set(), _inside_, and capacity().

Referenced by Set(), Set(), Set(), isStrictSubsetOf(), isStrictSupersetOf(), isSubsetOrEqual(), isSupersetOrEqual(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator=(), operator==(), and operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

Set() [2/5]

template<typename Key>

gum::Set< Key >::Set

(

std::initializer_list< Key >

list

)

Initializer list constructor.

Parameters

list	The initializer list.

Definition at line 287 of file set_tpl.h.

                                                 :
      _inside_(Size(list.size()) / 2, true, false) {
    GUM_CONSTRUCTOR(Set);
    for (const auto& elt: list) {
      insert(elt);
    }
  }

References _inside_, and size().

Here is the call graph for this function:

Set() [3/5]

template<typename Key>

gum::Set< Key >::Set

(

const Set< Key > &

aHT

)

Copy constructor.

Parameters

aHT	The gum::Set to copy.

Definition at line 297 of file set_tpl.h.

                                     : _inside_(s._inside_) {
    GUM_CONS_CPY(Set);
  }

References Set(), and _inside_.

Here is the call graph for this function:

Set() [4/5]

template<typename Key>

gum::Set< Key >::Set ( Set< Key > && aHT )

noexcept

Move constructor.

Parameters

aHT	The gum::Set to move.

Definition at line 303 of file set_tpl.h.

                                         : _inside_(std::move(s._inside_)) {
    GUM_CONS_MOV(Set);
  }

References Set(), and _inside_.

Here is the call graph for this function:

~Set()

template<typename Key>

gum::Set< Key >::~Set

(

)

Class destructor.

Set() [5/5]

template<typename Key>

gum::Set< Key >::Set ( const HashTable< Key, bool > & h )

explicitprivate

Convert a hash table into a set of keys.

Member Function Documentation

begin()

template<typename Key>

Set< Key >::iterator gum::Set< Key >::begin

(

)

const

The usual unsafe begin iterator to parse the set.

Returns

Returns the usual unsafe begin iterator to parse the set.

Definition at line 409 of file set_tpl.h.

                                                      {
    return SetIterator< Key >{*this};
  }

References SetIterator< Key >.

Referenced by gum::StaticTriangulation::_computeMaxPrimeMergings_(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::StaticTriangulation::_triangulate_(), gum::graph::ancestors(), gum::graph::areConnected(), gum::BarrenNodesFinder::barrenNodes(), gum::graph::chainComponent(), gum::graph::chainComponents(), gum::CausalModel< GUM_SCALAR >::connectedComponents(), gum::graph::connectedComponents(), gum::graph::descendants(), gum::prm::eliminateNode(), gum::ASTjointProba< GUM_SCALAR >::eval(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::moralizedAncestralGraph(), gum::CausalImpact< GUM_ELEMENT >::on(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), popFirst(), gum::learning::FCI::possibleDSepPhase_(), gum::prm::StructuredInference< GUM_SCALAR >::posterior_(), and gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_().

Here is the call graph for this function:

Here is the caller graph for this function:

beginSafe()

template<typename Key>

Set< Key >::iterator_safe gum::Set< Key >::beginSafe

(

)

const

The usual safe begin iterator to parse the set.

Returns

Returns The usual safe begin iterator to parse the set.

Definition at line 385 of file set_tpl.h.

                                                               {
    return SetIteratorSafe< Key >{*this};
  }

References SetIteratorSafe< Key >.

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_updateNodeSet_(), gum::LeafAggregator::addLeaf(), gum::BarrenNodesFinder::barrenNodes(), gum::EdgeGraphPart::eraseNeighbours(), gum::LeafAggregator::removeLeaf(), gum::VariableSelector::select(), gum::EdgeGraphPart::unvirtualizedEraseNeighbours(), gum::IMDDI< AttributeSelection, isScalar >::updateGraph(), and gum::LeafAggregator::updateLeaf().

Here is the call graph for this function:

Here is the caller graph for this function:

capacity()

template<typename Key>

Size gum::Set< Key >::capacity

(

)

const

Returns the capacity of the underlying hash table containing the set.

The method runs in constant time.

Returns

Returns the capacity of the underlying hash table containing the set.

Definition at line 433 of file set_tpl.h.

                                  {
    return _inside_.capacity();
  }

References _inside_.

Referenced by Set().

Here is the caller graph for this function:

cbegin()

template<typename Key>

Set< Key >::const_iterator gum::Set< Key >::cbegin

(

)

const

The usual unsafe begin iterator to parse the set.

Returns

Returns the usual unsafe begin iterator to parse the set.

Definition at line 415 of file set_tpl.h.

                                                             {
    return SetIterator< Key >{*this};
  }

References SetIterator< Key >.

Here is the call graph for this function:

cbeginSafe()

template<typename Key>

Set< Key >::const_iterator_safe gum::Set< Key >::cbeginSafe

(

)

const

The usual safe begin iterator to parse the set.

Returns

Returns the usual safe begin iterator to parse the set.

Definition at line 391 of file set_tpl.h.

                                                                      {
    return SetIteratorSafe< Key >{*this};
  }

References SetIteratorSafe< Key >.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::NodeDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

cend()

template<typename Key>

const Set< Key >::const_iterator & gum::Set< Key >::cend ( )

staticnoexcept

The usual unsafe end iterator to parse the set.

Returns

Returns the usual unsafe end iterator to parse the set.

Definition at line 427 of file set_tpl.h.

                                                                     {
    return *(static_cast< const SetIterator< Key >* >(_Set_end_));
  }

References SetIterator< Key >.

Here is the call graph for this function:

cendSafe()

template<typename Key>

const Set< Key >::const_iterator_safe & gum::Set< Key >::cendSafe ( )

staticnoexcept

The usual safe end iterator to parse the set.

Returns

Returns the usual safe end iterator to parse the set.

Definition at line 403 of file set_tpl.h.

                                                                              {
    return *(static_cast< const SetIteratorSafe< Key >* >(_Set_end_safe_));
  }

References SetIteratorSafe< Key >.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::NodeDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

template<typename Key>

void gum::Set< Key >::clear

(

)

Removes all the elements, if any, from the set.

Definition at line 315 of file set_tpl.h.

                         {
    // first we remove all the elements from the hashtable actually containing
    // the elements of the set. Note that, doing so, all the hashtable iterators
    // will be updated as well. In turn, this will imply that, whenever an
    // operation will be performed on a SetIteratorSafe, this will raise an
    // exception.
    _inside_.clear();
 
    // Note that actually there is no need to update the end iterator as this
    // one
    // is not affected by changes within hashtables (adding/deleting elements).
    // Hence, for speedup, we do not update the end iterator
  }

Referenced by gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::IMDDI< AttributeSelection, isScalar >::_updateNodeSet_(), gum::JointTargetedInference< GUM_SCALAR >::jointMutualInformation(), gum::JointTargetedMRFInference< GUM_SCALAR >::jointMutualInformation(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::dSeparationAlgorithm::requisiteNodes(), gum::ITI< AttributeSelection, isScalar >::updateGraph(), and gum::LeafAggregator::updateLeaf().

Here is the caller graph for this function:

contains()

template<typename Key>

bool gum::Set< Key >::contains

(

const Key &

k

)

const

Indicates whether a given elements belong to the set.

Returns

Returns true if a given elements belong to the set.

Definition at line 468 of file set_tpl.h.

                                              {
    return _inside_.exists(k);
  }

References _inside_.

Referenced by gum::DoCalculus< GUM_SCALAR >::_ancestorsIn_(), gum::DoCalculus< GUM_SCALAR >::_cDecomposition_(), gum::Tensor< GUM_SCALAR >::_complementVars_(), gum::StaticTriangulation::_computeMaxPrimeJunctionTree_(), gum::DoorCriteria::_existsUnblockedDirectedPath_(), gum::DoCalculus< GUM_SCALAR >::_ID_(), gum::prm::SVE< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVED< GUM_SCALAR >::_initElimOrder_(), gum::graph::_mcsVisitDn_(), gum::graph::_mcsVisitUp_(), gum::IMarkovRandomField< GUM_SCALAR >::_minimalCondSetVisit_(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::graph::ancestors(), gum::graph::areConnected(), gum::CausalModel< GUM_SCALAR >::backDoor(), gum::graph::chainComponent(), gum::graph::descendants(), gum::DoorCriteria::enumerateBackdoorSets(), gum::DoorCriteria::enumerateFrontdoorSets(), gum::MarginalTargetedInference< GUM_SCALAR >::evidenceImpact(), gum::MarginalTargetedMRFInference< GUM_SCALAR >::evidenceImpact(), gum::CausalModel< GUM_SCALAR >::frontDoor(), gum::DoCalculus< GUM_SCALAR >::getBackDoorTree(), gum::DoCalculus< GUM_SCALAR >::getFrontDoorTree(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::graph::hasDirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::Separation::isAncestorOf(), gum::Separation::isDescendantOf(), isStrictSubsetOf(), gum::learning::SimpleMiic::learnStructure(), gum::graph::minimalCondSet(), gum::IMarkovRandomField< GUM_SCALAR >::minimalCondSet(), gum::graph::moralGraph(), gum::graph::moralizedAncestralGraph(), gum::DoorCriteria::nodesOnDirectedPaths(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), gum::O3prmBNReader< GUM_SCALAR >::proceed(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::rec_hasMixedReallyOrientedPath(), gum::DoorCriteria::satisfiesBackdoorCriterion(), gum::DoorCriteria::satisfiesFrontdoorCriterion(), gum::Estimator< GUM_SCALAR >::setFromBN(), and gum::Estimator< GUM_SCALAR >::setFromLBP().

emplace()

template<typename Key>

template<typename... Args>

void gum::Set< Key >::emplace

(

Args &&...

args

)

Emplace a new element in the set.

Emplace is a method that allows to construct directly an element of type Key by passing to its constructor all the arguments it needs.

Parameters

args	the arguments passed to the constructor

Warning

if the set already contains the element, nothing is done. In particular, it is not added to the set and no exception is thrown.

Definition at line 547 of file set_tpl.h.

                                         {
    insert(std::move(Key(std::forward< Args >(args)...)));
  }

References insert().

Here is the call graph for this function:

empty()

template<typename Key>

bool gum::Set< Key >::empty ( ) const

noexcept

Indicates whether the set is the empty set.

Returns

Returns true if the set is empty.

Definition at line 613 of file set_tpl.h.

                                        {
    return _inside_.empty();
  }

References _inside_.

Referenced by gum::_dsepExplanation_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodesDownward_(), gum::DoCalculus< GUM_SCALAR >::_ID_(), gum::prm::SVE< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVED< GUM_SCALAR >::_initElimOrder_(), gum::DoorCriteria::_isMinimalFrontdoorAdjustment(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::VariableSelector::_removeVar_(), gum::graph::ancestors(), gum::graph::areConnected(), gum::graph::chainComponent(), gum::graph::chainComponents(), gum::CausalModel< GUM_SCALAR >::connectedComponents(), gum::graph::connectedComponents(), gum::graph::descendants(), gum::DoCalculus< GUM_SCALAR >::doCalculusWithObservation(), gum::DoorCriteria::enumerateBackdoorSets(), gum::DoorCriteria::enumerateFrontdoorSets(), gum::DoCalculus< GUM_SCALAR >::getBackDoorTree(), gum::DoCalculus< GUM_SCALAR >::getFrontDoorTree(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::learning::ConstraintBasedLearning::initGraph_(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::initialize_(), gum::JointTargetedInference< GUM_SCALAR >::jointPosterior(), gum::JointTargetedMRFInference< GUM_SCALAR >::jointPosterior(), gum::learning::SimpleMiic::learnPDAG(), gum::learning::SimpleMiic::learnStructure(), gum::graph::markovBlanket(), gum::Tensor< GUM_SCALAR >::maxIn(), gum::Tensor< GUM_SCALAR >::minIn(), gum::graph::moralGraph(), gum::graph::moralizedAncestralGraph(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::msgL_(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), popFirst(), gum::learning::IBNLearner::prepareFCI_(), gum::learning::IBNLearner::prepareMiic_(), gum::learning::IBNLearner::preparePC_(), gum::Tensor< GUM_SCALAR >::prodIn(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::refreshLMsPIs_(), gum::DoorCriteria::satisfiesFrontdoorCriterion(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::Tensor< GUM_SCALAR >::sumIn(), and gum::IncrementalGraphLearner< AttributeSelection, isScalar >::updateNode_().

end()

template<typename Key>

const Set< Key >::iterator & gum::Set< Key >::end ( )

staticnoexcept

The usual unsafe end iterator to parse the set.

Returns

Returns the usual unsafe end iterator to parse the set.

Definition at line 421 of file set_tpl.h.

                                                              {
    return *(static_cast< const SetIterator< Key >* >(_Set_end_));
  }

References SetIterator< Key >.

Referenced by gum::StaticTriangulation::_computeMaxPrimeMergings_(), gum::StaticTriangulation::_triangulate_(), gum::CausalImpact< GUM_ELEMENT >::on(), and gum::learning::FCI::possibleDSepPhase_().

Here is the call graph for this function:

Here is the caller graph for this function:

endSafe()

template<typename Key>

const Set< Key >::iterator_safe & gum::Set< Key >::endSafe ( )

staticnoexcept

The usual safe end iterator to parse the set.

Returns

Returns the usual safe end iterator to parse the set.

Definition at line 397 of file set_tpl.h.

                                                                       {
    return *(static_cast< const SetIteratorSafe< Key >* >(_Set_end_safe_));
  }

References SetIteratorSafe< Key >.

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_updateNodeSet_(), gum::LeafAggregator::addLeaf(), gum::BarrenNodesFinder::barrenNodes(), gum::EdgeGraphPart::eraseNeighbours(), gum::LeafAggregator::removeLeaf(), gum::VariableSelector::select(), gum::EdgeGraphPart::unvirtualizedEraseNeighbours(), gum::IMDDI< AttributeSelection, isScalar >::updateGraph(), and gum::LeafAggregator::updateLeaf().

Here is the call graph for this function:

Here is the caller graph for this function:

erase() [1/2]

template<typename Key>

void gum::Set< Key >::erase

(

const iterator_safe &

k

)

Erases an element from the set.

Parameters

k	The iterator pointing to the element to remove.

Warning

if the set does not contain the element, nothing is done. In particular, no exception is thrown.

Definition at line 574 of file set_tpl.h.

                                                           {
    // erase the element
    _inside_.erase(iter._ht_iter_);
 
    // Note that actually there is no need to update the end iterator as this
    // one
    // is not affected by changes within hashtables (adding/deleting elements).
    // Hence, for speedup, we do not update the end iterator
  }

References gum::SetIteratorSafe< Key >::_ht_iter_, _inside_, and SetIteratorSafe< Key >.

Here is the call graph for this function:

erase() [2/2]

template<typename Key>

void gum::Set< Key >::erase

(

const Key &

k

)

Erases an element from the set.

Parameters

k	The element to remove.

Warning

if the set does not contain the element, nothing is done. In particular, no exception is thrown.

Definition at line 553 of file set_tpl.h.

                                     {
    // erase the element (if it exists)
    _inside_.erase(k);
 
    // Note that actually there is no need to update the end iterator as this
    // one
    // is not affected by changes within hashtables (adding/deleting elements).
    // Hence, for speedup, we do not update the end iterator
  }

References _inside_.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_buildReduceGraph_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_elimination_cost_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::DoorCriteria::_isMinimalBackdoorAdjustment(), gum::DoorCriteria::_isMinimalFrontdoorAdjustment(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_(), gum::graph::ancestors(), gum::graph::areConnected(), gum::DoorCriteria::backdoorReach(), gum::BarrenNodesFinder::barrenNodes(), gum::graph::chainComponent(), gum::graph::chainComponents(), gum::graph::connectedComponents(), gum::Counterfactual< GUM_ELEMENT >::counterFactualModel(), gum::Counterfactual< GUM_ELEMENT >::counterFactualModel(), gum::counterfactualModel(), gum::graph::descendants(), gum::DoorCriteria::enumerateFrontdoorSets(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::moralizedAncestralGraph(), gum::DoorCriteria::nodesOnDirectedPaths(), operator>>(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), popFirst(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), and gum::ITI< AttributeSelection, isScalar >::updateGraph().

exists()

template<typename Key>

bool gum::Set< Key >::exists

(

const Key &

k

)

const

Indicates whether a given elements belong to the set.

Returns

Returns true if a given elements belong to the set.

Definition at line 504 of file set_tpl.h.

                                            {
    return _inside_.exists(k);
  }

References _inside_.

Referenced by gum::graph::_bayesBall_(), gum::prm::StructuredBayesBall< GUM_SCALAR >::_buildHashKey_(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::BinaryJoinTreeConverterDefault::_combinedSize_(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::_connect_(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::_directedPath_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::learning::ConstraintBasedLearning::_existsDirectedPath_(), gum::learning::SimpleMiic::_existsDirectedPath_(), gum::MeekRules::_existsDirectedPath_(), gum::prm::gspan::DFSTree< GUM_SCALAR >::_initialiaze_root_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::_is_connected_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeBarrenNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_(), gum::DAGCycleDetector::_restrictWeightedSet_(), gum::prm::GSpan< GUM_SCALAR >::_sortPatterns_(), gum::prm::SVE< GUM_SCALAR >::_variableElimination_(), gum::graph::areConnected(), gum::BarrenNodesFinder::barrenNodes(), gum::graph::dSeparated(), gum::prm::gspan::DFSTree< GUM_SCALAR >::growPattern(), gum::DAGCycleDetector::hasCycleFromModifications(), gum::DAGmodel::hasSameStructure(), gum::MarkovBlanket::hasSameStructure(), gum::UGmodel::hasSameStructure(), gum::Tensor< GUM_SCALAR >::maxOut(), gum::Tensor< GUM_SCALAR >::minOut(), gum::Tensor< GUM_SCALAR >::prodOut(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::dSeparationAlgorithm::requisiteNodes(), and gum::MixedGraph::toDot().

hashMap() [1/2]

template<typename Key>

template<typename NewKey>

HashTable< Key, NewKey > gum::Set< Key >::hashMap	(	const NewKey &	val,
		Size	size = 0 ) const

Creates a hash table of NewKey from the set.

Warning

The order in the resulting hash table may not be similar to that of the original set. Hence iterators on the former may not parse it in the same order as iterators on the latter.

Parameters

val	The value taken by all the elements of the resulting hashtable.
size	The size of the resulting hash table. When equal to 0, a default size is computed that is a good trade-off between space consumption and efficiency of new elements insertions.

Definition at line 745 of file set_tpl.h.

                                                                                 {
    // determine the proper size of the hashtable
    // by default, the size of the table is set so that the table does not take
    // too much space while allowing to add a few elements without resizing
    if (size == 0) size = std::max(Size(2), _inside_.size() / 2);
 
    // create a new table
    HashTable< Key, NewKey > table(size);
 
    // fill the new hash table
    for (HashTableConstIterator< Key, bool > iter = _inside_.cbegin(); iter != _inside_.cend();
         ++iter) {
      table.insert(iter.key(), val);
    }
 
    return table;
  }

References _inside_, and size().

Here is the call graph for this function:

hashMap() [2/2]

template<typename Key>

template<typename NewKey>

HashTable< Key, NewKey > gum::Set< Key >::hashMap	(	NewKey(*	f )(const Key &),
		Size	capacity = 0 ) const

Creates a hashtable of NewKey from the set.

Warning

The order in the resulting hashtable may not be similar to that of the original set. Hence, iterators on the former may not parse it in the same order as iterators on the latter.

Parameters

f	A function that maps Key into a NewKey
capacity	The size of the resulting hashtable. When equal to 0, a default size is computed that is a good trade-off between space consumption and efficiency of new elements insertions.

Definition at line 724 of file set_tpl.h.

                                                                                       {
    // determine the proper size of the hashtable
    // by default, the size of the table is set so that the table does not take
    // too much space while allowing to add a few elements without resizing
    if (size == 0) size = std::max(Size(2), _inside_.size() / 2);
 
    // create a new table
    HashTable< Key, NewKey > table(size);
 
    // fill the new hash table
    for (HashTableConstIterator< Key, bool > iter = _inside_.cbegin(); iter != _inside_.cend();
         ++iter) {
      table.insert(iter.key(), f(iter.key()));
    }
 
    return table;
  }

References _inside_, and size().

Here is the call graph for this function:

insert() [1/2]

template<typename Key>

void gum::Set< Key >::insert

(

const Key &

k

)

Inserts a new element into the set.

Parameters

k	The new element to insert.

Warning

if the set already contains the element, nothing is done. In particular, it is not added to the set and no exception is thrown.

Definition at line 510 of file set_tpl.h.

                                      {
    // WARNING: we shall always test whether k already belongs to the set before
    // trying to insert it because we set  _inside_'s key uniqueness policy to
    // false
    if (!contains(k)) {
      // insert the element
      _inside_.insert(k, true);
 
      // Note that actually there is no need to update the end iterator as this
      // one
      // is not affected by changes within hashtables (adding/deleting
      // elements).
      // Hence, for speedup, we do not update the end iterator
    }
  }

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::StructuredInference< GUM_SCALAR >::_addEdgesInReducedGraph_(), gum::DoCalculus< GUM_SCALAR >::_ancestorsIn_(), gum::graph::_bayesBall_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_buildReduceGraph_(), gum::DoCalculus< GUM_SCALAR >::_cDecomposition_(), gum::Tensor< GUM_SCALAR >::_complementVars_(), gum::ASTposteriorProba< GUM_SCALAR >::_compute_knw_from_bn(), gum::ASTposteriorProba< GUM_SCALAR >::_compute_knw_from_dag(), gum::StaticTriangulation::_computeRecursiveThinning_(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::_connect_(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::_directedPath_(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::_directedPath_(), gum::prm::SVE< GUM_SCALAR >::_eliminateDelayedVariables_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodesDownward_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesDownward_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesUpward_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_elimination_cost_(), gum::learning::ConstraintBasedLearning::_existsDirectedPath_(), gum::learning::SimpleMiic::_existsDirectedPath_(), gum::MeekRules::_existsDirectedPath_(), gum::DoorCriteria::_existsUnblockedDirectedPath_(), gum::prm::StructuredBayesBall< GUM_SCALAR >::_fillMaps_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClasses_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClasses_(), gum::DoCalculus< GUM_SCALAR >::_ID_(), gum::CausalImpact< GUM_SCALAR >::_idsToNames_(), gum::Counterfactual< GUM_ELEMENT >::_idsToNames_(), gum::prm::SVE< GUM_SCALAR >::_initElimOrder_(), gum::prm::SVED< GUM_SCALAR >::_initElimOrder_(), gum::prm::gspan::DFSTree< GUM_SCALAR >::_initialiaze_root_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initReqSets_(), gum::prm::SVE< GUM_SCALAR >::_insertEvidence_(), gum::prm::SVED< GUM_SCALAR >::_insertEvidence_(), gum::prm::SVE< GUM_SCALAR >::_insertLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_insertLiftedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::_is_connected_(), gum::OrderedEliminationSequenceStrategy::_isOrderNeeded_(), gum::MCBayesNetGenerator< GUM_SCALAR, SimpleCPTGenerator, SimpleCPTDisturber >::_isPolytree_(), gum::CausalImpact< GUM_SCALAR >::_namesToIds_(), gum::MeekRules::_orientDoubleHeadedArcs_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::StructuredInference< GUM_SCALAR >::_reduceAloneInstances_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeBarrenNodes_(), gum::prm::GSpan< GUM_SCALAR >::_sortPatterns_(), gum::CausalFormula< GUM_SCALAR >::_toNodeSetFromNames_(), gum::prm::StructuredInference< GUM_SCALAR >::_translatePotSet_(), gum::StaticTriangulation::_triangulate_(), gum::prm::SVE< GUM_SCALAR >::_variableElimination_(), gum::LeafAggregator::addLeaf(), gum::graph::ancestors(), gum::graph::areConnected(), gum::NodeGraphPart::asNodeSet(), gum::CausalModel< GUM_ELEMENT >::assumeNonSpurious(), gum::DoorCriteria::backdoorReach(), gum::BarrenNodesFinder::barrenNodes(), gum::BarrenNodesFinder::barrenNodes(), gum::BarrenNodesFinder::barrenTensors(), gum::graph::chainComponent(), gum::graph::chainComponents(), gum::BayesNetFragment< GUM_SCALAR >::checkConsistency(), gum::CausalModel< GUM_SCALAR >::connectedComponents(), gum::graph::connectedComponents(), gum::Counterfactual< GUM_ELEMENT >::counterFactualModel(), gum::Counterfactual< GUM_ELEMENT >::counterFactualModel(), gum::counterfactualModel(), gum::graph::cSeparated(), gum::graph::cSeparated(), gum::graph::descendants(), gum::DoCalculus< GUM_SCALAR >::doCalculusWithObservation(), gum::DoCalculus< GUM_SCALAR >::doCalculusWithObservation(), gum::graph::dSeparated(), gum::prm::eliminateNode(), emplace(), gum::DoorCriteria::enumerateBackdoorSets(), gum::DoorCriteria::enumerateFrontdoorSets(), gum::ASTjointProba< GUM_SCALAR >::eval(), gum::ASTposteriorProba< GUM_SCALAR >::eval(), gum::ASTsum< GUM_SCALAR >::eval(), gum::ASTsum< GUM_SCALAR >::fastToLatex(), gum::Tensor< GUM_SCALAR >::fillWith(), gum::Tensor< GUM_SCALAR >::findAll(), gum::DoCalculus< GUM_SCALAR >::getBackDoorTree(), gum::DoCalculus< GUM_SCALAR >::getBackDoorTree(), gum::DoCalculus< GUM_SCALAR >::getFrontDoorTree(), gum::DoCalculus< GUM_SCALAR >::getFrontDoorTree(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::prm::gspan::DFSTree< GUM_SCALAR >::growPattern(), gum::DoorCriteria::hasBackdoorPath(), gum::DAGCycleDetector::hasCycleFromModifications(), gum::graph::hasDirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::graph::hasUndirectedPath(), gum::DoCalculus< GUM_SCALAR >::identifyingIntervention(), gum::FMDPLearner< VariableAttributeSelection, RewardAttributeSelection, LearnerSelection >::initialize(), gum::Separation::isForwardSeparated(), gum::PartialOrderedEliminationSequenceStrategy::isPartialOrderNeeded_(), gum::JointTargetedInference< GUM_SCALAR >::jointMutualInformation(), gum::JointTargetedMRFInference< GUM_SCALAR >::jointMutualInformation(), gum::JointTargetedMRFInference< GUM_SCALAR >::jointPosterior(), gum::CausalModel< GUM_SCALAR >::latentVariablesIds(), gum::CausalModel< GUM_ELEMENT >::latentVariablesIds(), gum::DecisionTensor< GUM_SCALAR >::marginalization(), gum::graph::moralGraph(), gum::graph::moralizedAncestralGraph(), gum::GraphicalModel::nodeset(), gum::DoorCriteria::nodesOnDirectedPaths(), gum::IMarkovRandomField< GUM_SCALAR >::operator==(), gum::learning::ConstraintBasedLearning::orientDoubleHeadedArcs_(), gum::prm::StructuredInference< GUM_SCALAR >::posterior_(), gum::prm::SVE< GUM_SCALAR >::posterior_(), gum::prm::SVED< GUM_SCALAR >::posterior_(), gum::O3prmBNReader< GUM_SCALAR >::proceed(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::rec_hasMixedReallyOrientedPath(), gum::dSeparationAlgorithm::relevantTensors(), gum::dSeparationAlgorithm::requisiteNodes(), gum::DoorCriteria::satisfiesBackdoorCriterion(), gum::DoorCriteria::satisfiesFrontdoorCriterion(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::MixedGraph::toDot(), gum::IMDDI< AttributeSelection, isScalar >::updateGraph(), gum::ITI< AttributeSelection, isScalar >::updateGraph(), and gum::GraphicalModel::variables().

insert() [2/2]

template<typename Key>

void gum::Set< Key >::insert

(

Key &&

k

)

Inserts a new element into the set.

Parameters

k	The new element to insert.

Warning

if the set already contains the element, nothing is done. In particular, it is not added to the set and no exception is thrown.

Definition at line 528 of file set_tpl.h.

                                 {
    // WARNING: we shall always test whether k already belongs to the set before
    // trying to insert it because we set  _inside_'s key uniqueness policy to
    // false
    if (!contains(k)) {
      // insert the element
      _inside_.insert(std::move(k), true);
 
      // Note that actually there is no need to update the end iterator as this
      // one
      // is not affected by changes within hashtables (adding/deleting
      // elements).
      // Hence, for speedup, we do not update the end iterator
    }
  }

References _inside_, and gum::contains().

Here is the call graph for this function:

isStrictSubsetOf()

template<typename Key>

bool gum::Set< Key >::isStrictSubsetOf

(

const Set< Key > &

s

)

const

Returns

Returns true if *this is a proper subset of s

Definition at line 473 of file set_tpl.h.

                                                             {
    if (this->size() >= s.size()) { return false; }
 
    for (const auto& elt: *this) {
      if (!s.contains(elt)) { return false; }
    }
    return true;
  }

References Set(), contains(), and size().

Referenced by isStrictSupersetOf(), and gum::JointTargetedInference< GUM_SCALAR >::jointPosterior().

Here is the call graph for this function:

Here is the caller graph for this function:

isStrictSupersetOf()

template<typename Key>

bool gum::Set< Key >::isStrictSupersetOf

(

const Set< Key > &

s

)

const

Returns

Returns true if *this is a proper superset of s

Definition at line 483 of file set_tpl.h.

                                                               {
    return s.isStrictSubsetOf(*this);
  }

References Set(), and isStrictSubsetOf().

Here is the call graph for this function:

isSubsetOrEqual()

template<typename Key>

bool gum::Set< Key >::isSubsetOrEqual

(

const Set< Key > &

s

)

const

Returns

Returns true if *this is a subset of s (or equal to s)

Definition at line 488 of file set_tpl.h.

                                                            {
    if (this->size() > s.size()) { return false; }
 
    for (const auto& elt: *this) {
      if (!s.contains(elt)) { return false; }
    }
    return true;
  }

References Set().

Referenced by isSupersetOrEqual(), and gum::JointTargetedMRFInference< GUM_SCALAR >::superForJointComputable_().

Here is the call graph for this function:

Here is the caller graph for this function:

isSupersetOrEqual()

template<typename Key>

bool gum::Set< Key >::isSupersetOrEqual

(

const Set< Key > &

s

)

const

Returns

Returns true if *this is a superset of s (or equal to s)

Definition at line 498 of file set_tpl.h.

                                                              {
    return s.isSubsetOrEqual(*this);
  }

References Set(), and isSubsetOrEqual().

Here is the call graph for this function:

listMap()

template<typename Key>

template<typename NewKey>

List< NewKey > gum::Set< Key >::listMap

(

NewKey(*

f )(const Key &)

)

const

A method to create a List of NewKey from the set.

Warning

The order of the NewKey elements in the resulting list is arbitrary.

Parameters

f	A function that maps a Key into a NewKey

Definition at line 766 of file set_tpl.h.

                                                                  {
    // create a new list
    List< NewKey > list;
 
    // fill the new list
    for (HashTableConstIterator< Key, bool > iter = _inside_.cbegin(); iter != _inside_.cend();
         ++iter) {
      list.pushBack(f(iter.key()));
    }
 
    return list;
  }

References _inside_, and gum::List< Val >::pushBack().

Here is the call graph for this function:

operator*()

template<typename Key>

Set< Key > gum::Set< Key >::operator*

(

const Set< Key > &

s2

)

const

Intersection operator.

Parameters

s2	The gum::Set to intersect.

Returns

Returns a Set containing the elements belonging both to this and s2.

Definition at line 619 of file set_tpl.h.

                                                             {
    Set< Key >                    res;
    const HashTable< Key, bool >& h2  = s2._inside_;
    HashTable< Key, bool >&       h_r = res._inside_;
 
    if (size() < h2.size()) {
      for (HashTableConstIterator< Key, bool > iter = _inside_.cbegin(); iter != _inside_.cend();
           ++iter) {
        if (h2.exists(iter.key())) h_r.insert(iter.key(), true);
      }
    } else {
      for (HashTableConstIterator< Key, bool > iter = h2.cbegin(); iter != h2.cend(); ++iter) {
        if (_inside_.exists(iter.key())) h_r.insert(iter.key(), true);
      }
    }
 
    return res;
  }

References Set().

Here is the call graph for this function:

operator*=()

template<typename Key>

const Set< Key > & gum::Set< Key >::operator*=

(

const Set< Key > &

s2

)

Intersection update operator.

Parameters

s2	The gum::Set to intersect.

Returns

Returns this. Now this contains the elements belonging both to this and s2.

Definition at line 640 of file set_tpl.h.

                                                             {
    if (&s2 != this) {
      const HashTable< Key, bool >& h2 = s2._inside_;
      for (auto iter = _inside_.beginSafe(); iter != _inside_.endSafe(); ++iter) {
        if (!h2.exists(iter.key())) _inside_.erase(iter);
      }
    }
 
    return *this;
  }

References Set(), _inside_, and gum::HashTable< Key, Val >::exists().

Here is the call graph for this function:

operator+()

template<typename Key>

Set< Key > gum::Set< Key >::operator+

(

const Set< Key > &

s2

)

const

Union operator.

Parameters

s2	The gum::Set to union.

Returns

Returns a new Set containing the union of the elements of this and s2.

Definition at line 665 of file set_tpl.h.

                                                             {
    Set< Key >                    res = *this;
    const HashTable< Key, bool >& h2  = s2._inside_;
    HashTable< Key, bool >&       h_r = res._inside_;
 
    for (HashTableConstIterator< Key, bool > iter = h2.cbegin(); iter != h2.cend(); ++iter) {
      if (!h_r.exists(iter.key())) h_r.insert(iter.key(), true);
    }
 
    return res;
  }

References Set(), _inside_, gum::HashTable< Key, Val >::cbegin(), gum::HashTable< Key, Val >::cend(), gum::HashTable< Key, Val >::exists(), and gum::HashTable< Key, Val >::insert().

Here is the call graph for this function:

operator+=()

template<typename Key>

const Set< Key > & gum::Set< Key >::operator+=

(

const Set< Key > &

s2

)

Union update operator.

Parameters

s2	The gum::Set to update

Returns

Returns this. Now this contains the elements belonging both to this or to s2.

Definition at line 653 of file set_tpl.h.

                                                             {
    if (&s2 != this) {
      for (auto pair: s2._inside_) {
        if (!_inside_.exists(pair.first)) { _inside_.insert(pair.first, true); }
      }
    }
 
    return *this;
  }

References Set(), and _inside_.

Here is the call graph for this function:

operator-()

template<typename Key>

Set< Key > gum::Set< Key >::operator-

(

const Set< Key > &

s2

)

const

Disjunction operator.

Parameters

s2	The gum::Set to disjunct.

Returns

Returns a Set whose elements belong to this but not to s2.

Warning

Unlike + and *, the - operator is not commutative!

Definition at line 679 of file set_tpl.h.

                                                             {
    Set< Key >                    res;
    const HashTable< Key, bool >& h2  = s2._inside_;
    HashTable< Key, bool >&       h_r = res._inside_;
 
    for (HashTableConstIterator< Key, bool > iter = _inside_.cbegin(); iter != _inside_.cend();
         ++iter)
      if (!h2.exists(iter.key())) h_r.insert(iter.key(), true);
 
    return res;
  }

References Set(), _inside_, gum::HashTable< Key, Val >::exists(), and gum::HashTable< Key, Val >::insert().

Here is the call graph for this function:

operator<<() [1/2]

template<typename Key>

Set< Key > & gum::Set< Key >::operator<<

(

const Key &

k

)

Adds a new element to the set (alias for insert).

Parameters

k	The new element to add.

Returns

Returns this gum::Set.

Definition at line 574 of file set_tpl.h.

                                                 {
    insert(k);
    return *this;
  }

operator<<() [2/2]

template<typename Key>

Set< Key > & gum::Set< Key >::operator<<

(

Key &&

k

)

Adds a new element to the set (alias for insert).

Parameters

k	The new element to add.

Returns

Returns this gum::Set.

Definition at line 574 of file set_tpl.h.

                                            {
    insert(std::move(k));
    return *this;
  }

operator=() [1/2]

template<typename Key>

Set< Key > & gum::Set< Key >::operator=

(

const Set< Key > &

from

)

Copy operator.

Parameters

from	The gum::Set to copy.

Returns

Returns this gum::Set.

Definition at line 331 of file set_tpl.h.

                                                     {
    // avoid self assignment
    if (&s != this) {
      // remove the old content of the set. Actually, we remove all the elements
      // from the underlying hashtable. Note that, doing so, all the hashtable
      // iterators will be updated as well. In turn, this will imply that,
      // whenever
      // an operation will be performed on a SetIteratorSafe, this will raise an
      // exception.
      clear();
 
      // prepare the set for its new data
      resize(s.capacity());
      setResizePolicy(s.resizePolicy());
 
      // copy the set
      _inside_ = s._inside_;
 
      // Note that actually there is no need to update the end iterator as this
      // one
      // is not affected by changes within hashtables (adding/deleting
      // elements).
      // Hence, for speedup, we do not update the end iterator
    }
 
    return *this;
  }

References Set().

Here is the call graph for this function:

operator=() [2/2]

template<typename Key>

Set< Key > & gum::Set< Key >::operator= ( Set< Key > && from )

noexcept

Move operator.

Parameters

from	The gum::Set to move.

Returns

Returns this gum::Set.

Definition at line 361 of file set_tpl.h.

                                                            {
    if (this != &from) { _inside_ = std::move(from._inside_); }
    return *this;
  }

operator==()

template<typename Key>

bool gum::Set< Key >::operator==

(

const Set< Key > &

s2

)

const

Mathematical equality between two sets.

Parameters

s2	The gum::Set to test for equality.

Returns

Returns true if both gum::Set are equal.

Definition at line 368 of file set_tpl.h.

                                                      {
    const HashTable< Key, bool >& h2 = s2._inside_;
 
    // check whether both sets have the same number of elements
    if (size() != h2.size()) { return false; }
 
    // check the content of the sets
    for (HashTableConstIterator< Key, bool > iter = _inside_.cbegin(); iter != _inside_.cend();
         ++iter) {
      if (!h2.exists(iter.key())) { return false; }
    }
 
    return true;
  }

References Set(), and _inside_.

Here is the call graph for this function:

operator>>()

template<typename Key>

Set< Key > & gum::Set< Key >::operator>>

(

const Key &

k

)

Removes an element from the set (alias for erase).

Parameters

k	The element to remove.

Returns

Return this gum::Set.

Definition at line 600 of file set_tpl.h.

                                                 {
    erase(k);
    return *this;
  }

References Set(), and erase().

Here is the call graph for this function:

popFirst()

template<typename Key>

Key gum::Set< Key >::popFirst

(

)

Removes and returns an arbitrary element from the set.

Exceptions

NotFound

Raised if the set is empty.

Returns

The removed element.

Definition at line 564 of file set_tpl.h.

                           {
    if (this->empty()) { GUM_ERROR(NotFound, "Cannot popFirst from an empty set"); }
 
    auto key = *this->begin();
    this->erase(key);
    return key;
  }

References begin(), empty(), erase(), and GUM_ERROR.

Referenced by gum::graph::moralGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

resize()

template<typename Key>

void gum::Set< Key >::resize

(

Size

new_capacity

)

Changes the size of the underlying hash table containing the set.

See gum::HashTable::resize(Size) method resize for more details.

Parameters

new_capacity

The underlying hash table new size.

Definition at line 439 of file set_tpl.h.

                                       {
    _inside_.resize(new_size);
 
    // Note that actually there is no need to update the end iterator as this
    // one
    // is not affected by changes within hashtables (adding/deleting elements).
    // Hence, for speedup, we do not update the end iterator
  }

References _inside_.

Referenced by gum::StaticTriangulation::_triangulate_().

Here is the caller graph for this function:

resizePolicy()

template<typename Key>

bool gum::Set< Key >::resizePolicy

(

)

const

Returns the current resizing policy of the underlying hash table.

Returns

Returns the current resizing policy of the underlying hash table.

Definition at line 462 of file set_tpl.h.

                                      {
    return _inside_.resizePolicy();
  }

References _inside_.

setResizePolicy()

template<typename Key>

void gum::Set< Key >::setResizePolicy

(

const bool

new_policy

)

Enables the user to change dynamically the resizing policy of the underlying hash table.

When new_policy is false, the set will not try to change its memory size, hence resulting in tensorly slower accesses.

Parameters

new_policy

If true the set updates dynamically its memory consumption to guarantee that its elements are fast to retrieve.

Definition at line 451 of file set_tpl.h.

                                                        {
    _inside_.setResizePolicy(new_policy);
 
    // Note that actually there is no need to update the end iterator as this
    // one
    // is not affected by changes within hashtables (adding/deleting elements).
    // Hence, for speedup, we do not update the end iterator
  }

References _inside_.

size()

template<typename Key>

Size gum::Set< Key >::size ( ) const

noexcept

Returns the number of elements in the set.

Returns

Returns the number of elements in the set.

Definition at line 607 of file set_tpl.h.

                                       {
    return _inside_.size();
  }

References _inside_.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), Set(), gum::BinaryJoinTreeConverterDefault::_convertClique_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodesInSource_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_elimination_cost_(), gum::prm::ClusteredLayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::prm::LayerGenerator< GUM_SCALAR >::_generateClassDag_(), gum::DoCalculus< GUM_SCALAR >::_ID_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_(), gum::OrderedEliminationSequenceStrategy::_isOrderNeeded_(), gum::MeekRules::_propagatesOrientationInChainOfRemainingEdges_(), gum::prm::StructuredInference< GUM_SCALAR >::_reduceAloneInstances_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), gum::DoCalculus< GUM_SCALAR >::_topoObserved_(), gum::StaticTriangulation::_triangulate_(), gum::AggregatorDecomposition< GUM_SCALAR >::addDepthLayer_(), gum::BarrenNodesFinder::barrenNodes(), gum::AggregatorDecomposition< GUM_SCALAR >::decomposeAggregator_(), gum::prm::eliminateNode(), gum::ASTjointProba< GUM_SCALAR >::eval(), gum::StaticTriangulation::fillIns(), gum::DoCalculus< GUM_SCALAR >::getBackDoorTree(), gum::DoCalculus< GUM_SCALAR >::getFrontDoorTree(), hashMap(), hashMap(), gum::learning::Miic::initiation_(), gum::learning::SimpleMiic::initiation_(), gum::Separation::isBackdoorSeparated(), gum::PartialOrderedEliminationSequenceStrategy::isPartialOrderNeeded_(), isStrictSubsetOf(), gum::Tensor< GUM_SCALAR >::maxOut(), gum::Tensor< GUM_SCALAR >::minOut(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::msgL_(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::msgP_(), operator<<(), gum::prm::StructuredInference< GUM_SCALAR >::posterior_(), gum::Tensor< GUM_SCALAR >::prodOut(), gum::learning::SimpleMiic::propagatesOrientationInChainOfRemainingEdges_(), gum::DAGCycleDetector::setDAG(), and gum::StaticTriangulation::triangulatedGraph().

toString()

template<typename Key>

std::string gum::Set< Key >::toString

(

)

const

Prints the content of the set.

Returns

Returns the content of the set.

Definition at line 693 of file set_tpl.h.

                                       {
    std::stringstream out;
    bool              first = true;
    out << "{";
 
    for (iterator iter = begin(); iter != end(); ++iter) {
      if (first) {
        out << *iter;
        first = false;
      } else {
        out << "," << *iter;
      }
    }
 
    out << "}";
 
    std::string res;
    out >> res;
    return res;
  }

Referenced by gum::operator<<().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

SetIterator< Key >

template<typename Key>

friend class SetIterator< Key >

friend

Friends to speed up access.

Definition at line 537 of file set.h.

Referenced by begin(), cbegin(), cend(), and end().

SetIteratorSafe< Key >

template<typename Key>

friend class SetIteratorSafe< Key >

friend

Friends to speed up access.

Definition at line 537 of file set.h.

Referenced by beginSafe(), cbeginSafe(), cendSafe(), endSafe(), and erase().

Member Data Documentation

_inside_

template<typename Key>

HashTable< Key, bool > gum::Set< Key >::_inside_

private

A set of X's is actually a hash table whose keys are the X's.

Definition at line 549 of file set.h.

Referenced by Set(), Set(), Set(), Set(), capacity(), contains(), empty(), erase(), erase(), exists(), hashMap(), hashMap(), insert(), listMap(), operator*=(), operator+(), operator+=(), operator-(), operator==(), resize(), resizePolicy(), setResizePolicy(), and size().

---

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

• agrum/base/core/set.h
• agrum/base/core/set_tpl.h