Header menu logo fantomas

HashMultiMap<'Key, 'Value> Type

Hash tables, by default based on F# structural "hash" and (=) functions. The table may map a single key to multiple bindings.

Constructors

Constructor Description

HashMultiMap(entries, comparer)

Full Usage: HashMultiMap(entries, comparer)

Parameters:
Returns: HashMultiMap<'Key, 'Value>

Build a map that contains the bindings of the given IEnumerable.

entries : ('Key * 'Value) seq
comparer : IEqualityComparer<'Key>
Returns: HashMultiMap<'Key, 'Value>

HashMultiMap(size, comparer)

Full Usage: HashMultiMap(size, comparer)

Parameters:
Returns: HashMultiMap<'Key, 'Value>

Create a new empty mutable HashMultiMap with an internal bucket array of the given approximate size and with the given key hash/equality functions.

size : int
comparer : IEqualityComparer<'Key>
Returns: HashMultiMap<'Key, 'Value>

HashMultiMap(comparer)

Full Usage: HashMultiMap(comparer)

Parameters:
Returns: HashMultiMap<'Key, 'Value>

Create a new empty mutable HashMultiMap with the given key hash/equality functions.

comparer : IEqualityComparer<'Key>
Returns: HashMultiMap<'Key, 'Value>

Instance members

Instance member Description

this.Add

Full Usage: this.Add

Parameters:
    arg0 : 'Key
    arg1 : 'Value

Add a binding for the element to the table.

arg0 : 'Key
arg1 : 'Value

this.Clear

Full Usage: this.Clear

Clear all elements from the collection.

this.ContainsKey

Full Usage: this.ContainsKey

Parameters:
    arg0 : 'Key

Returns: bool

Test if the collection contains any bindings for the given element.

arg0 : 'Key
Returns: bool

this.Copy

Full Usage: this.Copy

Returns: HashMultiMap<'Key, 'Value>

Make a shallow copy of the collection.

Returns: HashMultiMap<'Key, 'Value>

this.Count

Full Usage: this.Count

Returns: int

The total number of keys in the hash table.

Returns: int

this.FindAll

Full Usage: this.FindAll

Parameters:
    arg0 : 'Key

Returns: 'Value list

Find all bindings for the given element in the table, if any.

arg0 : 'Key
Returns: 'Value list

this.Fold

Full Usage: this.Fold

Parameters:
    arg0 : 'Key -> 'Value -> 'State -> 'State
    arg1 : 'State

Returns: 'State

Apply the given function to each element in the collection threading the accumulating parameter through the sequence of function applications.

arg0 : 'Key -> 'Value -> 'State -> 'State
arg1 : 'State
Returns: 'State

this[arg1]

Full Usage: this[arg1]

Returns: 'Key

Lookup or set the given element in the table. Set replaces all existing bindings for a value with a single bindings. Raise KeyNotFoundException if the element is not found.

Returns: 'Key

this.Iterate

Full Usage: this.Iterate

Parameters:
    arg0 : 'Key -> 'Value -> unit

Apply the given function to each binding in the hash table.

arg0 : 'Key -> 'Value -> unit

this.Remove

Full Usage: this.Remove

Parameters:
    arg0 : 'Key

Remove the latest binding if any for the given element from the table.

arg0 : 'Key

this.Replace

Full Usage: this.Replace

Parameters:
    arg0 : 'Key
    arg1 : 'Value

Replace the latest binding if any for the given element.

arg0 : 'Key
arg1 : 'Value

this.TryFind

Full Usage: this.TryFind

Parameters:
    arg0 : 'Key

Returns: 'Value option

Lookup the given element in the table, returning the result as an Option.

arg0 : 'Key
Returns: 'Value option

Type something to start searching.