License:
see license.txt

  • interface Map (K,V): Keyed!(K,V), Collection!(V), Multi!(V);
  • A Map collection uses keys to map to values. This can only have one instance of a particular key at a time.

  • Map!(K,V) set (KeyedIterator!(K,V) source);
  • set all the elements from the given keyed iterator in the map. Any key that already exists will be overridden.

    Returns this.

  • Map!(K,V) set (KeyedIterator!(K,V) source, ref uint numAdded);
  • set all the elements from the given keyed iterator in the map. Any key that already exists will be overridden.

    Returns this.

    numAdded is set to the number of elements that were added.


  • Map!(K,V) set (V[K] source);
  • set all the elements from the given associative array in the map. Any key that already exists wil be overridden.

    Returns this.

  • Map!(K,V) set (V[K] source, ref uint numAdded);
  • set all the elements from the given associative array in the map. Any key that already exists wil be overridden.

    Returns this.

    numAdded is set to the number of elements added.


  • Map!(K,V) remove (Iterator!(K) subset);
  • Remove all the given keys from the map.

    return this.

  • Map!(K,V) remove (Iterator!(K) subset, ref uint numRemoved);
  • Remove all the given keys from the map.

    return this.

    numRemoved is set to the number of elements removed.


  • Map!(K,V) remove (K[] subset);
  • Remove all the given keys from the map.

    return this.

  • Map!(K,V) remove (K[] subset, ref uint numRemoved);
  • Remove all the given keys from the map.

    return this.

    numRemoved is set to the number of elements removed.


  • Map!(K,V) intersect (Iterator!(K) subset);
  • Remove all the keys that are not in the given iterator.

    returns this.

  • Map!(K,V) intersect (Iterator!(K) subset, ref uint numRemoved);
  • Remove all the keys that are not in the given iterator.

    sets numRemoved to the number of elements removed.

    returns this.


  • Map!(K,V) intersect (K[] subset);
  • Remove all the keys that are not in the given array.

    returns this.

  • Map!(K,V) intersect (K[] subset, ref uint numRemoved);
  • Remove all the keys that are not in the given array.

    sets numRemoved to the number of elements removed.

    returns this.


  • Iterator!(K) keys ();
  • Get a set of the keys that the map contains. This is not a copy of the keys , but an actual "window" into the keys of the map. If you add values to the map, they will show up in the keys iterator.

    This is not in Keyed, because some Keyed containers do not have user defined keys , and so this would be not quite that useful there.

  • Map!(K,V) clear ();
  • covariant clear (from Collection)

  • Map!(K,V) dup ();
  • covariant dup (from Collection)

  • Map!(K,V) remove (V v);
  • covariant remove (from Collection)

  • Map!(K,V) remove (V v, ref bool wasRemoved);
  • covariant remove (from Collection)

  • Map!(K,V) removeAll (V v);
  • covariant removeAll (from Multi)

  • Map!(K,V) removeAll (V v, ref uint numRemoved);
  • covariant removeAll (from Multi)

  • Map!(K,V) removeAt (K key);
  • covariant removeAt (from Keyed)

  • Map!(K,V) removeAt (K key, ref bool wasRemoved);
  • covariant removeAt (from Keyed)

  • Map!(K,V) set (K key, V value);
  • covariant set (from Keyed)

  • Map!(K,V) set (K key, V value, ref bool wasAdded);
  • covariant set (from Keyed)

  • int opEquals (Object o);
  • compare two maps. Returns true if both maps have the same number of elements, and both maps have elements whose keys and values are equal.

    If o is not a map, then 0 is returned.

    (C) 2008 by Steven Schveighoffer. All rights reserved :: page rendered by CandyDoc