FSharp.Collections.Immutable 1.0.0

Edit this page

FlatList Module

Nested modules

Modules Description

Builder

Functions and values

Function or value Description

FlatList.append list1 list2

Full Usage: FlatList.append list1 list2

Parameters:
Returns: FlatList<'T>
list1 : FlatList<'T>
list2 : FlatList<'T>
Returns: FlatList<'T>

FlatList.blit source sourceIndex destination destinationIndex count

Full Usage: FlatList.blit source sourceIndex destination destinationIndex count

Parameters:
    source : FlatList<'T>
    sourceIndex : int
    destination : 'T[]
    destinationIndex : int
    count : int

source : FlatList<'T>
sourceIndex : int
destination : 'T[]
destinationIndex : int
count : int

FlatList.build f

Full Usage: FlatList.build f

Parameters:
Returns: FlatList<'a>
Modifiers: inline
Type parameters: 'a
f : Builder<'a> -> unit
Returns: FlatList<'a>

FlatList.builder ()

Full Usage: FlatList.builder ()

Parameters:
    () : unit

Returns: Builder<'T>
Modifiers: inline
Type parameters: 'T
() : unit
Returns: Builder<'T>

FlatList.builderWith capacity

Full Usage: FlatList.builderWith capacity

Parameters:
    capacity : int

Returns: Builder<'T>
Modifiers: inline
Type parameters: 'T
capacity : int
Returns: Builder<'T>

FlatList.choose chooser list

Full Usage: FlatList.choose chooser list

Parameters:
    chooser : 'a -> 'b option
    list : FlatList<'a>

Returns: FlatList<'b>
chooser : 'a -> 'b option
list : FlatList<'a>
Returns: FlatList<'b>

FlatList.collect mapping list

Full Usage: FlatList.collect mapping list

Parameters:
Returns: FlatList<'b>
mapping : 'a -> FlatList<'b>
list : FlatList<'a>
Returns: FlatList<'b>

FlatList.concat arrs

Full Usage: FlatList.concat arrs

Parameters:
Returns: FlatList<'T>
arrs : FlatList<FlatList<'T>>
Returns: FlatList<'T>

FlatList.contains e list

Full Usage: FlatList.contains e list

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'a
e : 'a
list : FlatList<'a>
Returns: bool

FlatList.countBy projection list

Full Usage: FlatList.countBy projection list

Parameters:
    projection : 'a -> 'Key
    list : FlatList<'a>

Returns: FlatList<'Key * int>
projection : 'a -> 'Key
list : FlatList<'a>
Returns: FlatList<'Key * int>

FlatList.create count item

Full Usage: FlatList.create count item

Parameters:
    count : int
    item : 'a

Returns: FlatList<'a>
count : int
item : 'a
Returns: FlatList<'a>

FlatList.distinctBy projection list

Full Usage: FlatList.distinctBy projection list

Parameters:
    projection : 'T -> 'Key
    list : FlatList<'T>

Returns: FlatList<'T>
projection : 'T -> 'Key
list : FlatList<'T>
Returns: FlatList<'T>

FlatList.empty

Full Usage: FlatList.empty

Returns: FlatList<'T>
Modifiers: inline
Type parameters: 'T
Returns: FlatList<'T>

FlatList.exists predicate list

Full Usage: FlatList.exists predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: bool
predicate : 'a -> bool
list : FlatList<'a>
Returns: bool

FlatList.exists2 predicate list1 list2

Full Usage: FlatList.exists2 predicate list1 list2

Parameters:
Returns: bool
predicate : 'a -> 'b -> bool
list1 : FlatList<'a>
list2 : FlatList<'b>
Returns: bool

FlatList.filter predicate list

Full Usage: FlatList.filter predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: FlatList<'a>

Removes all the elements that do not match the conditions defined by the specified predicate.

predicate : 'a -> bool
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.find predicate list

Full Usage: FlatList.find predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: 'a
predicate : 'a -> bool
list : FlatList<'a>
Returns: 'a

FlatList.findBack predicate list

Full Usage: FlatList.findBack predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: 'a
predicate : 'a -> bool
list : FlatList<'a>
Returns: 'a

FlatList.findIndexBack predicate list

Full Usage: FlatList.findIndexBack predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: int
predicate : 'a -> bool
list : FlatList<'a>
Returns: int

FlatList.forall predicate list

Full Usage: FlatList.forall predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: bool
predicate : 'a -> bool
list : FlatList<'a>
Returns: bool

FlatList.forall2 predicate list1 list2

Full Usage: FlatList.forall2 predicate list1 list2

Parameters:
Returns: bool
predicate : 'a -> 'b -> bool
list1 : FlatList<'a>
list2 : FlatList<'b>
Returns: bool

FlatList.groupBy projection list

Full Usage: FlatList.groupBy projection list

Parameters:
    projection : 'T -> 'Key
    list : FlatList<'T>

Returns: FlatList<'Key * ImmutableArray<'T>>
projection : 'T -> 'Key
list : FlatList<'T>
Returns: FlatList<'Key * ImmutableArray<'T>>

FlatList.head list

Full Usage: FlatList.head list

Parameters:
Returns: 'a
list : FlatList<'a>
Returns: 'a

FlatList.index item list

Full Usage: FlatList.index item list

Parameters:
Returns: FlatList<'a> -> int
item : 'a
list : FlatList<'b>
Returns: FlatList<'a> -> int

FlatList.indexFrom index item list

Full Usage: FlatList.indexFrom index item list

Parameters:
    index : int
    item : 'a
    list : FlatList<'b>

Returns: FlatList<'a> -> int
index : int
item : 'a
list : FlatList<'b>
Returns: FlatList<'a> -> int

FlatList.indexFromWith comparer index item list

Full Usage: FlatList.indexFromWith comparer index item list

Parameters:
Returns: FlatList<'a> -> int
comparer : IEqualityComparer<'a>
index : int
item : 'a
list : FlatList<'b>
Returns: FlatList<'a> -> int

FlatList.indexRange index count item list

Full Usage: FlatList.indexRange index count item list

Parameters:
    index : int
    count : int
    item : 'a
    list : FlatList<'a>

Returns: int
index : int
count : int
item : 'a
list : FlatList<'a>
Returns: int

FlatList.indexRangeWith comparer index count item list

Full Usage: FlatList.indexRangeWith comparer index count item list

Parameters:
Returns: int

Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the list that starts at the specified index and contains the specified number of elements.

comparer : IEqualityComparer<'a>
index : int
count : int
item : 'a
list : FlatList<'a>
Returns: int

FlatList.indexWith comparer item list

Full Usage: FlatList.indexWith comparer item list

Parameters:
Returns: FlatList<'a> -> int
comparer : IEqualityComparer<'a>
item : 'a
list : FlatList<'b>
Returns: FlatList<'a> -> int

FlatList.indexed list

Full Usage: FlatList.indexed list

Parameters:
Returns: FlatList<int * 'a>
list : FlatList<'a>
Returns: FlatList<int * 'a>

FlatList.init count initializer

Full Usage: FlatList.init count initializer

Parameters:
    count : int
    initializer : int -> 'a

Returns: FlatList<'a>
count : int
initializer : int -> 'a
Returns: FlatList<'a>

FlatList.isDefault list

Full Usage: FlatList.isDefault list

Parameters:
Returns: bool
list : FlatList<'a>
Returns: bool

FlatList.isDefaultOrEmpty list

Full Usage: FlatList.isDefaultOrEmpty list

Parameters:
Returns: bool
list : FlatList<'a>
Returns: bool

FlatList.isEmpty list

Full Usage: FlatList.isEmpty list

Parameters:
Returns: bool
list : FlatList<'a>
Returns: bool

FlatList.item index list

Full Usage: FlatList.item index list

Parameters:
Returns: 'a
index : int
list : FlatList<'a>
Returns: 'a

FlatList.iter action list

Full Usage: FlatList.iter action list

Parameters:
    action : 'a -> unit
    list : FlatList<'a>

Modifiers: inline
Type parameters: 'a
action : 'a -> unit
list : FlatList<'a>

FlatList.iter2 action list1 list2

Full Usage: FlatList.iter2 action list1 list2

Parameters:
action : 'T -> 'U -> unit
list1 : FlatList<'T>
list2 : FlatList<'U>

FlatList.iteri action list

Full Usage: FlatList.iteri action list

Parameters:
    action : int -> 'a -> unit
    list : FlatList<'a>

action : int -> 'a -> unit
list : FlatList<'a>

FlatList.iteri2 action list1 list2

Full Usage: FlatList.iteri2 action list1 list2

Parameters:
action : int -> 'a -> 'b -> unit
list1 : FlatList<'a>
list2 : FlatList<'b>

FlatList.last list

Full Usage: FlatList.last list

Parameters:
Returns: 'a
list : FlatList<'a>
Returns: 'a

FlatList.lastIndex item list

Full Usage: FlatList.lastIndex item list

Parameters:
Returns: int
item : 'a
list : FlatList<'a>
Returns: int

FlatList.lastIndexFrom index item list

Full Usage: FlatList.lastIndexFrom index item list

Parameters:
    index : int
    item : 'a
    list : FlatList<'a>

Returns: int
index : int
item : 'a
list : FlatList<'a>
Returns: int

FlatList.lastIndexFromWith comparer index item list

Full Usage: FlatList.lastIndexFromWith comparer index item list

Parameters:
Returns: int
comparer : IEqualityComparer<'a>
index : int
item : 'a
list : FlatList<'a>
Returns: int

FlatList.lastIndexRange index count item list

Full Usage: FlatList.lastIndexRange index count item list

Parameters:
    index : int
    count : int
    item : 'a
    list : FlatList<'a>

Returns: int
index : int
count : int
item : 'a
list : FlatList<'a>
Returns: int

FlatList.lastIndexRangeWith comparer index count item list

Full Usage: FlatList.lastIndexRangeWith comparer index count item list

Parameters:
Returns: int

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the list that contains the specified number of elements and ends at the specified index.

comparer : IEqualityComparer<'a>
index : int
count : int
item : 'a
list : FlatList<'a>
Returns: int

FlatList.lastIndexWith comparer item list

Full Usage: FlatList.lastIndexWith comparer item list

Parameters:
Returns: int
comparer : IEqualityComparer<'a>
item : 'a
list : FlatList<'a>
Returns: int

FlatList.length list

Full Usage: FlatList.length list

Parameters:
Returns: int
list : FlatList<'a>
Returns: int

FlatList.map mapping list

Full Usage: FlatList.map mapping list

Parameters:
    mapping : 'a -> 'b
    list : FlatList<'a>

Returns: FlatList<'b>
Modifiers: inline
Type parameters: 'a, 'b
mapping : 'a -> 'b
list : FlatList<'a>
Returns: FlatList<'b>

FlatList.map2 mapping list1 list2

Full Usage: FlatList.map2 mapping list1 list2

Parameters:
Returns: FlatList<'c>
mapping : 'a -> 'b -> 'c
list1 : FlatList<'a>
list2 : FlatList<'b>
Returns: FlatList<'c>

FlatList.map3 mapping list1 list2 list3

Full Usage: FlatList.map3 mapping list1 list2 list3

Parameters:
Returns: FlatList<'d>
mapping : 'a -> 'b -> 'c -> 'd
list1 : FlatList<'a>
list2 : FlatList<'b>
list3 : FlatList<'c>
Returns: FlatList<'d>

FlatList.mapi mapping list

Full Usage: FlatList.mapi mapping list

Parameters:
    mapping : int -> 'a -> 'b
    list : FlatList<'a>

Returns: FlatList<'b>
mapping : int -> 'a -> 'b
list : FlatList<'a>
Returns: FlatList<'b>

FlatList.mapi2 mapping list1 list2

Full Usage: FlatList.mapi2 mapping list1 list2

Parameters:
Returns: FlatList<'c>
mapping : int -> 'a -> 'b -> 'c
list1 : FlatList<'a>
list2 : FlatList<'b>
Returns: FlatList<'c>

FlatList.moveFromBuilder builder

Full Usage: FlatList.moveFromBuilder builder

Parameters:
Returns: FlatList<'a>
builder : Builder<'a>
Returns: FlatList<'a>

FlatList.ofArray source

Full Usage: FlatList.ofArray source

Parameters:
    source : 'a array

Returns: ImmutableArray<'a>
Modifiers: inline
Type parameters: 'a
source : 'a array
Returns: ImmutableArray<'a>

FlatList.ofBuilder builder

Full Usage: FlatList.ofBuilder builder

Parameters:
Returns: FlatList<'a>
builder : Builder<'a>
Returns: FlatList<'a>

FlatList.ofSeq source

Full Usage: FlatList.ofSeq source

Parameters:
Returns: ImmutableArray<'a>
Modifiers: inline
Type parameters: 'a
source : IEnumerable<'a>
Returns: ImmutableArray<'a>

FlatList.partition predicate list

Full Usage: FlatList.partition predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: FlatList<'a> * FlatList<'a>
predicate : 'a -> bool
list : FlatList<'a>
Returns: FlatList<'a> * FlatList<'a>

FlatList.pick chooser list

Full Usage: FlatList.pick chooser list

Parameters:
    chooser : 'a -> 'b option
    list : FlatList<'a>

Returns: 'b
chooser : 'a -> 'b option
list : FlatList<'a>
Returns: 'b

FlatList.removeAll items list

Full Usage: FlatList.removeAll items list

Parameters:
Returns: FlatList<'a>

Removes the specified objects from the list.

items : 'a seq
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.removeAllWith comparer items list

Full Usage: FlatList.removeAllWith comparer items list

Parameters:
Returns: FlatList<'T>

Removes the specified objects from the list with the given comparer.

comparer : IEqualityComparer<'T>
items : 'T seq
list : FlatList<'T>
Returns: FlatList<'T>

FlatList.removeRange index count list

Full Usage: FlatList.removeRange index count list

Parameters:
    index : int
    count : int
    list : FlatList<'a>

Returns: FlatList<'a>

Removes a range of elements from the list.

index : int
count : int
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.replicate count item

Full Usage: FlatList.replicate count item

Parameters:
    count : 'a
    item : int

Returns: FlatList<'a>
count : 'a
item : int
Returns: FlatList<'a>

FlatList.singleton item

Full Usage: FlatList.singleton item

Parameters:
    item : 'T

Returns: FlatList<'T>
Modifiers: inline
Type parameters: 'T
item : 'T
Returns: FlatList<'T>

FlatList.skip index list

Full Usage: FlatList.skip index list

Parameters:
Returns: FlatList<'a>
index : int
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.skipWhile predicate list

Full Usage: FlatList.skipWhile predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: FlatList<'a>
predicate : 'a -> bool
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.sort list

Full Usage: FlatList.sort list

Parameters:
Returns: ImmutableArray<'a>
list : FlatList<'a>
Returns: ImmutableArray<'a>

FlatList.sortRange index count list

Full Usage: FlatList.sortRange index count list

Parameters:
    index : int
    count : int
    list : FlatList<'a>

Returns: ImmutableArray<'a>
index : int
count : int
list : FlatList<'a>
Returns: ImmutableArray<'a>

FlatList.sortRangeWith comparer index count list

Full Usage: FlatList.sortRangeWith comparer index count list

Parameters:
    comparer : 'a -> 'a -> int
    index : int
    count : int
    list : FlatList<'a>

Returns: ImmutableArray<'a>
comparer : 'a -> 'a -> int
index : int
count : int
list : FlatList<'a>
Returns: ImmutableArray<'a>

FlatList.sortRangeWithComparer comparer index count list

Full Usage: FlatList.sortRangeWithComparer comparer index count list

Parameters:
Returns: ImmutableArray<'a>
comparer : IComparer<'a>
index : int
count : int
list : FlatList<'a>
Returns: ImmutableArray<'a>

FlatList.sortWith comparer list

Full Usage: FlatList.sortWith comparer list

Parameters:
    comparer : 'a -> 'a -> int
    list : FlatList<'a>

Returns: ImmutableArray<'a>
comparer : 'a -> 'a -> int
list : FlatList<'a>
Returns: ImmutableArray<'a>

FlatList.sortWithComparer comparer list

Full Usage: FlatList.sortWithComparer comparer list

Parameters:
Returns: ImmutableArray<'a>
comparer : IComparer<'a>
list : FlatList<'a>
Returns: ImmutableArray<'a>

FlatList.splitAt index list

Full Usage: FlatList.splitAt index list

Parameters:
Returns: FlatList<'a> * FlatList<'a>
index : int
list : FlatList<'a>
Returns: FlatList<'a> * FlatList<'a>

FlatList.sub start stop list

Full Usage: FlatList.sub start stop list

Parameters:
    start : int
    stop : int
    list : FlatList<'a>

Returns: FlatList<'a>
start : int
stop : int
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.tail list

Full Usage: FlatList.tail list

Parameters:
Returns: FlatList<'a>
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.take count list

Full Usage: FlatList.take count list

Parameters:
Returns: FlatList<'a>
count : int
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.takeWhile predicate list

Full Usage: FlatList.takeWhile predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: FlatList<'a>
predicate : 'a -> bool
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.toArray list

Full Usage: FlatList.toArray list

Parameters:
Returns: 'a array
Modifiers: inline
Type parameters: 'a
list : FlatList<'a>
Returns: 'a array

FlatList.toBuilder list

Full Usage: FlatList.toBuilder list

Parameters:
Returns: Builder<'a>
list : FlatList<'a>
Returns: Builder<'a>

FlatList.toSeq flatList

Full Usage: FlatList.toSeq flatList

Parameters:
Returns: 'a seq
Modifiers: inline
Type parameters: 'a
flatList : FlatList<'a>
Returns: 'a seq

FlatList.truncate count list

Full Usage: FlatList.truncate count list

Parameters:
Returns: FlatList<'a>
count : int
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.tryFind predicate list

Full Usage: FlatList.tryFind predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: 'a option
predicate : 'a -> bool
list : FlatList<'a>
Returns: 'a option

FlatList.tryFindBack predicate list

Full Usage: FlatList.tryFindBack predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: 'a option
predicate : 'a -> bool
list : FlatList<'a>
Returns: 'a option

FlatList.tryFindIndexBack predicate list

Full Usage: FlatList.tryFindIndexBack predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: int option
predicate : 'a -> bool
list : FlatList<'a>
Returns: int option

FlatList.tryHead list

Full Usage: FlatList.tryHead list

Parameters:
Returns: 'a option
list : FlatList<'a>
Returns: 'a option

FlatList.tryItem index list

Full Usage: FlatList.tryItem index list

Parameters:
Returns: 'a option
index : int
list : FlatList<'a>
Returns: 'a option

FlatList.tryLast list

Full Usage: FlatList.tryLast list

Parameters:
Returns: 'a option
list : FlatList<'a>
Returns: 'a option

FlatList.tryPick chooser list

Full Usage: FlatList.tryPick chooser list

Parameters:
    chooser : 'a -> 'b option
    list : FlatList<'a>

Returns: 'b option
chooser : 'a -> 'b option
list : FlatList<'a>
Returns: 'b option

FlatList.tryTail list

Full Usage: FlatList.tryTail list

Parameters:
Returns: FlatList<'a> option
list : FlatList<'a>
Returns: FlatList<'a> option

FlatList.update f list

Full Usage: FlatList.update f list

Parameters:
Returns: FlatList<'a>
Modifiers: inline
Type parameters: 'a
f : Builder<'a> -> unit
list : FlatList<'a>
Returns: FlatList<'a>

FlatList.where predicate list

Full Usage: FlatList.where predicate list

Parameters:
    predicate : 'a -> bool
    list : FlatList<'a>

Returns: FlatList<'a>

Removes all the elements that do not match the conditions defined by the specified predicate.

predicate : 'a -> bool
list : FlatList<'a>
Returns: FlatList<'a>