squiggle/packages/website/docs/Api/List.md
2022-07-19 16:18:28 -07:00

1.7 KiB

sidebar_position title
7 List

Squiggle lists are a lot like Python lists or Ruby arrays. They accept all types.

myList = [3, normal(5, 2), "random"];

make

List.make: (number, 'a) => list<'a>

Returns an array of size n filled with the value.

List.make(4, 1); // creates the list [1, 1, 1, 1]

See Rescript implementation

toString

toString: (list<'a>) => string

length

length: (list<'a>) => number

upTo

List.upTo: (low:number, high:number) => list<number>
List.upTo(0, 5); // creates the list [0, 1, 2, 3, 4, 5]

Syntax taken from Ruby.

first

first: (list<'a>) => 'a

last

last: (list<'a>) => 'a

reverse

reverse: (list<'a>) => list<'a>

map

map: (list<'a>, a => b) => list<'b>

See Rescript implementation.

reduce

reduce: (list<'b>, 'a, ('a, 'b) => 'a) => 'a

reduce(arr, init, f)

Applies f to each element of arr. The function f has two paramaters, an accumulator and the next value from the array.

reduce([2, 3, 4], 1, {|acc, value| acc + value}) == 10

See Rescript implementation.

reduce reverse

reduceReverse: (list<'b>, 'a, ('a, 'b) => 'a) => 'a

Works like reduce, but the function is applied to each item from the last back to the first.

See Rescript implementation.