FSharp.Collections.Immutable 1.0.0

Edit this page

HashMap Module

Functions and values

Function or value Description

HashMap.add key value map

Full Usage: HashMap.add key value map

Parameters:
    key : 'a
    value : 'b
    map : HashMap<'a, 'b>

Returns: HashMap<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
key : 'a
value : 'b
map : HashMap<'a, 'b>
Returns: HashMap<'a, 'b>

HashMap.append map pairs

Full Usage: HashMap.append map pairs

Parameters:
Returns: HashMap<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b, 'c
map : HashMap<'a, 'b>
pairs : 'c
Returns: HashMap<'a, 'b>

HashMap.builder ()

Full Usage: HashMap.builder ()

Parameters:
    () : unit

Returns: Builder<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
() : unit
Returns: Builder<'a, 'b>

HashMap.builderWithComparers keyComparer valueComparer

Full Usage: HashMap.builderWithComparers keyComparer valueComparer

Parameters:
Returns: Builder<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
keyComparer : IEqualityComparer<'a>
valueComparer : IEqualityComparer<'b>
Returns: Builder<'a, 'b>

HashMap.builderWithKeyComparer comparer

Full Usage: HashMap.builderWithKeyComparer comparer

Parameters:
Returns: Builder<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
comparer : IEqualityComparer<'a>
Returns: Builder<'a, 'b>

HashMap.check map

Full Usage: HashMap.check map

Parameters:
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>

HashMap.clear map

Full Usage: HashMap.clear map

Parameters:
Returns: HashMap<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: HashMap<'a, 'b>

HashMap.containsKey key map

Full Usage: HashMap.containsKey key map

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'a, 'b
key : 'a
map : HashMap<'a, 'b>
Returns: bool

HashMap.empty

Full Usage: HashMap.empty

Returns: ImmutableDictionary<'Key, 'Value>
Modifiers: inline
Type parameters: 'Key, 'Value
Returns: ImmutableDictionary<'Key, 'Value>

HashMap.except keys map

Full Usage: HashMap.except keys map

Parameters:
Returns: HashMap<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
keys : IEnumerable<'a>
map : HashMap<'a, 'b>
Returns: HashMap<'a, 'b>

HashMap.exists predicate map

Full Usage: HashMap.exists predicate map

Parameters:
    predicate : 'a -> 'b -> bool
    map : HashMap<'a, 'b>

Returns: bool
Modifiers: inline
Type parameters: 'a, 'b
predicate : 'a -> 'b -> bool
map : HashMap<'a, 'b>
Returns: bool

HashMap.filter predicate map

Full Usage: HashMap.filter predicate map

Parameters:
    predicate : 'a -> 'b -> bool
    map : KeyValuePair<'a, 'b> seq

Returns: KeyValuePair<'a, 'b> seq
Modifiers: inline
Type parameters: 'a, 'b
predicate : 'a -> 'b -> bool
map : KeyValuePair<'a, 'b> seq
Returns: KeyValuePair<'a, 'b> seq

HashMap.find key map

Full Usage: HashMap.find key map

Parameters:
Returns: 'b
Modifiers: inline
Type parameters: 'a, 'b
key : 'a
map : HashMap<'a, 'b>
Returns: 'b

HashMap.forall predicate map

Full Usage: HashMap.forall predicate map

Parameters:
    predicate : 'a -> 'b -> bool
    map : KeyValuePair<'a, 'b> seq

Returns: bool
Modifiers: inline
Type parameters: 'a, 'b
predicate : 'a -> 'b -> bool
map : KeyValuePair<'a, 'b> seq
Returns: bool

HashMap.isEmpty map

Full Usage: HashMap.isEmpty map

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: bool

HashMap.iter action map

Full Usage: HashMap.iter action map

Parameters:
    action : 'a -> 'b -> unit
    map : HashMap<'a, 'b>

Modifiers: inline
Type parameters: 'a, 'b
action : 'a -> 'b -> unit
map : HashMap<'a, 'b>

HashMap.keyComparer map

Full Usage: HashMap.keyComparer map

Parameters:
Returns: IEqualityComparer<'a>
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: IEqualityComparer<'a>

HashMap.length map

Full Usage: HashMap.length map

Parameters:
Returns: int
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: int

HashMap.map mapping map'

Full Usage: HashMap.map mapping map'

Parameters:
Returns: ImmutableDictionary<'c, 'd>
Modifiers: inline
Type parameters: 'a, 'b, 'c, 'd
mapping : 'a -> 'b -> KeyValuePair<'c, 'd>
map' : KeyValuePair<'a, 'b> seq
Returns: ImmutableDictionary<'c, 'd>

HashMap.ofArray source

Full Usage: HashMap.ofArray source

Parameters:
Returns: ImmutableDictionary<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
source : KeyValuePair<'a, 'b> array
Returns: ImmutableDictionary<'a, 'b>

HashMap.ofBuilder mapBuilder

Full Usage: HashMap.ofBuilder mapBuilder

Parameters:
Returns: ImmutableDictionary<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
mapBuilder : HashMapBuilder<'a, 'b>
Returns: ImmutableDictionary<'a, 'b>

HashMap.ofComparers keyComparer valueComparer

Full Usage: HashMap.ofComparers keyComparer valueComparer

Parameters:
Returns: ImmutableDictionary<'Key, 'Value>
Modifiers: inline
Type parameters: 'Key, 'Value
keyComparer : IEqualityComparer<'Key>
valueComparer : IEqualityComparer<'Value>
Returns: ImmutableDictionary<'Key, 'Value>

HashMap.ofKeyComparer comparer

Full Usage: HashMap.ofKeyComparer comparer

Parameters:
Returns: ImmutableDictionary<'Key, 'Value>
Modifiers: inline
Type parameters: 'Key, 'Value
comparer : IEqualityComparer<'Key>
Returns: ImmutableDictionary<'Key, 'Value>

HashMap.ofSeq source

Full Usage: HashMap.ofSeq source

Parameters:
Returns: ImmutableDictionary<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
source : IEnumerable<KeyValuePair<'a, 'b>>
Returns: ImmutableDictionary<'a, 'b>

HashMap.ofSeqGroupBy getKey source

Full Usage: HashMap.ofSeqGroupBy getKey source

Parameters:
    getKey : 'a -> 'b
    source : 'a seq

Returns: ImmutableDictionary<'b, 'a seq>
Modifiers: inline
Type parameters: 'a, 'b
getKey : 'a -> 'b
source : 'a seq
Returns: ImmutableDictionary<'b, 'a seq>

HashMap.ofSeqWith getKey source

Full Usage: HashMap.ofSeqWith getKey source

Parameters:
    getKey : 'a -> 'b
    source : 'a seq

Returns: ImmutableDictionary<'b, 'a>
Modifiers: inline
Type parameters: 'a, 'b
getKey : 'a -> 'b
source : 'a seq
Returns: ImmutableDictionary<'b, 'a>

HashMap.pick chooser map

Full Usage: HashMap.pick chooser map

Parameters:
    chooser : 'a -> 'b -> 'c option
    map : HashMap<'a, 'b>

Returns: 'c
Modifiers: inline
Type parameters: 'a, 'b, 'c
chooser : 'a -> 'b -> 'c option
map : HashMap<'a, 'b>
Returns: 'c

HashMap.remove key map

Full Usage: HashMap.remove key map

Parameters:
Returns: HashMap<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
key : 'a
map : HashMap<'a, 'b>
Returns: HashMap<'a, 'b>

HashMap.singleton (arg1, arg2)

Full Usage: HashMap.singleton (arg1, arg2)

Parameters:
    arg0 : 'a
    arg1 : 'b

Returns: ImmutableDictionary<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
arg0 : 'a
arg1 : 'b
Returns: ImmutableDictionary<'a, 'b>

HashMap.toArray map

Full Usage: HashMap.toArray map

Parameters:
Returns: KeyValuePair<'a, 'b> array
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: KeyValuePair<'a, 'b> array

HashMap.toBuilder map

Full Usage: HashMap.toBuilder map

Parameters:
Returns: HashMapBuilder<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: HashMapBuilder<'a, 'b>

HashMap.toSeq map

Full Usage: HashMap.toSeq map

Parameters:
Returns: KeyValuePair<'a, 'b> seq
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: KeyValuePair<'a, 'b> seq

HashMap.tryFind key map

Full Usage: HashMap.tryFind key map

Parameters:
Returns: 'b option
Modifiers: inline
Type parameters: 'a, 'b
key : 'a
map : HashMap<'a, 'b>
Returns: 'b option

HashMap.tryPick chooser map

Full Usage: HashMap.tryPick chooser map

Parameters:
    chooser : 'a -> 'b -> 'c option
    map : HashMap<'a, 'b>

Returns: 'c option
Modifiers: inline
Type parameters: 'a, 'b, 'c
chooser : 'a -> 'b -> 'c option
map : HashMap<'a, 'b>
Returns: 'c option

HashMap.vTryFind key map

Full Usage: HashMap.vTryFind key map

Parameters:
Returns: 'b voption
Modifiers: inline
Type parameters: 'a, 'b
key : 'a
map : HashMap<'a, 'b>
Returns: 'b voption

HashMap.vTryPick chooser map

Full Usage: HashMap.vTryPick chooser map

Parameters:
    chooser : 'a -> 'b -> 'c option
    map : HashMap<'a, 'b>

Returns: 'c voption
Modifiers: inline
Type parameters: 'a, 'b, 'c
chooser : 'a -> 'b -> 'c option
map : HashMap<'a, 'b>
Returns: 'c voption

HashMap.valueComparer map

Full Usage: HashMap.valueComparer map

Parameters:
Returns: IEqualityComparer<'b>
Modifiers: inline
Type parameters: 'a, 'b
map : HashMap<'a, 'b>
Returns: IEqualityComparer<'b>

HashMap.where predicate map

Full Usage: HashMap.where predicate map

Parameters:
    predicate : 'a -> 'b -> bool
    map : KeyValuePair<'a, 'b> seq

Returns: ImmutableDictionary<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
predicate : 'a -> 'b -> bool
map : KeyValuePair<'a, 'b> seq
Returns: ImmutableDictionary<'a, 'b>