Ficus 0.0.2

Edit this page

RRBVector Module

Functions and values

Function or value Description

append vec1 vec2

Full Usage: append vec1 vec2

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
vec1 : RRBVector<'T>
vec2 : RRBVector<'T>
Returns: RRBVector<'T>

average vec

Full Usage: average vec

Parameters:
Returns: ^T
Modifiers: inline
Type parameters: ^T
vec : RRBVector<^T>
Returns: ^T

averageBy f vec

Full Usage: averageBy f vec

Parameters:
Returns: ^a
Modifiers: inline
Type parameters: 'T, ^a
f : 'T -> ^a
vec : RRBVector<'T>
Returns: ^a

choose chooser vec

Full Usage: choose chooser vec

Parameters:
    chooser : 'T -> 'U option
    vec : RRBVector<'T>

Returns: RRBVector<'U>
chooser : 'T -> 'U option
vec : RRBVector<'T>
Returns: RRBVector<'U>

chunkBySize chunkSize vec

Full Usage: chunkBySize chunkSize vec

Parameters:
Returns: RRBVector<RRBVector<'T>>
chunkSize : int
vec : RRBVector<'T>
Returns: RRBVector<RRBVector<'T>>

collect f vec

Full Usage: collect f vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
f : 'T -> RRBVector<'T>
vec : RRBVector<'T>
Returns: RRBVector<'T>

compareWith f vec1 vec2

Full Usage: compareWith f vec1 vec2

Parameters:
Returns: int
Modifiers: inline
Type parameters: 'T
f : 'T -> 'T -> int
vec1 : RRBVector<'T>
vec2 : RRBVector<'T>
Returns: int

concat vecs

Full Usage: concat vecs

Parameters:
Returns: RRBVector<'T>
vecs : seq<RRBVector<'T>>
Returns: RRBVector<'T>

contains item vec

Full Usage: contains item vec

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'T
item : 'T
vec : RRBVector<'T>
Returns: bool

countBy f vec

Full Usage: countBy f vec

Parameters:
Returns: RRBVector<'a * int>
f : 'T -> 'a
vec : RRBVector<'T>
Returns: RRBVector<'a * int>

distinct vec

Full Usage: distinct vec

Parameters:
Returns: RRBVector<'T>
vec : RRBVector<'T>
Returns: RRBVector<'T>

distinctBy f vec

Full Usage: distinctBy f vec

Parameters:
Returns: RRBVector<'T>
f : 'T -> 'a
vec : RRBVector<'T>
Returns: RRBVector<'T>

empty

Full Usage: empty

Returns: RRBVector<'T>
Returns: RRBVector<'T>

exactlyOne vec

Full Usage: exactlyOne vec

Parameters:
Returns: 'T
vec : RRBVector<'T>
Returns: 'T

except excludedVec vec

Full Usage: except excludedVec vec

Parameters:
Returns: RRBVector<'T>
excludedVec : RRBVector<'T>
vec : RRBVector<'T>
Returns: RRBVector<'T>

exists f vec

Full Usage: exists f vec

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: bool

exists2 f vec1 vec2

Full Usage: exists2 f vec1 vec2

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'T, 'U
f : 'T -> 'U -> bool
vec1 : RRBVector<'T>
vec2 : RRBVector<'U>
Returns: bool

filter pred vec

Full Usage: filter pred vec

Parameters:
Returns: RRBVector<'T>
pred : 'T -> bool
vec : RRBVector<'T>
Returns: RRBVector<'T>

filter2 pred vec1 vec2

Full Usage: filter2 pred vec1 vec2

Parameters:
Returns: RRBVector<'T * 'T>
pred : 'T -> 'T -> bool
vec1 : RRBVector<'T>
vec2 : RRBVector<'T>
Returns: RRBVector<'T * 'T>

filteri pred vec

Full Usage: filteri pred vec

Parameters:
    pred : int -> 'T -> bool
    vec : RRBVector<'T>

Returns: RRBVector<'T>
pred : int -> 'T -> bool
vec : RRBVector<'T>
Returns: RRBVector<'T>

filteri2 pred vec1 vec2

Full Usage: filteri2 pred vec1 vec2

Parameters:
Returns: RRBVector<'T * 'T>
pred : int -> 'T -> 'T -> bool
vec1 : RRBVector<'T>
vec2 : RRBVector<'T>
Returns: RRBVector<'T * 'T>

find f vec

Full Usage: find f vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: 'T

findBack f vec

Full Usage: findBack f vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: 'T

findIndex f vec

Full Usage: findIndex f vec

Parameters:
Returns: int
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: int

findIndexBack f vec

Full Usage: findIndexBack f vec

Parameters:
Returns: int
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: int

fold folder initState vec

Full Usage: fold folder initState vec

Parameters:
    folder : 'State -> 'T -> 'State
    initState : 'State
    vec : RRBVector<'T>

Returns: 'State
Modifiers: inline
Type parameters: 'State, 'T
folder : 'State -> 'T -> 'State
initState : 'State
vec : RRBVector<'T>
Returns: 'State

fold2 folder initState vec1 vec2

Full Usage: fold2 folder initState vec1 vec2

Parameters:
    folder : 'State -> 'T1 -> 'T2 -> 'State
    initState : 'State
    vec1 : RRBVector<'T1>
    vec2 : RRBVector<'T2>

Returns: 'State
Modifiers: inline
Type parameters: 'State, 'T1, 'T2
folder : 'State -> 'T1 -> 'T2 -> 'State
initState : 'State
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
Returns: 'State

foldBack initState folder vec

Full Usage: foldBack initState folder vec

Parameters:
    initState : 'State
    folder : 'T -> 'State -> 'State
    vec : RRBVector<'T>

Returns: 'State
Modifiers: inline
Type parameters: 'State, 'T
initState : 'State
folder : 'T -> 'State -> 'State
vec : RRBVector<'T>
Returns: 'State

foldBack2 initState folder vec1 vec2

Full Usage: foldBack2 initState folder vec1 vec2

Parameters:
    initState : 'State
    folder : 'T1 -> 'T2 -> 'State -> 'State
    vec1 : RRBVector<'T1>
    vec2 : RRBVector<'T2>

Returns: 'State
Modifiers: inline
Type parameters: 'State, 'T1, 'T2
initState : 'State
folder : 'T1 -> 'T2 -> 'State -> 'State
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
Returns: 'State

forall f vec

Full Usage: forall f vec

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: bool

forall2 f vec1 vec2

Full Usage: forall2 f vec1 vec2

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'T1, 'T2
f : 'T1 -> 'T2 -> bool
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
Returns: bool

groupBy f vec

Full Usage: groupBy f vec

Parameters:
Returns: RRBVector<'a * seq<'T>>
f : 'T -> 'a
vec : RRBVector<'T>
Returns: RRBVector<'a * seq<'T>>

head vec

Full Usage: head vec

Parameters:
Returns: 'T
vec : RRBVector<'T>
Returns: 'T

indexed vec

Full Usage: indexed vec

Parameters:
Returns: RRBVector<int * 'T>
vec : RRBVector<'T>
Returns: RRBVector<int * 'T>

init size f

Full Usage: init size f

Parameters:
    size : int
    f : int -> 'a

Returns: RRBVector<'a>
Modifiers: inline
Type parameters: 'a
size : int
f : int -> 'a
Returns: RRBVector<'a>

insert idx item vec

Full Usage: insert idx item vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
idx : int
item : 'T
vec : RRBVector<'T>
Returns: RRBVector<'T>

isEmpty vec

Full Usage: isEmpty vec

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: bool

item idx vec

Full Usage: item idx vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
idx : int
vec : RRBVector<'T>
Returns: 'T

iter f vec

Full Usage: iter f vec

Parameters:
Modifiers: inline
Type parameters: 'T
f : 'T -> unit
vec : RRBVector<'T>

iter2 f vec1 vec2

Full Usage: iter2 f vec1 vec2

Parameters:
Modifiers: inline
Type parameters: 'T1, 'T2
f : 'T1 -> 'T2 -> unit
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>

iteri f vec

Full Usage: iteri f vec

Parameters:
Modifiers: inline
Type parameters: 'T
f : int -> 'T -> unit
vec : RRBVector<'T>

iteri2 f vec1 vec2

Full Usage: iteri2 f vec1 vec2

Parameters:
Modifiers: inline
Type parameters: 'T1, 'T2
f : int -> 'T1 -> 'T2 -> unit
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>

last vec

Full Usage: last vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: 'T

length vec

Full Usage: length vec

Parameters:
Returns: int
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: int

map f vec

Full Usage: map f vec

Parameters:
Returns: RRBVector<'a>
f : 'T -> 'a
vec : RRBVector<'T>
Returns: RRBVector<'a>

map2 f vec1 vec2

Full Usage: map2 f vec1 vec2

Parameters:
Returns: RRBVector<'a>
f : 'T1 -> 'T2 -> 'a
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
Returns: RRBVector<'a>

map3 f vec1 vec2 vec3

Full Usage: map3 f vec1 vec2 vec3

Parameters:
Returns: RRBVector<'a>
f : 'T1 -> 'T2 -> 'T3 -> 'a
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
vec3 : RRBVector<'T3>
Returns: RRBVector<'a>

mapFold folder initState vec

Full Usage: mapFold folder initState vec

Parameters:
    folder : 'State -> 'T -> 'Result * 'State
    initState : 'State
    vec : RRBVector<'T>

Returns: RRBVector<'Result> * 'State
folder : 'State -> 'T -> 'Result * 'State
initState : 'State
vec : RRBVector<'T>
Returns: RRBVector<'Result> * 'State

mapFoldBack folder vec initState

Full Usage: mapFoldBack folder vec initState

Parameters:
    folder : 'T -> 'State -> 'Result * 'State
    vec : RRBVector<'T>
    initState : 'State

Returns: RRBVector<'Result> * 'State
folder : 'T -> 'State -> 'Result * 'State
vec : RRBVector<'T>
initState : 'State
Returns: RRBVector<'Result> * 'State

mapi f vec

Full Usage: mapi f vec

Parameters:
Returns: RRBVector<'a>
f : int -> 'T -> 'a
vec : RRBVector<'T>
Returns: RRBVector<'a>

mapi2 f vec1 vec2

Full Usage: mapi2 f vec1 vec2

Parameters:
Returns: RRBVector<'a>
f : int -> 'T1 -> 'T2 -> 'a
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
Returns: RRBVector<'a>

max vec

Full Usage: max vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: 'T

maxBy f vec

Full Usage: maxBy f vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T, 'a
f : 'T -> 'a
vec : RRBVector<'T>
Returns: 'T

min vec

Full Usage: min vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: 'T

minBy f vec

Full Usage: minBy f vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T, 'a
f : 'T -> 'a
vec : RRBVector<'T>
Returns: 'T

nth idx vec

Full Usage: nth idx vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
idx : int
vec : RRBVector<'T>
Returns: 'T

ofArray a

Full Usage: ofArray a

Parameters:
    a : 'T[]

Returns: RRBVector<'T>
a : 'T[]
Returns: RRBVector<'T>

ofList l

Full Usage: ofList l

Parameters:
    l : 'T list

Returns: RRBVector<'T>
l : 'T list
Returns: RRBVector<'T>

ofSeq s

Full Usage: ofSeq s

Parameters:
    s : seq<'T>

Returns: RRBVector<'T>
s : seq<'T>
Returns: RRBVector<'T>

pairwise vec

Full Usage: pairwise vec

Parameters:
Returns: RRBVector<'T * 'T>
vec : RRBVector<'T>
Returns: RRBVector<'T * 'T>

partition pred vec

Full Usage: partition pred vec

Parameters:
Returns: RRBVector<'T> * RRBVector<'T>
pred : 'T -> bool
vec : RRBVector<'T>
Returns: RRBVector<'T> * RRBVector<'T>

peek vec

Full Usage: peek vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: 'T

permute f vec

Full Usage: permute f vec

Parameters:
Returns: RRBVector<'T>
f : int -> int
vec : RRBVector<'T>
Returns: RRBVector<'T>

pick f vec

Full Usage: pick f vec

Parameters:
Returns: 'a
Modifiers: inline
Type parameters: 'T, 'a
f : 'T -> 'a option
vec : RRBVector<'T>
Returns: 'a

pop vec

Full Usage: pop vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: RRBVector<'T>

push item vec

Full Usage: push item vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
item : 'T
vec : RRBVector<'T>
Returns: RRBVector<'T>

reduce f vec

Full Usage: reduce f vec

Parameters:
Returns: 'T
Modifiers: inline
Type parameters: 'T
f : 'T -> 'T -> 'T
vec : RRBVector<'T>
Returns: 'T

reduceBack f vec

Full Usage: reduceBack f vec

Parameters:
Returns: 'T
f : 'T -> 'T -> 'T
vec : RRBVector<'T>
Returns: 'T

remove idx vec

Full Usage: remove idx vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
idx : int
vec : RRBVector<'T>
Returns: RRBVector<'T>

replicate count value

Full Usage: replicate count value

Parameters:
    count : int
    value : 'T

Returns: RRBVector<'T>
count : int
value : 'T
Returns: RRBVector<'T>

rev vec

Full Usage: rev vec

Parameters:
Returns: RRBVector<'T>
vec : RRBVector<'T>
Returns: RRBVector<'T>

scan f initState vec

Full Usage: scan f initState vec

Parameters:
    f : 'a -> 'T -> 'a
    initState : 'a
    vec : RRBVector<'T>

Returns: RRBVector<'a>
Modifiers: inline
Type parameters: 'a, 'T
f : 'a -> 'T -> 'a
initState : 'a
vec : RRBVector<'T>
Returns: RRBVector<'a>

scanBack f vec initState

Full Usage: scanBack f vec initState

Parameters:
    f : 'T -> 'a -> 'a
    vec : RRBVector<'T>
    initState : 'a

Returns: RRBVector<'a>
f : 'T -> 'a -> 'a
vec : RRBVector<'T>
initState : 'a
Returns: RRBVector<'a>

singleton item

Full Usage: singleton item

Parameters:
    item : 'T

Returns: RRBVector<'T>
item : 'T
Returns: RRBVector<'T>

skip count vec

Full Usage: skip count vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
count : int
vec : RRBVector<'T>
Returns: RRBVector<'T>

skipWhile pred vec

Full Usage: skipWhile pred vec

Parameters:
Returns: RRBVector<'T>
pred : 'T -> bool
vec : RRBVector<'T>
Returns: RRBVector<'T>

sort vec

Full Usage: sort vec

Parameters:
Returns: RRBVector<'T>
vec : RRBVector<'T>
Returns: RRBVector<'T>

sortBy f vec

Full Usage: sortBy f vec

Parameters:
Returns: RRBVector<'T>
f : 'T -> 'a
vec : RRBVector<'T>
Returns: RRBVector<'T>

sortByDescending f vec

Full Usage: sortByDescending f vec

Parameters:
Returns: RRBVector<'T>
f : 'T -> 'a
vec : RRBVector<'T>
Returns: RRBVector<'T>

sortDescending vec

Full Usage: sortDescending vec

Parameters:
Returns: RRBVector<'T>
vec : RRBVector<'T>
Returns: RRBVector<'T>

sortWith f vec

Full Usage: sortWith f vec

Parameters:
Returns: RRBVector<'T>
f : 'T -> 'T -> int
vec : RRBVector<'T>
Returns: RRBVector<'T>

split idx vec

Full Usage: split idx vec

Parameters:
Returns: RRBVector<'T> * RRBVector<'T>
Modifiers: inline
Type parameters: 'T
idx : int
vec : RRBVector<'T>
Returns: RRBVector<'T> * RRBVector<'T>

splitAt idx vec

Full Usage: splitAt idx vec

Parameters:
Returns: RRBVector<'T> * RRBVector<'T>
Modifiers: inline
Type parameters: 'T
idx : int
vec : RRBVector<'T>
Returns: RRBVector<'T> * RRBVector<'T>

splitInto splitCount vec

Full Usage: splitInto splitCount vec

Parameters:
Returns: RRBVector<RRBVector<'T>>
splitCount : int
vec : RRBVector<'T>
Returns: RRBVector<RRBVector<'T>>

sum vec

Full Usage: sum vec

Parameters:
Returns: ^T
Modifiers: inline
Type parameters: ^T
vec : RRBVector<^T>
Returns: ^T

sumBy f vec

Full Usage: sumBy f vec

Parameters:
Returns: ^a
Modifiers: inline
Type parameters: 'T, ^a
f : 'T -> ^a
vec : RRBVector<'T>
Returns: ^a

tail vec

Full Usage: tail vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: RRBVector<'T>

take n vec

Full Usage: take n vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
n : int
vec : RRBVector<'T>
Returns: RRBVector<'T>

takeWhile pred vec

Full Usage: takeWhile pred vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
pred : 'T -> bool
vec : RRBVector<'T>
Returns: RRBVector<'T>

toArray vec

Full Usage: toArray vec

Parameters:
Returns: 'T[]
vec : RRBVector<'T>
Returns: 'T[]

toList vec

Full Usage: toList vec

Parameters:
Returns: 'T list
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: 'T list

toSeq vec

Full Usage: toSeq vec

Parameters:
Returns: IEnumerable<'T>
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: IEnumerable<'T>

truncate n vec

Full Usage: truncate n vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
n : int
vec : RRBVector<'T>
Returns: RRBVector<'T>

tryFind f vec

Full Usage: tryFind f vec

Parameters:
Returns: 'T option
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: 'T option

tryFindBack f vec

Full Usage: tryFindBack f vec

Parameters:
Returns: 'T option
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: 'T option

tryFindIndex f vec

Full Usage: tryFindIndex f vec

Parameters:
Returns: int option
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: int option

tryFindIndexBack f vec

Full Usage: tryFindIndexBack f vec

Parameters:
Returns: int option
Modifiers: inline
Type parameters: 'T
f : 'T -> bool
vec : RRBVector<'T>
Returns: int option

tryHead vec

Full Usage: tryHead vec

Parameters:
Returns: 'T option
vec : RRBVector<'T>
Returns: 'T option

tryItem idx vec

Full Usage: tryItem idx vec

Parameters:
Returns: 'T option
Modifiers: inline
Type parameters: 'T
idx : int
vec : RRBVector<'T>
Returns: 'T option

tryLast vec

Full Usage: tryLast vec

Parameters:
Returns: 'T option
Modifiers: inline
Type parameters: 'T
vec : RRBVector<'T>
Returns: 'T option

tryPick f vec

Full Usage: tryPick f vec

Parameters:
Returns: 'a option
Modifiers: inline
Type parameters: 'T, 'a
f : 'T -> 'a option
vec : RRBVector<'T>
Returns: 'a option

unfold f initState

Full Usage: unfold f initState

Parameters:
    f : 'a -> ('b * 'a) option
    initState : 'a

Returns: RRBVector<'b>
Modifiers: inline
Type parameters: 'a, 'b
f : 'a -> ('b * 'a) option
initState : 'a
Returns: RRBVector<'b>

unzip vec

Full Usage: unzip vec

Parameters:
Returns: RRBVector<'T1> * RRBVector<'T2>
vec : RRBVector<'T1 * 'T2>
Returns: RRBVector<'T1> * RRBVector<'T2>

unzip3 vec

Full Usage: unzip3 vec

Parameters:
Returns: RRBVector<'T1> * RRBVector<'T2> * RRBVector<'T3>
vec : RRBVector<'T1 * 'T2 * 'T3>
Returns: RRBVector<'T1> * RRBVector<'T2> * RRBVector<'T3>

where pred vec

Full Usage: where pred vec

Parameters:
Returns: RRBVector<'T>
Modifiers: inline
Type parameters: 'T
pred : 'T -> bool
vec : RRBVector<'T>
Returns: RRBVector<'T>

windowed windowSize vec

Full Usage: windowed windowSize vec

Parameters:
Returns: RRBVector<RRBVector<'T>>
windowSize : int
vec : RRBVector<'T>
Returns: RRBVector<RRBVector<'T>>

windowedSeq windowSize vec

Full Usage: windowedSeq windowSize vec

Parameters:
Returns: seq<RRBVector<'T>>
windowSize : int
vec : RRBVector<'T>
Returns: seq<RRBVector<'T>>

zip vec1 vec2

Full Usage: zip vec1 vec2

Parameters:
Returns: RRBVector<'T1 * 'T2>
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
Returns: RRBVector<'T1 * 'T2>

zip3 vec1 vec2 vec3

Full Usage: zip3 vec1 vec2 vec3

Parameters:
Returns: RRBVector<'T1 * 'T2 * 'T3>
vec1 : RRBVector<'T1>
vec2 : RRBVector<'T2>
vec3 : RRBVector<'T3>
Returns: RRBVector<'T1 * 'T2 * 'T3>