Root class of all the maps, provides utilitites
for managing the buckets.
Maps are dynamically extended data structures where
data is quickly accessed with a key.
General properties of maps
More...

#include <TCollection_BasicMap.hxx>

Inherited by AIS2D_DataMapOfIOStatus, AIS2D_DataMapOfLC, AIS2D_DataMapOfLocStat, AIS2D_DataMapOfPrimAspects, AIS_DataMapOfILC, AIS_DataMapofIntegerListOfinteractive, AIS_DataMapOfIOStatus, AIS_DataMapOfSelStat, AIS_IndexedDataMapOfOwnerPrs, AIS_MapOfInteractive, BinMDF_TypeADriverMap, BinMDF_TypeIdMap, BiTgte_DataMapOfShapeBox, BooleanOperations_IndexedDataMapOfShapeAncestorsSuccessors, BooleanOperations_IndexedDataMapOfShapeInteger, BOP_IndexedDataMapOfEdgeListFaceInfo, BOP_IndexedDataMapOfSolidClassifier, BOP_IndexedDataMapOfVertexListEdgeInfo, BOPTColStd_IndexedDataMapOfIntegerIndexedMapOfInteger, BOPTColStd_IndexedDataMapOfIntegerInteger, BOPTColStd_IndexedDataMapOfSWRInteger, BOPTools_IDMapOfPaveBlockIMapOfInteger, BOPTools_IDMapOfPaveBlockIMapOfPaveBlock, BOPTools_IMapOfPaveBlock, BOPTools_IndexedDataMapOfIntegerDEInfo, BOPTools_IndexedDataMapOfIntegerPaveSet, BOPTools_IndexedDataMapOfIntegerState, BOPTools_IndexedDataMapOfShapeWithState, BOPTools_IndexedMapOfCoupleOfInteger, BRepAlgo_DataMapOfShapeBoolean, BRepAlgo_DataMapOfShapeInterference, BRepCheck_DataMapOfShapeListOfStatus, BRepCheck_DataMapOfShapeResult, BRepClass3d_MapOfInter, BRepFill_DataMapOfNodeDataMapOfShapeShape, BRepFill_DataMapOfNodeShape, BRepFill_DataMapOfOrientedShapeListOfShape, BRepFill_DataMapOfShapeDataMapOfShapeListOfShape, BRepFill_DataMapOfShapeSequenceOfPnt, BRepFill_DataMapOfShapeSequenceOfReal, BRepFill_IndexedDataMapOfOrientedShapeListOfShape, BRepMAT2d_DataMapOfBasicEltShape, BRepMAT2d_DataMapOfShapeSequenceOfBasicElt, BRepMesh_DataMapOfFaceAttribute, BRepMesh_DataMapOfIntegerListOfInteger, BRepMesh_DataMapOfIntegerListOfXY, BRepMesh_DataMapOfIntegerPnt, BRepMesh_DataMapOfShapePairOfPolygon, BRepMesh_DataMapOfShapeReal, BRepMesh_DataMapOfVertexInteger, BRepMesh_IDMapOfLinkOfDataStructureOfDelaun, BRepMesh_IDMapOfNodeOfDataStructureOfDelaun, BRepMesh_IMapOfElementOfDataStructureOfDelaun, BRepMesh_IndexedMapOfVertex, BRepOffset_DataMapOfShapeListOfInterval, BRepOffset_DataMapOfShapeMapOfShape, BRepOffset_DataMapOfShapeOffset, BRepTools_MapOfVertexPnt2d, BRepTopAdaptor_MapOfShapeTool, CDM_MapOfDocument, CDM_MetaDataLookUpTable, CDM_PresentationDirectory, ChFiDS_IndexedDataMapOfVertexListOfStripe, ChFiKPart_RstMap, DNaming_DataMapOfShapeOfName, Draft_DataMapOfEdgeEdgeInfo, Draft_DataMapOfFaceFaceInfo, Draft_DataMapOfVertexVertexInfo, Draw_MapOfAsciiString, Draw_MapOfFunctions, Draw_VMap, Expr_MapOfNamedUnknown, Geom2dHatch_HatchingsOfHatcher, Geom2dHatch_MapOfElementsOfElementsOfHatcher, GraphDS_EntityRoleMap, Graphic3d_MapOfStructure, HLRTopoBRep_DataMapOfShapeFaceData, HLRTopoBRep_MapOfShapeListOfVData, Image_ColorPixelDataMap, Image_LookupTable, Interface_DataMapOfTransientInteger, Interface_IndexedMapOfAsciiString, IntPoly_IndexedMapOfPnt, IntPoly_IndexedMapOfPnt2d, IntTools_DataMapOfCurveSampleBox, IntTools_DataMapOfSurfaceSampleBox, IntTools_IndexedDataMapOfTransientAddress, IntTools_MapOfCurveSample, IntTools_MapOfSurfaceSample, LocOpe_DataMapOfShapePnt, MAT2d_DataMapOfBiIntInteger, MAT2d_DataMapOfBiIntSequenceOfInteger, MAT2d_DataMapOfIntegerBisec, MAT2d_DataMapOfIntegerConnexion, MAT2d_DataMapOfIntegerPnt2d, MAT2d_DataMapOfIntegerSequenceOfConnexion, MAT2d_DataMapOfIntegerVec2d, MAT_DataMapOfIntegerArc, MAT_DataMapOfIntegerBasicElt, MAT_DataMapOfIntegerBisector, MAT_DataMapOfIntegerNode, MDF_TypeARDriverMap, MDF_TypeASDriverMap, MDF_TypeDriverListMapOfARDriverTable, MDF_TypeDriverListMapOfASDriverTable, MeshVS_DataMapOfColorMapOfInteger, MeshVS_DataMapOfHArray1OfSequenceOfInteger, MeshVS_DataMapOfIntegerAsciiString, MeshVS_DataMapOfIntegerBoolean, MeshVS_DataMapOfIntegerColor, MeshVS_DataMapOfIntegerMaterial, MeshVS_DataMapOfIntegerMeshEntityOwner, MeshVS_DataMapOfIntegerOwner, MeshVS_DataMapOfIntegerTwoColors, MeshVS_DataMapOfIntegerVector, MeshVS_DataMapOfTwoColorsMapOfInteger, MeshVS_MapOfTwoNodes, MoniTool_DataMapOfShapeTransient, MoniTool_DataMapOfTimer, MoniTool_IndexedDataMapOfShapeTransient, Plugin_MapOfFunctions, Prs2d_DataMapOfAspectRoot, PTColStd_DoubleMapOfTransientPersistent, PTColStd_PersistentTransientMap, PTColStd_TransientPersistentMap, Resource_DataMapOfAsciiStringAsciiString, Resource_DataMapOfAsciiStringExtendedString, SelectMgr_DataMapOfIntegerSensitive, SelectMgr_DataMapOfObjectSelectors, SelectMgr_DataMapOfSelectionActivation, SelectMgr_IndexedDataMapOfOwnerCriterion, SelectMgr_IndexedMapOfOwner, ShapeAnalysis_DataMapOfShapeListOfReal, ShapeExtend_DataMapOfShapeListOfMsg, ShapeExtend_DataMapOfTransientListOfMsg, ShapeFix_DataMapOfShapeBox2d, StdSelect_IndexedDataMapOfOwnerPrs, STEPCAFControl_DataMapOfLabelExternFile, STEPCAFControl_DataMapOfLabelShape, STEPCAFControl_DataMapOfPDExternFile, STEPCAFControl_DataMapOfSDRExternFile, STEPCAFControl_DataMapOfShapePD, STEPCAFControl_DataMapOfShapeSDR, STEPConstruct_DataMapOfAsciiStringTransient, STEPConstruct_DataMapOfPointTransient, StepToTopoDS_DataMapOfRI, StepToTopoDS_DataMapOfRINames, StepToTopoDS_DataMapOfTRI, StepToTopoDS_PointEdgeMap, StepToTopoDS_PointVertexMap, Storage_MapOfCallBack, Storage_MapOfPers, Storage_PType, TColgp_DataMapOfIntegerCirc2d, TColStd_DataMapOfAsciiStringInteger, TColStd_DataMapOfIntegerInteger, TColStd_DataMapOfIntegerListOfInteger, TColStd_DataMapOfIntegerReal, TColStd_DataMapOfIntegerTransient, TColStd_DataMapOfStringInteger, TColStd_DataMapOfTransientTransient, TColStd_IndexedDataMapOfTransientTransient, TColStd_IndexedMapOfInteger, TColStd_IndexedMapOfReal, TColStd_IndexedMapOfTransient, TColStd_MapOfAsciiString, TColStd_MapOfInteger, TColStd_MapOfReal, TColStd_MapOfTransient, TColStd_PackedMapOfInteger [private], TDataStd_DataMapOfStringByte, TDataStd_DataMapOfStringHArray1OfInteger, TDataStd_DataMapOfStringHArray1OfReal, TDataStd_DataMapOfStringReal, TDataStd_DataMapOfStringString, TDF_AttributeDataMap, TDF_AttributeDoubleMap, TDF_AttributeIndexedMap, TDF_AttributeMap, TDF_GUIDProgIDMap, TDF_IDMap, TDF_LabelDataMap, TDF_LabelDoubleMap, TDF_LabelIndexedMap, TDF_LabelIntegerMap, TDF_LabelLabelMap, TDF_LabelMap, TDocStd_LabelIDMapDataMap, TFunction_DataMapOfGUIDDriver, TFunction_DataMapOfLabelListOfLabel, TFunction_DoubleMapOfIntegerLabel, TNaming_DataMapOfShapePtrRefShape, TNaming_DataMapOfShapeShapesSet, TNaming_MapOfNamedShape, TopLoc_IndexedMapOfLocation, TopLoc_MapOfLocation, TopOpeBRep_DataMapOfTopolTool, TopOpeBRepBuild_DataMapOfShapeListOfShapeListOfShape, TopOpeBRepBuild_IndexedDataMapOfShapeVertexInfo, TopOpeBRepDS_DataMapOfCheckStatus, TopOpeBRepDS_DataMapOfIntegerListOfInterference, TopOpeBRepDS_DataMapOfInterferenceListOfInterference, TopOpeBRepDS_DataMapOfInterferenceShape, TopOpeBRepDS_DataMapOfShapeListOfShapeOn1State, TopOpeBRepDS_DataMapOfShapeState, TopOpeBRepDS_DoubleMapOfIntegerShape, TopOpeBRepDS_IndexedDataMapOfShapeWithState, TopOpeBRepDS_IndexedDataMapOfVertexPoint, TopOpeBRepDS_MapOfCurve, TopOpeBRepDS_MapOfIntegerShapeData, TopOpeBRepDS_MapOfPoint, TopOpeBRepDS_MapOfShapeData, TopOpeBRepDS_MapOfSurface, TopOpeBRepDS_ShapeSurface, TopOpeBRepTool_DataMapOfOrientedShapeC2DF, TopOpeBRepTool_DataMapOfShapeface, TopOpeBRepTool_DataMapOfShapeListOfC2DF, TopOpeBRepTool_IndexedDataMapOfShapeBox, TopOpeBRepTool_IndexedDataMapOfShapeBox2d, TopOpeBRepTool_IndexedDataMapOfShapeconnexity, TopOpeBRepTool_IndexedDataMapOfSolidClassifier, TopTools_DataMapOfIntegerListOfShape, TopTools_DataMapOfIntegerShape, TopTools_DataMapOfOrientedShapeInteger, TopTools_DataMapOfOrientedShapeShape, TopTools_DataMapOfShapeInteger, TopTools_DataMapOfShapeListOfInteger, TopTools_DataMapOfShapeListOfShape, TopTools_DataMapOfShapeReal, TopTools_DataMapOfShapeSequenceOfShape, TopTools_DataMapOfShapeShape, TopTools_IndexedDataMapOfShapeAddress, TopTools_IndexedDataMapOfShapeListOfShape, TopTools_IndexedDataMapOfShapeShape, TopTools_IndexedMapOfOrientedShape, TopTools_IndexedMapOfShape, TopTools_MapOfOrientedShape, TopTools_MapOfShape, TPrsStd_DataMapOfGUIDDriver, Transfer_TransferMapOfProcessForFinder, Transfer_TransferMapOfProcessForTransient, Viewer2dTest_DataMapOfText, Viewer2dTest_DoubleMapOfInteractiveAndName, ViewerTest_DoubleMapOfInteractiveAndName, XCAFDoc_DataMapOfShapeLabel, XCAFPrs_DataMapOfShapeStyle, XCAFPrs_DataMapOfStyleShape, XCAFPrs_DataMapOfStyleTransient, XmlMDF_MapOfDriver, XmlMDF_TypeADriverMap, XSDRAWSTLVRML_CoordsMap, and XSDRAWSTLVRML_ElemNodesMap.

Public Member Functions
void *	operator new (size_t, void *anAddress)
void *	operator new (size_t size)
void	operator delete (void *anAddress)
Standard_Integer	NbBuckets () const
	Returns the number of buckets in <me>.
Standard_Integer	Extent () const
	Returns the number of keys already stored in <me>.
Standard_Boolean	IsEmpty () const
	Returns True when the map contains no keys. This is exactly Extent() == 0.
void	Statistics (Standard_OStream &S) const
	Prints on <S> usefull statistics about the map <me>. It can be used to test the quality of the hashcoding.
Protected Member Functions
	TCollection_BasicMap (const Standard_Integer NbBuckets, const Standard_Boolean single)
	Initialize the map. Single is True when the map uses only one table of buckets. One table : Map, DataMap Two tables : DoubleMap, IndexedMap, IndexedDataMap
Standard_Boolean	BeginResize (const Standard_Integer NbBuckets, Standard_Integer &NewBuckets, Standard_Address &data1, Standard_Address &data2) const
	Tries to resize the Map with NbBuckets. Returns True if possible, NewBuckts is the new nuber of buckets. data1 and data2 are the new tables of buckets where the data must be copied.
void	EndResize (const Standard_Integer NbBuckets, const Standard_Integer NewBuckets, const Standard_Address data1, const Standard_Address data2)
	If BeginResize was succesfull after copying the data to data1 and data2 this methods update the tables and destroys the old ones.
Standard_Boolean	Resizable () const
	Returns True if resizing the map should be considered.
void	Increment ()
	Decrement the extent of the map.
void	Decrement ()
	Decrement the extent of the map.
void	Destroy ()
	Destroys the buckets.
Protected Attributes
Standard_Address	myData1
Standard_Address	myData2

Detailed Description

Map items may be (complex) non-unitary data; they
may be difficult to manage with an array. Moreover, the
map allows a data structure to be indexed by complex data.
The size of a map is dynamically extended. So a map
may be first dimensioned for a little number of items.
Maps avoid the use of large and quasi-empty arrays.
The access to a map item is much faster than the one
to a sequence, a list, a queue or a stack item.
The access time to a map item may be compared with
the one to an array item. First of all, it depends on the
size of the map. It also depends on the quality of a user
redefinable function (the hashing function) to find
quickly where the item is.
The exploration of a map may be of better performance
than the exploration of an array because the size of the
map is adapted to the number of inserted items.
These properties explain why maps are commonly used as
internal data structures for algorithms.
Definitions
A map is a data structure for which data is addressed by keys.
Once inserted in the map, a map item is referenced as an entry of the map.
Each entry of the map is addressed by a key. Two
different keys address two different entries of the map.
The position of an entry in the map is called a bucket.
A map is dimensioned by its number of buckets, i.e. the
maximum number of entries in the map. The
performance of a map is conditioned by the number of buckets.
The hashing function transforms a key into a bucket
index. The number of values that can be computed by
the hashing function is equal to the number of buckets of the map.
Both the hashing function and the equality test
between two keys are provided by a hasher object.
A map may be explored by a map iterator. This
exploration provides only inserted entries in the map
(i.e. non empty buckets).
Collections' generic maps
The Collections component provides numerous generic derived maps.
These maps include automatic management of the
number of buckets: they are automatically resized when
the number of keys exceeds the number of buckets. If
you have a fair idea of the number of items in your map,
you can save on automatic resizing by specifying a
number of buckets at the time of construction, or by using
a resizing function. This may be considered for crucial optimization issues.
Keys, items and hashers are parameters of these generic derived maps.
TCollection_MapHasher class describes the
functions required by any hasher which is to be used
with a map instantiated from the Collections component.
An iterator class is automatically instantiated at the
time of instantiation of a map provided by the
Collections component if this map is to be explored
with an iterator. Note that some provided generic maps
are not to be explored with an iterator but with indexes (indexed maps).

Constructor & Destructor Documentation

TCollection_BasicMap::TCollection_BasicMap	(	const Standard_Integer	NbBuckets,
		const Standard_Boolean	single
	)		`[protected]`

Member Function Documentation

Standard_Boolean TCollection_BasicMap::BeginResize	(	const Standard_Integer	NbBuckets,
		Standard_Integer &	NewBuckets,
		Standard_Address &	data1,
		Standard_Address &	data2
	)		const `[protected]`

void TCollection_BasicMap::Decrement ( ) [protected]

void TCollection_BasicMap::Destroy ( ) [protected]

void TCollection_BasicMap::EndResize	(	const Standard_Integer	NbBuckets,
		const Standard_Integer	NewBuckets,
		const Standard_Address	data1,
		const Standard_Address	data2
	)		`[protected]`