FSharpx.Collections


Map<'Key, 'T, 'ComparerTag> Type

Constructors

Constructor Description

Map(comparer, tree)

Full Usage: Map(comparer, tree)

Parameters:
Returns: Map<'Key, 'T, 'ComparerTag>
comparer : IComparer<'Key>
tree : MapTree<'Key, 'T>
Returns: Map<'Key, 'T, 'ComparerTag>

Instance members

Instance member Description

this.Add(k, v)

Full Usage: this.Add(k, v)

Parameters:
    k : 'Key
    v : 'T

Returns: Map<'Key, 'T, 'ComparerTag>
k : 'Key
v : 'T
Returns: Map<'Key, 'T, 'ComparerTag>

this.Comparer

Full Usage: this.Comparer

Returns: 'ComparerTag
Returns: 'ComparerTag

this.ComparerUntyped

Full Usage: this.ComparerUntyped

Returns: IComparer<'Key>
Returns: IComparer<'Key>

this.ComputeHashCode()

Full Usage: this.ComputeHashCode()

Returns: int
Returns: int

this.ContainsKey(k)

Full Usage: this.ContainsKey(k)

Parameters:
    k : 'Key

Returns: bool
k : 'Key
Returns: bool

this.Count

Full Usage: this.Count

Returns: int
Returns: int

this.Exists(f)

Full Usage: this.Exists(f)

Parameters:
    f : 'Key -> 'T -> bool

Returns: bool
f : 'Key -> 'T -> bool
Returns: bool

this.Filter(f)

Full Usage: this.Filter(f)

Parameters:
    f : 'Key -> 'T -> bool

Returns: Map<'Key, 'T, 'ComparerTag>
f : 'Key -> 'T -> bool
Returns: Map<'Key, 'T, 'ComparerTag>

this.First(f)

Full Usage: this.First(f)

Parameters:
    f : 'Key -> 'T -> 'a option

Returns: 'a option
f : 'Key -> 'T -> 'a option
Returns: 'a option

this.Fold(f) (acc)

Full Usage: this.Fold(f) (acc)

Parameters:
    f : 'Key -> 'T -> 'a -> 'a
    acc : 'a

Returns: 'a
f : 'Key -> 'T -> 'a -> 'a
acc : 'a
Returns: 'a

this.FoldAndMap(f) (z)

Full Usage: this.FoldAndMap(f) (z)

Parameters:
    f : 'Key -> 'T -> 'a -> 'b * 'a
    z : 'a

Returns: Map<'Key, 'b, 'ComparerTag> * 'a
f : 'Key -> 'T -> 'a -> 'b * 'a
z : 'a
Returns: Map<'Key, 'b, 'ComparerTag> * 'a

this.FoldSection(lo) (hi) (f) (acc)

Full Usage: this.FoldSection(lo) (hi) (f) (acc)

Parameters:
    lo : 'Key
    hi : 'Key
    f : 'Key -> 'T -> 'a -> 'a
    acc : 'a

Returns: 'a
lo : 'Key
hi : 'Key
f : 'Key -> 'T -> 'a -> 'a
acc : 'a
Returns: 'a

this.ForAll(f)

Full Usage: this.ForAll(f)

Parameters:
    f : 'Key -> 'T -> bool

Returns: bool
f : 'Key -> 'T -> bool
Returns: bool

this.IsEmpty

Full Usage: this.IsEmpty

Returns: bool
Returns: bool

this.[k]

Full Usage: this.[k]

Parameters:
    k : 'Key

Returns: 'T
k : 'Key
Returns: 'T

this.Iterate(f)

Full Usage: this.Iterate(f)

Parameters:
    f : 'Key -> 'T -> unit

f : 'Key -> 'T -> unit

this.Map(f)

Full Usage: this.Map(f)

Parameters:
    f : 'Key -> 'T -> 'a

Returns: Map<'Key, 'a, 'ComparerTag>
f : 'Key -> 'T -> 'a
Returns: Map<'Key, 'a, 'ComparerTag>

this.MapRange(f)

Full Usage: this.MapRange(f)

Parameters:
    f : 'T -> 'a

Returns: Map<'Key, 'a, 'ComparerTag>
f : 'T -> 'a
Returns: Map<'Key, 'a, 'ComparerTag>

this.Partition(f)

Full Usage: this.Partition(f)

Parameters:
    f : 'Key -> 'T -> bool

Returns: Map<'Key, 'T, 'ComparerTag> * Map<'Key, 'T, 'ComparerTag>
f : 'Key -> 'T -> bool
Returns: Map<'Key, 'T, 'ComparerTag> * Map<'Key, 'T, 'ComparerTag>

this.Remove(k)

Full Usage: this.Remove(k)

Parameters:
    k : 'Key

Returns: Map<'Key, 'T, 'ComparerTag>
k : 'Key
Returns: Map<'Key, 'T, 'ComparerTag>

this.ToArray()

Full Usage: this.ToArray()

Returns: ('Key * 'T)[]
Returns: ('Key * 'T)[]

this.ToList()

Full Usage: this.ToList()

Returns: ('Key * 'T) list
Returns: ('Key * 'T) list

this.Tree

Full Usage: this.Tree

Returns: MapTree<'Key, 'T>
Returns: MapTree<'Key, 'T>

this.TryFind(k)

Full Usage: this.TryFind(k)

Parameters:
    k : 'Key

Returns: 'T option
k : 'Key
Returns: 'T option

Static members

Static member Description

Map.Create(comparer, ie)

Full Usage: Map.Create(comparer, ie)

Parameters:
    comparer : 'ComparerTag
    ie : seq<'Key * 'T>

Returns: Map<'Key, 'T, 'ComparerTag>
comparer : 'ComparerTag
ie : seq<'Key * 'T>
Returns: Map<'Key, 'T, 'ComparerTag>

Map.Empty(comparer)

Full Usage: Map.Empty(comparer)

Parameters:
    comparer : 'ComparerTag

Returns: Map<'Key, 'T, 'ComparerTag>
comparer : 'ComparerTag
Returns: Map<'Key, 'T, 'ComparerTag>

Map.FromList(comparer, l)

Full Usage: Map.FromList(comparer, l)

Parameters:
    comparer : 'ComparerTag
    l : ('Key * 'T) list

Returns: Map<'Key, 'T, 'ComparerTag>
comparer : 'ComparerTag
l : ('Key * 'T) list
Returns: Map<'Key, 'T, 'ComparerTag>