Home Manual Reference Source

Function

Static Public Summary
public
public

Deep(M: *, left: *, middle: *, right: *)

public

Digit()

public

Empty(M: *)

public

Four(a: *, b: *, c: *, d: *)

public

Lazy(thunk: *)

public

Node2(v: *, a: *, b: *)

public

Node3(v: *, a: *, b: *, c: *)

public

One(a: *)

public

Single(M: *, value: *)

public

Split(left: *, middle: *, right: *)

public

Three(a: *, b: *, c: *)

public

Tree()

Base class for all implementations.
public

Two(a: *, b: *)

public

app3(A: *, list: *, B: *): *

public

append(tree: *, iterable: *): *

public

cache(M: *): *

public

deepL(M: Measure, left: Array, middle: FingerTree, right: Digit): *

public

deepR(M: Measure, left: Digit, middle: FingerTree, right: Array): *

public

delay(thunk: Function): Tree

Wraps a tree-returning function with a tree proxy that will shallow evaluate as soon as a method is called on it.
public

empty(M: *)

public

from(M: *, iterable: *): *

public

node2(M: *, a: *, b: *): *

public

node3(M: *, a: *, b: *, c: *): *

public

nodes(M: *, list: *): *

public

prepend(tree: *, iterable: *): *

Static Private Summary
private
private

_app3(A: *, B: *): *

private

_append(tree: *, list: *): *

private

_deepL(M: *, left: *, middle: *, right: *): *

private

_deepR(M: *, left: *, middle: *, right: *): *

private

_digit(list: Array): Digit

Creates a Digit from as small list.
private

_from_digit(M: *, digit: *): *

private

_from_small_list(M: *, list: *): *

private

_prepend(tree: *, list: *): *

Static Public

public CachedMeasure(M: *) source 

import {CachedMeasure} from '@functional-data-structure/finger-tree/src/0-core/measure/CachedMeasure.js'

Params:

NameTypeAttributeDescription
M *

public Deep(M: *, left: *, middle: *, right: *) source 

import {Deep} from '@functional-data-structure/finger-tree/src/3-tree/implementations/2-Deep.js'

Params:

NameTypeAttributeDescription
M *
left *
middle *
right *

public Digit() source 

import {Digit} from '@functional-data-structure/finger-tree/src/1-digit/0-Digit.js'

public Empty(M: *) source 

import {Empty} from '@functional-data-structure/finger-tree/src/3-tree/implementations/0-Empty.js'

Params:

NameTypeAttributeDescription
M *

public Four(a: *, b: *, c: *, d: *) source 

import {Four} from '@functional-data-structure/finger-tree/src/1-digit/4-Four.js'

Params:

NameTypeAttributeDescription
a *
b *
c *
d *

public Lazy(thunk: *) source 

import {Lazy} from '@functional-data-structure/finger-tree/src/4-lazy/0-Lazy.js'

Params:

NameTypeAttributeDescription
thunk *

public Node2(v: *, a: *, b: *) source 

import {Node2} from '@functional-data-structure/finger-tree/src/2-node/2-Node2.js'

Params:

NameTypeAttributeDescription
v *
a *
b *

public Node3(v: *, a: *, b: *, c: *) source 

import {Node3} from '@functional-data-structure/finger-tree/src/2-node/3-Node3.js'

Params:

NameTypeAttributeDescription
v *
a *
b *
c *

public One(a: *) source 

import {One} from '@functional-data-structure/finger-tree/src/1-digit/1-One.js'

Params:

NameTypeAttributeDescription
a *

public Single(M: *, value: *) source 

import {Single} from '@functional-data-structure/finger-tree/src/3-tree/implementations/1-Single.js'

Params:

NameTypeAttributeDescription
M *
value *

public Split(left: *, middle: *, right: *) source 

import {Split} from '@functional-data-structure/finger-tree/src/0-core/split/Split.js'

Params:

NameTypeAttributeDescription
left *
middle *
right *

public Three(a: *, b: *, c: *) source 

import {Three} from '@functional-data-structure/finger-tree/src/1-digit/3-Three.js'

Params:

NameTypeAttributeDescription
a *
b *
c *

public Tree() source 

import {Tree} from '@functional-data-structure/finger-tree/src/3-tree/base/Tree.js'

Base class for all implementations.

public Two(a: *, b: *) source 

import {Two} from '@functional-data-structure/finger-tree/src/1-digit/2-Two.js'

Params:

NameTypeAttributeDescription
a *
b *

public app3(A: *, list: *, B: *): * source 

import {app3} from '@functional-data-structure/finger-tree/src/0-core/concatenate/app3.js'

Params:

NameTypeAttributeDescription
A *
list *
B *

Return:

*

public append(tree: *, iterable: *): * source 

import {append} from '@functional-data-structure/finger-tree/src/0-core/concatenate/append.js'

Params:

NameTypeAttributeDescription
tree *
iterable *

Return:

*

public cache(M: *): * source 

import {cache} from '@functional-data-structure/finger-tree/src/0-core/measure/cache.js'

Params:

NameTypeAttributeDescription
M *

Return:

*

public deepL(M: Measure, left: Array, middle: FingerTree, right: Digit): * source 

import {deepL} from '@functional-data-structure/finger-tree/src/0-core/split/deepL.js'

Params:

NameTypeAttributeDescription
M Measure
left Array
middle FingerTree
right Digit

Return:

*

public deepR(M: Measure, left: Digit, middle: FingerTree, right: Array): * source 

import {deepR} from '@functional-data-structure/finger-tree/src/0-core/split/deepR.js'

Params:

NameTypeAttributeDescription
M Measure
left Digit
middle FingerTree
right Array

Return:

*

public delay(thunk: Function): Tree source 

import {delay} from '@functional-data-structure/finger-tree/src/4-lazy/1-delay.js'

Wraps a tree-returning function with a tree proxy that will shallow evaluate as soon as a method is called on it.

Params:

NameTypeAttributeDescription
thunk Function

The function that evaluates to the underlying tree.

Return:

Tree

The lazy tree.

public empty(M: *) source 

import {empty} from '@functional-data-structure/finger-tree/src/5-api.js'

Params:

NameTypeAttributeDescription
M *

public from(M: *, iterable: *): * source 

import {from} from '@functional-data-structure/finger-tree/src/0-core/concatenate/from.js'

Params:

NameTypeAttributeDescription
M *
iterable *

Return:

*

public node2(M: *, a: *, b: *): * source 

import {node2} from '@functional-data-structure/finger-tree/src/2-node/node2.js'

Params:

NameTypeAttributeDescription
M *
a *
b *

Return:

*

public node3(M: *, a: *, b: *, c: *): * source 

import {node3} from '@functional-data-structure/finger-tree/src/2-node/node3.js'

Params:

NameTypeAttributeDescription
M *
a *
b *
c *

Return:

*

public nodes(M: *, list: *): * source 

import {nodes} from '@functional-data-structure/finger-tree/src/0-core/concatenate/nodes.js'

Params:

NameTypeAttributeDescription
M *
list *

Return:

*

public prepend(tree: *, iterable: *): * source 

import {prepend} from '@functional-data-structure/finger-tree/src/0-core/concatenate/prepend.js'

Params:

NameTypeAttributeDescription
tree *
iterable *

Return:

*

Static Private

private _EmptyGenerator() source 

import {_EmptyGenerator} from '@functional-data-structure/finger-tree/src/0-core/_fast/fast-iterators/1-_EmptyGenerator.js'

private _app3(A: *, B: *): * source 

import {_app3} from '@functional-data-structure/finger-tree/src/0-core/_fast/_app3.js'

Params:

NameTypeAttributeDescription
A *
B *

Return:

*

private _append(tree: *, list: *): * source 

import {_append} from '@functional-data-structure/finger-tree/src/0-core/_fast/_append.js'

Params:

NameTypeAttributeDescription
tree *
list *

Return:

*

private _deepL(M: *, left: *, middle: *, right: *): * source 

import {_deepL} from '@functional-data-structure/finger-tree/src/0-core/_fast/_deepL.js'

Params:

NameTypeAttributeDescription
M *
left *
middle *
right *

Return:

*

private _deepR(M: *, left: *, middle: *, right: *): * source 

import {_deepR} from '@functional-data-structure/finger-tree/src/0-core/_fast/_deepR.js'

Params:

NameTypeAttributeDescription
M *
left *
middle *
right *

Return:

*

private _digit(list: Array): Digit source 

import {_digit} from '@functional-data-structure/finger-tree/src/0-core/_fast/_digit.js'

Creates a Digit from as small list.

It should never be called on length 4 lists since it is only called on results of splitDigit which outputs lists of length at most 3.

Params:

NameTypeAttributeDescription
list Array

A list of length 1, 2, or 3.

Return:

Digit

A digit containing the elements of list in order.

private _from_digit(M: *, digit: *): * source 

import {_from_digit} from '@functional-data-structure/finger-tree/src/0-core/_fast/_from_digit.js'

Params:

NameTypeAttributeDescription
M *
digit *

Return:

*

private _from_small_list(M: *, list: *): * source 

import {_from_small_list} from '@functional-data-structure/finger-tree/src/0-core/_fast/_from_small_list.js'

Params:

NameTypeAttributeDescription
M *
list *

Return:

*

private _prepend(tree: *, list: *): * source 

import {_prepend} from '@functional-data-structure/finger-tree/src/0-core/_fast/_prepend.js'

Params:

NameTypeAttributeDescription
tree *
list *

Return:

*