FSharp.Collections.Immutable 1.0.0

Edit this page

ImmutableList Module

Functions and values

Function or value Description

ImmutableList.add item list

Full Usage: ImmutableList.add item list

Parameters:
Returns: IImmutableList<'a>

Makes a copy of the list, and adds the specified object to the end of the copied list.

item : 'a
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.append list items

Full Usage: ImmutableList.append list items

Parameters:
Returns: IImmutableList<'a>

Makes a copy of the list and adds the specified objects to the end of the copied list.

list : IImmutableList<'a>
items : IEnumerable<'a>
Returns: IImmutableList<'a>

ImmutableList.build f

Full Usage: ImmutableList.build f

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

ImmutableList.builder ()

Full Usage: ImmutableList.builder ()

Parameters:
    () : unit

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

ImmutableList.choose chooser list

Full Usage: ImmutableList.choose chooser list

Parameters:
Returns: ImmutableList<'b>
chooser : 'a -> 'b option
list : IImmutableList<'a>
Returns: ImmutableList<'b>

ImmutableList.clear list

Full Usage: ImmutableList.clear list

Parameters:
Returns: IImmutableList<'a>

Creates a list with all the items removed, but with the same sorting and ordering semantics as this list.

list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.collect mapping list

Full Usage: ImmutableList.collect mapping list

Parameters:
Returns: ImmutableList<'c>
mapping : 'a -> 'b
list : IImmutableList<'a>
Returns: ImmutableList<'c>

ImmutableList.concat lists

Full Usage: ImmutableList.concat lists

Parameters:
    lists : 'a

Returns: ImmutableList<'c>
lists : 'a
Returns: ImmutableList<'c>

ImmutableList.cons head list

Full Usage: ImmutableList.cons head list

Parameters:
Returns: IImmutableList<'a>
head : 'a
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.contains item list

Full Usage: ImmutableList.contains item list

Parameters:
Returns: bool
item : 'a
list : ImmutableList<'a>
Returns: bool

ImmutableList.empty

Full Usage: ImmutableList.empty

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

ImmutableList.except items list

Full Usage: ImmutableList.except items list

Parameters:
Returns: IImmutableList<'a>

Removes the specified objects from the list.

items : IEnumerable<'a>
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.exceptWith comparer items list

Full Usage: ImmutableList.exceptWith comparer items list

Parameters:
Returns: IImmutableList<'a>

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

comparer : IEqualityComparer<'a>
items : IEnumerable<'a>
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.filter predicate list

Full Usage: ImmutableList.filter predicate list

Parameters:
Returns: IImmutableList<'a>

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

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

ImmutableList.filterFold predicate initial list

Full Usage: ImmutableList.filterFold predicate initial list

Parameters:
    predicate : 'State -> 'T -> bool * 'State
    initial : 'State
    list : IImmutableList<'T>

Returns: IImmutableList<'T> * 'State
predicate : 'State -> 'T -> bool * 'State
initial : 'State
list : IImmutableList<'T>
Returns: IImmutableList<'T> * 'State

ImmutableList.find predicate list

Full Usage: ImmutableList.find predicate list

Parameters:
Returns: 'a
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: 'a

ImmutableList.findIndex predicate list

Full Usage: ImmutableList.findIndex predicate list

Parameters:
Returns: int
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: int

ImmutableList.fold folder state list

Full Usage: ImmutableList.fold folder state list

Parameters:
Returns: 'a
folder : 'a -> 'b -> 'a
state : 'a
list : IImmutableList<'b>
Returns: 'a

ImmutableList.forall predicate list

Full Usage: ImmutableList.forall predicate list

Parameters:
Returns: bool
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: bool

ImmutableList.forall2 predicate list1 list2

Full Usage: ImmutableList.forall2 predicate list1 list2

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

ImmutableList.head list

Full Usage: ImmutableList.head list

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

ImmutableList.index item list

Full Usage: ImmutableList.index item list

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

ImmutableList.indexFrom index item list

Full Usage: ImmutableList.indexFrom index item list

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

ImmutableList.indexFromWith comparer index item list

Full Usage: ImmutableList.indexFromWith comparer index item list

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

ImmutableList.indexRange index count item list

Full Usage: ImmutableList.indexRange index count item list

Parameters:
Returns: int
index : int
count : int
item : 'a
list : IImmutableList<'a>
Returns: int

ImmutableList.indexRangeWith comparer index count item list

Full Usage: ImmutableList.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 : IImmutableList<'a>
Returns: int

ImmutableList.indexWith comparer item list

Full Usage: ImmutableList.indexWith comparer item list

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

ImmutableList.init count initializer

Full Usage: ImmutableList.init count initializer

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

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

ImmutableList.insert index item list

Full Usage: ImmutableList.insert index item list

Parameters:
Returns: IImmutableList<'a>

Inserts the specified element at the specified index in a immutable list.

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

ImmutableList.insertRange index items list

Full Usage: ImmutableList.insertRange index items list

Parameters:
Returns: IImmutableList<'a>

Inserts the specified elements at the specified index in the immutable list.

index : int
items : IEnumerable<'a>
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.isEmpty list

Full Usage: ImmutableList.isEmpty list

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

ImmutableList.item index list

Full Usage: ImmutableList.item index list

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

ImmutableList.iter action list

Full Usage: ImmutableList.iter action list

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

ImmutableList.last list

Full Usage: ImmutableList.last list

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

ImmutableList.lastIndex item list

Full Usage: ImmutableList.lastIndex item list

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

ImmutableList.lastIndexFrom index item list

Full Usage: ImmutableList.lastIndexFrom index item list

Parameters:
Returns: int
index : int
item : 'a
list : IImmutableList<'a>
Returns: int

ImmutableList.lastIndexFromWith comparer index item list

Full Usage: ImmutableList.lastIndexFromWith comparer index item list

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

ImmutableList.lastIndexRange index count item list

Full Usage: ImmutableList.lastIndexRange index count item list

Parameters:
Returns: int
index : int
count : int
item : 'a
list : IImmutableList<'a>
Returns: int

ImmutableList.lastIndexRangeWith comparer index count item list

Full Usage: ImmutableList.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 : IImmutableList<'a>
Returns: int

ImmutableList.lastIndexWith comparer item list

Full Usage: ImmutableList.lastIndexWith comparer item list

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

ImmutableList.length list

Full Usage: ImmutableList.length list

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

ImmutableList.map mapping list

Full Usage: ImmutableList.map mapping list

Parameters:
Returns: ImmutableList<'b>
mapping : 'a -> 'b
list : IImmutableList<'a>
Returns: ImmutableList<'b>

ImmutableList.ofArray source

Full Usage: ImmutableList.ofArray source

Parameters:
    source : 'a array

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

ImmutableList.ofBuilder builder

Full Usage: ImmutableList.ofBuilder builder

Parameters:
Returns: ImmutableList<'a>
Modifiers: inline
Type parameters: 'a
builder : Builder<'a>
Returns: ImmutableList<'a>

ImmutableList.ofList list

Full Usage: ImmutableList.ofList list

Parameters:
    list : 'a list

Returns: ImmutableList<'a>
Modifiers: inline
Type parameters: 'a
list : 'a list
Returns: ImmutableList<'a>

ImmutableList.ofSeq source

Full Usage: ImmutableList.ofSeq source

Parameters:
    source : 'a

Returns: ImmutableList<'b>
Modifiers: inline
Type parameters: 'a, 'b
source : 'a
Returns: ImmutableList<'b>

ImmutableList.pick chooser list

Full Usage: ImmutableList.pick chooser list

Parameters:
Returns: 'b
chooser : 'a -> 'b option
list : IImmutableList<'a>
Returns: 'b

ImmutableList.remove item list

Full Usage: ImmutableList.remove item list

Parameters:
Returns: IImmutableList<'a>

Removes the first occurrence of a specified object from this immutable list.

item : 'a
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.removeAt index list

Full Usage: ImmutableList.removeAt index list

Parameters:
Returns: IImmutableList<'a>

Removes the element at the specified index of the immutable list.

index : int
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.removeRange index count list

Full Usage: ImmutableList.removeRange index count list

Parameters:
Returns: IImmutableList<'a>

Removes a range of elements from the System.Collections.Immutable.IImmutableList`1.

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

ImmutableList.removeWith comparer item list

Full Usage: ImmutableList.removeWith comparer item list

Parameters:
Returns: IImmutableList<'a>

Removes the first occurrence of a specified object from this immutable list using the given comparer.

comparer : IEqualityComparer<'a>
item : 'a
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.replace oldValue value list

Full Usage: ImmutableList.replace oldValue value list

Parameters:
Returns: IImmutableList<'a>

Returns a new list with the first matching element in the list replaced with the specified element.

oldValue : 'a
value : 'a
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.replaceWith comparer oldValue value list

Full Usage: ImmutableList.replaceWith comparer oldValue value list

Parameters:
Returns: IImmutableList<'a>

Returns a new list with the first matching element in the list replaced with the specified element with the given comparer.

comparer : IEqualityComparer<'a>
oldValue : 'a
value : 'a
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.reverse list

Full Usage: ImmutableList.reverse list

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

ImmutableList.reverseRange (index, count) list

Full Usage: ImmutableList.reverseRange (index, count) list

Parameters:
Returns: ImmutableList<'a>
index : int
count : int
list : ImmutableList<'a>
Returns: ImmutableList<'a>

ImmutableList.singleton item

Full Usage: ImmutableList.singleton item

Parameters:
    item : 'T

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

ImmutableList.skip index list

Full Usage: ImmutableList.skip index list

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

ImmutableList.skipUntil predicate list

Full Usage: ImmutableList.skipUntil predicate list

Parameters:
Returns: IImmutableList<'a>
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.skipWhile predicate list

Full Usage: ImmutableList.skipWhile predicate list

Parameters:
Returns: IImmutableList<'a>
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.splitAt index list

Full Usage: ImmutableList.splitAt index list

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

ImmutableList.tail list

Full Usage: ImmutableList.tail list

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

ImmutableList.take count list

Full Usage: ImmutableList.take count list

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

ImmutableList.takeUntil predicate list

Full Usage: ImmutableList.takeUntil predicate list

Parameters:
Returns: IImmutableList<'a>
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.takeWhile predicate list

Full Usage: ImmutableList.takeWhile predicate list

Parameters:
Returns: IImmutableList<'a>
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: IImmutableList<'a>

ImmutableList.toArray list

Full Usage: ImmutableList.toArray list

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

ImmutableList.toBuilder list

Full Usage: ImmutableList.toBuilder list

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

ImmutableList.toSeq list

Full Usage: ImmutableList.toSeq list

Parameters:
Returns: 'a seq
Modifiers: inline
Type parameters: 'a
list : ImmutableList<'a>
Returns: 'a seq

ImmutableList.truncate count list

Full Usage: ImmutableList.truncate count list

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

ImmutableList.tryFind predicate list

Full Usage: ImmutableList.tryFind predicate list

Parameters:
Returns: 'a option
predicate : 'a -> bool
list : IImmutableList<'a>
Returns: 'a option

ImmutableList.tryFindIndex predicate list

Full Usage: ImmutableList.tryFindIndex predicate list

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

ImmutableList.tryHead list

Full Usage: ImmutableList.tryHead list

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

ImmutableList.tryItem index list

Full Usage: ImmutableList.tryItem index list

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

ImmutableList.tryLast list

Full Usage: ImmutableList.tryLast list

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

ImmutableList.tryTail list

Full Usage: ImmutableList.tryTail list

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

ImmutableList.unfold generator state

Full Usage: ImmutableList.unfold generator state

Parameters:
    generator : 'a -> ('a * 'b) option
    state : 'a

Returns: ImmutableList<'b>
generator : 'a -> ('a * 'b) option
state : 'a
Returns: ImmutableList<'b>

ImmutableList.update f list

Full Usage: ImmutableList.update f list

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

ImmutableList.withItem index value list

Full Usage: ImmutableList.withItem index value list

Parameters:
Returns: IImmutableList<'a>

Replaces an element in the list at a given position with the specified element.

index : int
value : 'a
list : IImmutableList<'a>
Returns: IImmutableList<'a>