Vec[A: Any #share]¶

A persistent vector based on the Hash Array Mapped Trie from 'Ideal Hash Trees' by Phil Bagwell.

class val Vec[A: Any #share]

Constructors¶

create¶

[Source]

new val create()
: Vec[A] val^

Returns¶

Vec[A] val^

Public Functions¶

size¶

[Source]

Return the amount of values in the vector.

fun box size()
: USize val

Returns¶

USize val

apply¶

[Source]

Get the i-th element, raising an error if the index is out of bounds.

fun box apply(
  i: USize val)
: val->A ?

Parameters¶

i: USize val

Returns¶

val->A ?

update¶

[Source]

Return a vector with the i-th element changed, raising an error if the index is out of bounds.

fun val update(
  i: USize val,
  value: val->A)
: Vec[A] val ?

Parameters¶

i: USize val
value: val->A

Returns¶

Vec[A] val ?

insert¶

[Source]

Return a vector with an element inserted. Elements after this are moved up by one index, extending the vector. An out of bounds index raises an error.

fun val insert(
  i: USize val,
  value: val->A)
: Vec[A] val ?

Parameters¶

i: USize val
value: val->A

Returns¶

Vec[A] val ?

delete¶

[Source]

Return a vector with an element deleted. Elements after this are moved down by one index, compacting the vector. An out of bounds index raises an error.

fun val delete(
  i: USize val)
: Vec[A] val ?

Parameters¶

i: USize val

Returns¶

Vec[A] val ?

remove¶

[Source]

Return a vector with n elements removed, beginning at index i.

fun val remove(
  i: USize val,
  n: USize val)
: Vec[A] val ?

Parameters¶

i: USize val
n: USize val

Returns¶

Vec[A] val ?

push¶

[Source]

Return a vector with the value added to the end.

fun val push(
  value: val->A)
: Vec[A] val

Parameters¶

value: val->A

Returns¶

Vec[A] val

pop¶

[Source]

Return a vector with the value at the end removed.

fun val pop()
: Vec[A] val ?

Returns¶

Vec[A] val ?

concat¶

[Source]

Return a vector with the values of the given iterator added to the end.

fun val concat(
  iter: Iterator[val->A] ref)
: Vec[A] val

Parameters¶

iter: Iterator[val->A] ref

Returns¶

Vec[A] val

find¶

[Source]

Find the nth appearance of value from the beginning of the vector, starting at offset and examining higher indices, and using the supplied predicate for comparisons. Returns the index of the value, or raise an error if the value isn't present.

By default, the search starts at the first element of the vector, returns the first instance of value found, and uses object identity for comparison.

fun val find(
  value: val->A,
  offset: USize val = 0,
  nth: USize val = 0,
  predicate: {(A, A): Bool}[A] val = lambda)
: USize val ?

Parameters¶

value: val->A
offset: USize val = 0
nth: USize val = 0
predicate: {(A, A): Bool}[A] val = lambda

Returns¶

USize val ?

contains¶

[Source]

Returns true if the vector contains value, false otherwise.

fun val contains(
  value: val->A,
  predicate: {(A, A): Bool}[A] val = lambda)
: Bool val

Parameters¶

value: val->A
predicate: {(A, A): Bool}[A] val = lambda

Returns¶

Bool val

slice¶

[Source]

Return a vector that is a clone of a portion of this vector. The range is exclusive and saturated.

fun val slice(
  from: USize val = 0,
  to: USize val = call,
  step: USize val = 1)
: Vec[A] val

Parameters¶

from: USize val = 0
to: USize val = call
step: USize val = 1

Returns¶

Vec[A] val

reverse¶

[Source]

Return a vector with the elements in reverse order.

fun val reverse()
: Vec[A] val

Returns¶

Vec[A] val

keys¶

[Source]

Return an iterator over the indices in the vector.

fun val keys()
: VecKeys[A] ref^

Returns¶

VecKeys[A] ref^

values¶

[Source]

Return an iterator over the values in the vector.

fun val values()
: VecValues[A] ref^

Returns¶

VecValues[A] ref^

pairs¶

[Source]

Return an iterator over the (index, value) pairs in the vector.

fun val pairs()
: VecPairs[A] ref^

Returns¶

VecPairs[A] ref^