Skip to content

Seq

This module provides functions for manipulating Sequences. Sequences are bi-directional, immutable data structures with constant time random element lookup. Strings in Yona are specially optimized sequences of UTF-8 characters.

Usage

There is a special syntax to create an empty sequence: [] or "". Sequences support special operators for adding elements or joining with other sequences.

Folding a sequence

Folding a sequence is a process of iterating over its values while producing one result value. An example of a folding function could be a sum function, that iterates over all elements and adds them up, producing a single result.

Sequences can be folded from both directions - left or right.

Module Seq contains functions foldl and foldr for folding from the left or right side respectively.

Functions foldl and foldr take 3 arguments: * sequence to fold * 2-argument lambda (accumulator, element) returning a new value of an accumulator * initial value of the accumulator

This example shows how to sum up a sequence:

Seq::foldl [1, 2, 3] (\acc val -> acc + val) 0

Reducing a sequence

Reducing a sequence means applying a transducer onto a sequence. Transducers are a generic, high-level method for implementing operations over a data structure.

Function reduce takes 2 arguments: * sequence to reduce * transducer

Example with a filter transducer:

Seq::reducel [-2,-1,0,1,2] <| Transducers::filter \val -> val < 0 (0, \acc val -> acc + val, \acc -> acc * 2)

This example will produce -6, as it sums up all negative numbers in the sequence.

Obtaining a length of a sequence

Function len returns a length of a sequence:

length = Seq::len [1, 2, 3]

Splitting a sequence at an index

Function splitAt splits the sequence at a given index into a tuple of two sequences:

Seq::splitAt 2 [1, 2, 3, 4, 5]

will yield ([1, 2], [3, 4, 5])

Checking whether a sequence is a string

Function is_string checks whether a sequence is a string. It can be useful in guard expressions for example.

Seq::is_string "hello"

will result in a true.

Looking up an element by an index

Function lookup takes an index and a sequence and returns an element on that index. It throws :badarg exception if the index is not found.

Seq::lookup 2 [1, 2, 3]

Taking first n elements

Function takes takes first n elements. It throws :badarg exception if the n is greater or equal than the length of the sequence.

Seq::take 2 [1, 2, 3]  # returns [1, 2]

Dropping first n elements

Function drop drops first n elements. It throws :badarg exception if the n is greater or equal than the length of the sequence.

Seq::drops 2 [1, 2, 3]  # returns [3]

Zipping two sequences into one

Function zip takes two sequences and produces one with tuples, one from each sequence.

Example:

Seq::zip [1, 2, 3] [4, 5, 6]

Will create a new sequence [(1, 4), (2, 5), (3, 6)].


Last update: August 17, 2020