Logo Deedle

ReadOnlyCollection Module

Provides helper functions for working with `ReadOnlyCollection` similar to those in the `Array` module. Most importantly, F# 3.0 does not know that array implements `IList`.

Functions and values

Function or value Description

empty

Full Usage: empty

Returns: ReadOnlyCollection<'T>
Type parameters: 'T

Returns empty readonly collection

Returns: ReadOnlyCollection<'T>

fold op init list

Full Usage: fold op init list

Parameters:
Returns: 'a
Modifiers: inline
Type parameters: 'a, 'T

Fold elements of the ReadOnlyCollection

op : 'a -> 'T -> 'a
init : 'a
list : ReadOnlyCollection<'T>
Returns: 'a

foldOptional op init list

Full Usage: foldOptional op init list

Parameters:
Returns: 'a
Modifiers: inline
Type parameters: 'a, 'T

Fold elements of the ReadOnlyCollection, skipping over missing values

op : 'a -> 'T -> 'a
init : 'a
list : ReadOnlyCollection<OptionalValue<'T>>
Returns: 'a

length list

Full Usage: length list

Parameters:
Returns: int
Modifiers: inline
Type parameters: 'T

Count elements of the ReadOnlyCollection

list : ReadOnlyCollection<'T>
Returns: int

map f list

Full Usage: map f list

Parameters:
Returns: ReadOnlyCollection<'a>
Modifiers: inline
Type parameters: 'T, 'a

Transform all elements of ReadOnlyCollection using the specified function

f : 'T -> 'a
list : ReadOnlyCollection<'T>
Returns: ReadOnlyCollection<'a>

ofArray array

Full Usage: ofArray array

Parameters:
    array : 'T[]

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

Converts an array to ReadOnlyCollection.

array : 'T[]
Returns: ReadOnlyCollection<'T>

ofSeq seq

Full Usage: ofSeq seq

Parameters:
    seq : 'T seq

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

Converts a lazy sequence to fully evaluated ReadOnlyCollection

seq : 'T seq
Returns: ReadOnlyCollection<'T>

reduce op list

Full Usage: reduce op list

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T

Reduce elements of the ReadOnlyCollection

op : 'T -> 'T -> 'T
list : ReadOnlyCollection<'T>
Returns: 'T

reduceOptional op list

Full Usage: reduceOptional op list

Parameters:
Returns: 'T opt
Modifiers: inline
Type parameters: 'T

Reduce elements of the ReadOnlyCollection, skipping over missing values

op : 'T -> 'T -> 'T
list : ReadOnlyCollection<OptionalValue<'T>>
Returns: 'T opt

Type something to start searching.