FSharp.Collections.Immutable 1.0.0

Edit this page

SortedMap Module

Functions and values

Function or value Description

SortedMap.add key value map

Full Usage: SortedMap.add key value map

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

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

SortedMap.append map pairs

Full Usage: SortedMap.append map pairs

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

SortedMap.builder ()

Full Usage: SortedMap.builder ()

Parameters:
    () : unit

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

SortedMap.builderWithComparers keyComparer valueComparer

Full Usage: SortedMap.builderWithComparers keyComparer valueComparer

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

SortedMap.builderWithKeyComparer comparer

Full Usage: SortedMap.builderWithKeyComparer comparer

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

SortedMap.check sortedMap

Full Usage: SortedMap.check sortedMap

Parameters:
Modifiers: inline
Type parameters: 'a, 'b
sortedMap : SortedMap<'a, 'b>

SortedMap.clear map

Full Usage: SortedMap.clear map

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

SortedMap.containsKey key map

Full Usage: SortedMap.containsKey key map

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

SortedMap.empty

Full Usage: SortedMap.empty

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

SortedMap.except keys map

Full Usage: SortedMap.except keys map

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

SortedMap.exists predicate map

Full Usage: SortedMap.exists predicate map

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

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

SortedMap.filter predicate map

Full Usage: SortedMap.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

SortedMap.find key map

Full Usage: SortedMap.find key map

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

SortedMap.findKey predicate map

Full Usage: SortedMap.findKey predicate map

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

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

SortedMap.forall predicate map

Full Usage: SortedMap.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

SortedMap.isEmpty map

Full Usage: SortedMap.isEmpty map

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

SortedMap.iter action map

Full Usage: SortedMap.iter action map

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

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

SortedMap.keyComparer map

Full Usage: SortedMap.keyComparer map

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

SortedMap.length map

Full Usage: SortedMap.length map

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

SortedMap.map mapping map'

Full Usage: SortedMap.map mapping map'

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

SortedMap.ofArray source

Full Usage: SortedMap.ofArray source

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

SortedMap.ofBuilder sortedMapBuilder

Full Usage: SortedMap.ofBuilder sortedMapBuilder

Parameters:
Returns: ImmutableSortedDictionary<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
sortedMapBuilder : SortedMapBuilder<'a, 'b>
Returns: ImmutableSortedDictionary<'a, 'b>

SortedMap.ofComparers keyComparer valueComparer

Full Usage: SortedMap.ofComparers keyComparer valueComparer

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

SortedMap.ofKeyComparer comparer

Full Usage: SortedMap.ofKeyComparer comparer

Parameters:
Returns: ImmutableSortedDictionary<'Key, 'Value>
Modifiers: inline
Type parameters: 'Key, 'Value
comparer : IComparer<'Key>
Returns: ImmutableSortedDictionary<'Key, 'Value>

SortedMap.ofSeq source

Full Usage: SortedMap.ofSeq source

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

SortedMap.ofSeqGroupBy getKey source

Full Usage: SortedMap.ofSeqGroupBy getKey source

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

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

SortedMap.ofSeqWith getKey source

Full Usage: SortedMap.ofSeqWith getKey source

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

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

SortedMap.pick chooser map

Full Usage: SortedMap.pick chooser map

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

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

SortedMap.remove key map

Full Usage: SortedMap.remove key map

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

SortedMap.singleton item

Full Usage: SortedMap.singleton item

Parameters:
Returns: ImmutableSortedDictionary<'a, 'b>
Modifiers: inline
Type parameters: 'a, 'b
item : IComparer<'a>
Returns: ImmutableSortedDictionary<'a, 'b>

SortedMap.toArray map

Full Usage: SortedMap.toArray map

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

SortedMap.toBuilder map

Full Usage: SortedMap.toBuilder map

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

SortedMap.toSeq map

Full Usage: SortedMap.toSeq map

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

SortedMap.tryFind key map

Full Usage: SortedMap.tryFind key map

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

SortedMap.tryFindKey predicate map

Full Usage: SortedMap.tryFindKey predicate map

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

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

SortedMap.tryPick chooser map

Full Usage: SortedMap.tryPick chooser map

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

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

SortedMap.vTryFind key map

Full Usage: SortedMap.vTryFind key map

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

SortedMap.vTryFindKey predicate map

Full Usage: SortedMap.vTryFindKey predicate map

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

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

SortedMap.vTryPick chooser map

Full Usage: SortedMap.vTryPick chooser map

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

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

SortedMap.valueComparer map

Full Usage: SortedMap.valueComparer map

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

SortedMap.where predicate map

Full Usage: SortedMap.where predicate map

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

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