Classes | Public Member Functions | List of all members
operations_research::RevImmutableMultiMap< K, V > Class Template Reference

--— Immutable Multi Map --— More...

#include <constraint_solveri.h>

Public Member Functions

 RevImmutableMultiMap (Solver *const solver, int initial_size)
 
 ~RevImmutableMultiMap ()
 
int num_items () const
 
bool ContainsKey (const K &key) const
 Returns true if the multi-map contains at least one instance of 'key'. More...
 
const V & FindWithDefault (const K &key, const V &default_value) const
 Returns one value attached to 'key', or 'default_value' if 'key' is not in the multi-map. More...
 
void Insert (const K &key, const V &value)
 Inserts (key, value) in the multi-map. More...
 

Detailed Description

template<class K, class V>
class operations_research::RevImmutableMultiMap< K, V >

--— Immutable Multi Map --—

Reversible Immutable MultiMap class. Represents an immutable multi-map that backtracks with the solver.

Definition at line 294 of file constraint_solveri.h.

Constructor & Destructor Documentation

◆ RevImmutableMultiMap()

template<class K , class V >
operations_research::RevImmutableMultiMap< K, V >::RevImmutableMultiMap ( Solver *const  solver,
int  initial_size 
)
inline

Definition at line 296 of file constraint_solveri.h.

◆ ~RevImmutableMultiMap()

template<class K , class V >
operations_research::RevImmutableMultiMap< K, V >::~RevImmutableMultiMap ( )
inline

Definition at line 304 of file constraint_solveri.h.

Member Function Documentation

◆ ContainsKey()

template<class K , class V >
bool operations_research::RevImmutableMultiMap< K, V >::ContainsKey ( const K &  key) const
inline

Returns true if the multi-map contains at least one instance of 'key'.

Definition at line 309 of file constraint_solveri.h.

◆ FindWithDefault()

template<class K , class V >
const V& operations_research::RevImmutableMultiMap< K, V >::FindWithDefault ( const K &  key,
const V &  default_value 
) const
inline

Returns one value attached to 'key', or 'default_value' if 'key' is not in the multi-map.

The actual value returned if more than one values is attached to the same key is not specified.

Definition at line 324 of file constraint_solveri.h.

◆ Insert()

template<class K , class V >
void operations_research::RevImmutableMultiMap< K, V >::Insert ( const K &  key,
const V &  value 
)
inline

Inserts (key, value) in the multi-map.

Definition at line 337 of file constraint_solveri.h.

◆ num_items()

template<class K , class V >
int operations_research::RevImmutableMultiMap< K, V >::num_items ( ) const
inline

Definition at line 306 of file constraint_solveri.h.

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