map (STL/CLR)
The template class describes an object that controls a varying-length sequence of elements that has bidirectional access. You use the container map to manage a sequence of elements as a (nearly) balanced ordered tree of nodes, each storing one element. An element consists of a key, for ordering the sequence, and a mapped value, which goes along for the ride.
In the description below, GValue is the same as:
Microsoft::VisualC::StlClr::GenericPair<GKey, GMapped>
où :
GKey is the same as Key unless the latter is a ref type, in which case it is Key^
GMapped is the same as Mapped unless the latter is a ref type, in which case it is Mapped^
template<typename Key,
typename Mapped>
ref class map
: public
System::ICloneable,
System::Collections::IEnumerable,
System::Collections::ICollection,
System::Collections::Generic::IEnumerable<GValue>,
System::Collections::Generic::ICollection<GValue>,
System::Collections::Generic::IList<GValue>,
System::Collections::Generic::IDictionary<Gkey, GMapped>,
Microsoft::VisualC::StlClr::ITree<Gkey, GValue>
{ ..... };
Paramètres
Clé
Type du composant clé d'un élément dans la séquence contrôlée.Mapped
The type of the additional component of an element in the controlled sequence.
Membres
Type Definition |
Description |
|---|---|
Type d'un itérateur constant pour la séquence contrôlée. |
|
Type d'une référence constante à un élément. |
|
The type of a constant reverse iterator for the controlled sequence. |
|
The type of a (possibly signed) distance between two elements. |
|
The type of the generic interface for the container. |
|
The type of an iterator for the generic interface for the container. |
|
The type of a reverse iterator for the generic interface for the container. |
|
The type of an element for the generic interface for the container. |
|
Type d'un itérateur pour la séquence contrôlée. |
|
The ordering delegate for two keys. |
|
Type d'une clé de classement. |
|
The type of the mapped value associated with each key. |
|
Type d'une référence à un élément. |
|
The type of a reverse iterator for the controlled sequence. |
|
The type of a (non-negative) distance between two elements. |
|
The ordering delegate for two element values. |
|
Le type d'un élément. |
Member Function |
Description |
|---|---|
Désigne le début de la séquence contrôlée. |
|
Removes all elements. |
|
Counts elements matching a specified key. |
|
Tests whether no elements are present. |
|
Désigne la fin de la séquence contrôlée. |
|
Finds range that matches a specified key. |
|
Supprime les éléments placés aux positions spécifiées. |
|
Recherche un élément qui correspond à une clé spécifiée. |
|
Adds elements. |
|
Copies the ordering delegate for two keys. |
|
Finds beginning of range that matches a specified key. |
|
Constructs a value object. |
|
Construit un objet container. |
|
Désigne le début de la séquence contrôlée inversée. |
|
Désigne la fin de la séquence contrôlée inversée. |
|
Compte le nombre d'éléments. |
|
Échange le contenu de deux conteneurs. |
|
Copies the controlled sequence to a new array. |
|
Finds end of range that matches a specified key. |
|
Copies the ordering delegate for two element values. |
Opérateur |
Description |
|---|---|
Replaces the controlled sequence. |
|
Maps a key to its associated mapped value. |
|
Determines if a map object is not equal to another map object. |
|
Determines if a map object is less than another map object. |
|
Determines if a map object is less than or equal to another map object. |
|
Determines if a map object is equal to another map object. |
|
Determines if a map object is greater than another map object. |
|
Determines if a map object is greater than or equal to another map object. |
Interfaces
Interface |
Description |
|---|---|
Duplicate an object. |
|
Sequence through elements. |
|
Maintain group of elements. |
|
Sequence through typed elements. |
|
Maintain group of typed elements. |
|
Maintain group of {key, value} pairs. |
|
ITree<Key, Value> |
Maintain generic container. |
Notes
The object allocates and frees storage for the sequence it controls as individual nodes. It inserts elements into a (nearly) balanced tree that it keeps ordered by altering the links between nodes, never by copying the contents of one node to another. That means you can insert and remove elements freely without disturbing remaining elements.
The object orders the sequence it controls by calling a stored delegate object of type mappage : : key_compare (STL/CLR). You can specify the stored delegate object when you construct the map; if you specify no delegate object, the default is the comparison operator<(key_type, key_type). You access this stored object by calling the member function mappage : : key_comp (STL/CLR)().
Such a delegate object must impose a strict weak ordering on keys of type mappage : : key_type (STL/CLR). That means, for any two keys X and Y:
key_comp()(X, Y) returns the same Boolean result on every call.
If key_comp()(X, Y) is true, then key_comp()(Y, X) must be false.
If key_comp()(X, Y) is true, then X is said to be ordered before Y.
If !key_comp()(X, Y) && !key_comp()(Y, X) is true, then X and Y are said to have equivalent ordering.
For any element X that precedes Y in the controlled sequence, key_comp()(Y, X) is false. (For the default delegate object, keys never decrease in value.) Unlike template class map (STL/CLR), an object of template class map does not require that keys for all elements are unique. (Two or more keys can have equivalent ordering.)
Each element contains a separate key and a mapped value. The sequence is represented in a way that permits lookup, insertion, and removal of an arbitrary element with a number of operations proportional to the logarithm of the number of elements in the sequence (logarithmic time). Moreover, inserting an element invalidates no iterators, and removing an element invalidates only those iterators which point at the removed element.
A map supports bidirectional iterators, which means you can step to adjacent elements given an iterator that designates an element in the controlled sequence. A special head node corresponds to the iterator returned by mappage : : fin (STL/CLR)(). You can decrement this iterator to reach the last element in the controlled sequence, if present. You can increment a map iterator to reach the head node, and it will then compare equal to end(). But you cannot dereference the iterator returned by end().
Note that you cannot refer to a map element directly given its numerical position -- that requires a random-access iterator.
A map iterator stores a handle to its associated map node, which in turn stores a handle to its associated container. You can use iterators only with their associated container objects. A map iterator remains valid so long as its associated map node is associated with some map. Moreover, a valid iterator is dereferencable -- you can use it to access or alter the element value it designates -- so long as it is not equal to end().
Erasing or removing an element calls the destructor for its stored value. Destroying the container erases all elements. Thus, a container whose element type is a ref class ensures that no elements outlive the container. Note, however, that a container of handles does not destroy its elements.
Configuration requise
Header: <cliext/map>
Namespace: cliext