Open CASCADE Technology  6.9.1
Data Structures | Public Types | Public Member Functions
NCollection_Map< TheKeyType, Hasher > Class Template Reference

#include <NCollection_Map.hxx>

Inheritance diagram for NCollection_Map< TheKeyType, Hasher >:
Inheritance graph
[legend]

Data Structures

class  Iterator
 Implementation of the Iterator interface. More...
 
class  MapNode
 Adaptation of the TListNode to the map notations. More...
 

Public Types

typedef NCollection_StlIterator< std::forward_iterator_tag, Iterator, TheKeyType, true > const_iterator
 Shorthand for a constant iterator type. More...
 

Public Member Functions

const_iterator cbegin () const
 Returns a const iterator pointing to the first element in the map. More...
 
const_iterator cend () const
 Returns a const iterator referring to the past-the-end element in the map. More...
 
 NCollection_Map (const Standard_Integer NbBuckets=1, const Handle< NCollection_BaseAllocator > &theAllocator=0L)
 Constructor. More...
 
 NCollection_Map (const NCollection_Map &theOther)
 Copy constructor. More...
 
void Exchange (NCollection_Map &theOther)
 Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well! More...
 
NCollection_MapAssign (const NCollection_Map &theOther)
 Assign. This method does not change the internal allocator. More...
 
NCollection_Mapoperator= (const NCollection_Map &theOther)
 Assign operator. More...
 
void ReSize (const Standard_Integer N)
 ReSize. More...
 
Standard_Boolean Add (const TheKeyType &K)
 Add. More...
 
const TheKeyType & Added (const TheKeyType &K)
 Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object. More...
 
Standard_Boolean Contains (const TheKeyType &K) const
 Contains. More...
 
Standard_Boolean Remove (const TheKeyType &K)
 Remove. More...
 
void Clear (const Standard_Boolean doReleaseMemory=Standard_True)
 Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused. More...
 
void Clear (const Handle< NCollection_BaseAllocator > &theAllocator)
 Clear data and reset allocator. More...
 
 ~NCollection_Map (void)
 Destructor. More...
 
Standard_Integer Size (void) const
 Size. More...
 
Boolean operations with maps as sets of keys
Standard_Boolean IsEqual (const NCollection_Map &theOther) const
 
Standard_Boolean Contains (const NCollection_Map &theOther) const
 
void Union (const NCollection_Map &theLeft, const NCollection_Map &theRight)
 Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands. More...
 
Standard_Boolean Unite (const NCollection_Map &theOther)
 Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed. More...
 
void Intersection (const NCollection_Map &theLeft, const NCollection_Map &theRight)
 Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands. More...
 
Standard_Boolean Intersect (const NCollection_Map &theOther)
 Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed. More...
 
void Subtraction (const NCollection_Map &theLeft, const NCollection_Map &theRight)
 Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared. More...
 
Standard_Boolean Subtract (const NCollection_Map &theOther)
 Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed. More...
 
void Difference (const NCollection_Map &theLeft, const NCollection_Map &theRight)
 Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands. More...
 
Standard_Boolean Differ (const NCollection_Map &theOther)
 Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed. More...
 
- Public Member Functions inherited from NCollection_BaseMap
Standard_Integer NbBuckets () const
 NbBuckets. More...
 
Standard_Integer Extent () const
 Extent. More...
 
Standard_Boolean IsEmpty () const
 IsEmpty. More...
 
void Statistics (Standard_OStream &S) const
 Statistics. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NCollection_BaseMap
 NCollection_BaseMap (const Standard_Integer NbBuckets, const Standard_Boolean single, const Handle< NCollection_BaseAllocator > &theAllocator)
 Constructor. More...
 
Standard_Boolean BeginResize (const Standard_Integer NbBuckets, Standard_Integer &NewBuckets, NCollection_ListNode **&data1, NCollection_ListNode **&data2) const
 BeginResize. More...
 
void EndResize (const Standard_Integer NbBuckets, const Standard_Integer NewBuckets, NCollection_ListNode **data1, NCollection_ListNode **data2)
 EndResize. More...
 
Standard_Boolean Resizable () const
 Resizable. More...
 
void Increment ()
 Increment. More...
 
void Decrement ()
 Decrement. More...
 
void Destroy (NCollection_DelMapNode fDel, Standard_Boolean doReleaseMemory=Standard_True)
 Destroy. More...
 
Standard_Integer NextPrimeForMap (const Standard_Integer N) const
 NextPrimeForMap. More...
 
void exchangeMapsData (NCollection_BaseMap &theOther)
 Exchange content of two maps without data copying. More...
 
- Protected Attributes inherited from NCollection_BaseMap
Handle< NCollection_BaseAllocatormyAllocator
 
NCollection_ListNode ** myData1
 
NCollection_ListNode ** myData2
 

Detailed Description

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
class NCollection_Map< TheKeyType, Hasher >

Purpose: Single hashed Map. This Map is used to store and retrieve keys in linear time.

The ::Iterator class can be used to explore the content of the map. It is not wise to iterate and modify a map in parallel.

To compute the hashcode of the key the function HashCode must be defined in the global namespace

To compare two keys the function IsEqual must be defined in the global namespace.

The performance of a Map is conditionned by its number of buckets that should be kept greater to the number of keys. This map has an automatic management of the number of buckets. It is resized when the number of Keys becomes greater than the number of buckets.

If you have a fair idea of the number of objects you can save on automatic resizing by giving a number of buckets at creation or using the ReSize method. This should be consider only for crucial optimisation issues.

Member Typedef Documentation

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
typedef NCollection_StlIterator<std::forward_iterator_tag, Iterator, TheKeyType, true> NCollection_Map< TheKeyType, Hasher >::const_iterator

Shorthand for a constant iterator type.

Constructor & Destructor Documentation

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
NCollection_Map< TheKeyType, Hasher >::NCollection_Map ( const Standard_Integer  NbBuckets = 1,
const Handle< NCollection_BaseAllocator > &  theAllocator = 0L 
)
inline

Constructor.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
NCollection_Map< TheKeyType, Hasher >::NCollection_Map ( const NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Copy constructor.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
NCollection_Map< TheKeyType, Hasher >::~NCollection_Map ( void  )
inline

Destructor.

Member Function Documentation

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Add ( const TheKeyType &  K)
inline

Add.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
const TheKeyType& NCollection_Map< TheKeyType, Hasher >::Added ( const TheKeyType &  K)
inline

Added: add a new key if not yet in the map, and return reference to either newly added or previously existing object.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
NCollection_Map& NCollection_Map< TheKeyType, Hasher >::Assign ( const NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Assign. This method does not change the internal allocator.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
const_iterator NCollection_Map< TheKeyType, Hasher >::cbegin ( ) const
inline

Returns a const iterator pointing to the first element in the map.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
const_iterator NCollection_Map< TheKeyType, Hasher >::cend ( ) const
inline

Returns a const iterator referring to the past-the-end element in the map.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::Clear ( const Standard_Boolean  doReleaseMemory = Standard_True)
inline

Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::Clear ( const Handle< NCollection_BaseAllocator > &  theAllocator)
inline

Clear data and reset allocator.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Contains ( const TheKeyType &  K) const
inline

Contains.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Contains ( const NCollection_Map< TheKeyType, Hasher > &  theOther) const
inline
Returns
true if this map contains ALL keys of another map.
template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Differ ( const NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Apply to this Map the symmetric difference (aka exclusive disjunction, boolean XOR) operation with another (given) Map. The result contains the values that are contained only in this or the operand map, but not in both. This algorithm is similar to method Difference(). Returns True if contents of this map is changed.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::Difference ( const NCollection_Map< TheKeyType, Hasher > &  theLeft,
const NCollection_Map< TheKeyType, Hasher > &  theRight 
)
inline

Sets this Map to be the result of symmetric difference (aka exclusive disjunction, boolean XOR) operation between two given Maps. The new Map contains the values that are contained only in the first or the second operand maps but not in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be used as one of operands.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::Exchange ( NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Intersect ( const NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Apply to this Map the intersection operation (aka multiplication, common, boolean AND) with another (given) Map. The result contains only the values that are contained in both this and the given maps. This algorithm is similar to method Intersection(). Returns True if contents of this map is changed.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::Intersection ( const NCollection_Map< TheKeyType, Hasher > &  theLeft,
const NCollection_Map< TheKeyType, Hasher > &  theRight 
)
inline

Sets this Map to be the result of intersection (aka multiplication, common, boolean AND) operation between two given Maps. The new Map contains only the values that are contained in both map operands. All previous content of this Map is cleared. This same map (result of the boolean operation) can also be used as one of operands.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::IsEqual ( const NCollection_Map< TheKeyType, Hasher > &  theOther) const
inline
Returns
true if two maps contains exactly the same keys
template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
NCollection_Map& NCollection_Map< TheKeyType, Hasher >::operator= ( const NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Assign operator.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Remove ( const TheKeyType &  K)
inline

Remove.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::ReSize ( const Standard_Integer  N)
inline

ReSize.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Integer NCollection_Map< TheKeyType, Hasher >::Size ( void  ) const
inline

Size.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Subtract ( const NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Apply to this Map the subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation with another (given) Map. The result contains only the values that were previously contained in this map and not contained in this map. This algorithm is similar to method Subtract() with two operands. Returns True if contents of this map is changed.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::Subtraction ( const NCollection_Map< TheKeyType, Hasher > &  theLeft,
const NCollection_Map< TheKeyType, Hasher > &  theRight 
)
inline

Sets this Map to be the result of subtraction (aka set-theoretic difference, relative complement, exclude, cut, boolean NOT) operation between two given Maps. The new Map contains only the values that are contained in the first map operands and not contained in the second one. All previous content of this Map is cleared.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
void NCollection_Map< TheKeyType, Hasher >::Union ( const NCollection_Map< TheKeyType, Hasher > &  theLeft,
const NCollection_Map< TheKeyType, Hasher > &  theRight 
)
inline

Sets this Map to be the result of union (aka addition, fuse, merge, boolean OR) operation between two given Maps The new Map contains the values that are contained either in the first map or in the second map or in both. All previous content of this Map is cleared. This map (result of the boolean operation) can also be passed as one of operands.

template<class TheKeyType, class Hasher = NCollection_DefaultHasher<TheKeyType>>
Standard_Boolean NCollection_Map< TheKeyType, Hasher >::Unite ( const NCollection_Map< TheKeyType, Hasher > &  theOther)
inline

Apply to this Map the boolean operation union (aka addition, fuse, merge, boolean OR) with another (given) Map. The result contains the values that were previously contained in this map or contained in the given (operand) map. This algorithm is similar to method Union(). Returns True if contents of this map is changed.


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