@effekt-lang/effekt 0.4.0 → 0.5.0

package/libraries/common/list.effekt

@@ -4,32 +4,32 @@ import effekt
 import option
 import exception
 
-// Immutable linked list for finite sequences of elements.
+/// Immutable linked list for finite sequences of elements.
 type List[A] {
   Nil();
   Cons(head: A, tail: List[A])
 }
 
-// Create an empty list.
-//
-// O(1)
+/// Create an empty list.
+///
+/// O(1)
 def empty[A](): List[A] = Nil()
 
-// Create a list with one element.
-//
-// O(1)
+/// Create a list with one element.
+///
+/// O(1)
 def singleton[A](x: A): List[A] = Cons(x, Nil())
 
-// Create a list of length `size` where all elements are `default`.
-//
-// O(size)
+/// Create a list of length `size` where all elements are `default`.
+///
+/// O(size)
 def fill[A](size: Int, default: A): List[A] = {
   build(size) { i => default }
 }
 
-// Create a list from a function `index` of given `size`.
-//
-// O(size)
+/// Create a list from a function `index` of given `size`.
+///
+/// O(size)
 def build[A](size: Int) { index: Int => A }: List[A] = {
   var result = empty()
   each(0, size) { i =>
@@ -38,52 +38,52 @@ def build[A](size: Int) { index: Int => A }: List[A] = {
   result.reverse
 }
 
-// Check if list is empty.
-//
-// O(1)
+/// Check if list is empty.
+///
+/// O(1)
 def isEmpty[A](l: List[A]): Bool = l match {
   case Nil() => true
   case Cons(a, rest) => false
 }
 
-// Check if list is nonempty.
-//
-// O(1)
+/// Check if list is nonempty.
+///
+/// O(1)
 def nonEmpty[A](l: List[A]): Bool = l match {
   case Nil() => false
   case Cons(a, rest) => true
 }
 
-// Return the first element of a given list.
-// Throws a `MissingValue` exception if it's empty.
-//
-// O(1)
+/// Return the first element of a given list.
+/// Throws a `MissingValue` exception if it's empty.
+///
+/// O(1)
 def head[A](l: List[A]): A / Exception[MissingValue] = l match {
   case Nil() => do raise(MissingValue(), "Trying to get the head of an empty list")
   case Cons(a, rest) => a
 }
 
-// Return all elements of a given list except the first element.
-// Throws a `MissingValue` exception if it's empty.
-//
-// O(1)
+/// Return all elements of a given list except the first element.
+/// Throws a `MissingValue` exception if it's empty.
+///
+/// O(1)
 def tail[A](l: List[A]): List[A] / Exception[MissingValue] = l match {
   case Nil() => do raise(MissingValue(), "Trying to get the head of an empty list")
   case Cons(a, rest) => rest
 }
 
-// Return the first element of a given list.
-// Returns `None()` if it's empty.
-//
-// O(1)
+/// Return the first element of a given list.
+/// Returns `None()` if it's empty.
+///
+/// O(1)
 def headOption[A](l: List[A]): Option[A] = l match {
   case Nil() => None()
   case Cons(a, rest) => Some(a)
 }
 
-// Returns the last element of a given list.
-//
-// O(N)
+/// Returns the last element of a given list.
+///
+/// O(N)
 def last[A](l: List[A]): A / Exception[MissingValue] = {
   def go(list: List[A]): A = {
     list match {
@@ -96,9 +96,9 @@ def last[A](l: List[A]): A / Exception[MissingValue] = {
   go(l)
 }
 
-// Get the value at given index.
-//
-// O(N)
+/// Get the value at given index.
+///
+/// O(N)
 def get[A](list: List[A], index: Int): A / Exception[OutOfBounds] = {
   def go(list: List[A], i: Int): A = {
     list match {
@@ -111,17 +111,17 @@ def get[A](list: List[A], index: Int): A / Exception[OutOfBounds] = {
   go(list, index)
 }
 
-// Traverse a list, applying the given action on every element.
-//
-// O(N)
+/// Traverse a list, applying the given action on every element.
+///
+/// O(N)
 def foreach[A](l: List[A]) { f: (A) => Unit } : Unit = l match {
   case Nil() => ()
   case Cons(head, tail) => f(head); tail.foreach {f}
 }
 
-// Traverse a list, applying the given action on every element.
-//
-// O(N)
+/// Traverse a list, applying the given action on every element.
+///
+/// O(N)
 def foreach[A](l: List[A]) { f: (A) {Control} => Unit } : Unit = {
   var remainder = l
   loop { {label} =>
@@ -134,9 +134,9 @@ def foreach[A](l: List[A]) { f: (A) {Control} => Unit } : Unit = {
   }
 }
 
-// Traverse a list, applying the given action on every element and its (zero-based) index.
-//
-// O(N)
+/// Traverse a list, applying the given action on every element and its (zero-based) index.
+///
+/// O(N)
 def foreachIndex[A](list: List[A]){ f: (Int, A) => Unit }: Unit = {
   def loop(index: Int, remainder: List[A]): Unit = remainder match {
     case Nil() => ()
@@ -147,9 +147,9 @@ def foreachIndex[A](list: List[A]){ f: (Int, A) => Unit }: Unit = {
   loop(0, list)
 }
 
-// Traverse a list, applying the given action on every element and its (zero-based) index.
-//
-// O(N)
+/// Traverse a list, applying the given action on every element and its (zero-based) index.
+///
+/// O(N)
 def foreachIndex[A](list: List[A]){ f: (Int, A) {Control} => Unit }: Unit = {
   var remainder = list
   var i = -1
@@ -164,20 +164,20 @@ def foreachIndex[A](list: List[A]){ f: (Int, A) {Control} => Unit }: Unit = {
   }
 }
 
-// Map a function `f` over elements in a given list.
-//
-// O(N)
+/// Map a function `f` over elements in a given list.
+///
+/// O(N)
 def map[A, B](l: List[A]) { f: A => B } : List[B] = {
   var acc = Nil[B]()
   l.foreach { el => acc = Cons(f(el), acc) }
   acc.reverse
 }
 
-// Map a function `f` over elements in a given list,
-// keeping only the elements for which the function returned `Some(...)`,
-// discarding the elements for which the function returned `None()`.
-//
-// O(N)
+/// Map a function `f` over elements in a given list,
+/// keeping only the elements for which the function returned `Some(...)`,
+/// discarding the elements for which the function returned `None()`.
+///
+/// O(N)
 def collect[A, B](l: List[A]) { f : A => Option[B] }: List[B] = {
   var acc = Nil[B]()
   l.foreach { a =>
@@ -190,9 +190,9 @@ def collect[A, B](l: List[A]) { f : A => Option[B] }: List[B] = {
   acc.reverse
 }
 
-// Map a function `f` over elements in a given list and concatenate the results.
-//
-// O(N)
+/// Map a function `f` over elements in a given list and concatenate the results.
+///
+/// O(N)
 def flatMap[A, B](l: List[A]) { f : A => List[B] }: List[B] = {
   var acc = Nil[B]()
   l.foreach { a =>
@@ -202,9 +202,9 @@ def flatMap[A, B](l: List[A]) { f : A => List[B] }: List[B] = {
   acc
 }
 
-// Check if predicate is true for all elements of the given list.
-//
-// O(N)
+/// Check if predicate is true for all elements of the given list.
+///
+/// O(N)
 def all[A](list: List[A]) { predicate: A => Bool }: Bool = {
   list match {
     case Cons(x, xs) => predicate(x) && all(xs) { predicate }
@@ -212,9 +212,9 @@ def all[A](list: List[A]) { predicate: A => Bool }: Bool = {
   }
 }
 
-// Check if predicate is true for at least one element of the given list.
-//
-// O(N)
+/// Check if predicate is true for at least one element of the given list.
+///
+/// O(N)
 def any[A](list: List[A]) { predicate: A => Bool }: Bool = {
   list match {
     case Cons(x, xs) => predicate(x) || any(xs) { predicate }
@@ -222,89 +222,89 @@ def any[A](list: List[A]) { predicate: A => Bool }: Bool = {
   }
 }
 
-// Fold a list using `f`, starting from the left given a starting value.
-//
-// O(N)
+/// Fold a list using `f`, starting from the left given a starting value.
+///
+/// O(N)
 def foldLeft[A, B](l: List[A], init: B) { f: (B, A) => B }: B = {
   var acc = init;
   l.foreach { x => acc = f(acc, x) };
   acc
 }
 
-// Fold a list using `f`, starting from the right given a starting value.
-//
-// O(N)
+/// Fold a list using `f`, starting from the right given a starting value.
+///
+/// O(N)
 def foldRight[A, B](l: List[A], init: B) { f: (A, B) => B }: B = {
   var acc = init;
   l.reverse.foreach { x => acc = f(x, acc) };
   acc
 }
 
-// Sum the elements of the list.
-//
-// O(N)
+/// Sum the elements of the list.
+///
+/// O(N)
 def sum(list: List[Int]): Int = {
   var n = 0;
   list.foreach { x => n = n + x };
   n
 }
 
-// Calculate the size of the list.
-//
-// O(N)
+/// Calculate the size of the list.
+///
+/// O(N)
 def size[A](l: List[A]): Int = {
   var n = 0;
   l.foreach { _ => n = n + 1 };
   n
 }
 
-// Reverse the list.
-//
-// O(N)
+/// Reverse the list.
+///
+/// O(N)
 def reverse[A](l: List[A]): List[A] = {
   var res = Nil[A]()
   l.foreach { el => res = Cons(el, res) }
   res
 }
 
-// Reverse a list `l` and append `other` to it.
-//
-// Example:
-// ```
-// > [1,2,3].reverseOnto([4,5,6])
-// [3,2,1,4,5,6]
-// ```
-//
-// O(|l|)
+/// Reverse a list `l` and append `other` to it.
+///
+/// Example:
+/// ```
+/// > [1,2,3].reverseOnto([4,5,6])
+/// [3,2,1,4,5,6]
+/// ```
+///
+/// O(|l|)
 def reverseOnto[A](l: List[A], other: List[A]): List[A] = l match {
   case Nil() => other
   case Cons(a, rest) => rest.reverseOnto(Cons(a, other))
 }
 
-// Concatenate list `l` with list `other`:
-//
-// Example:
-// ```
-// > [1,2,3].append([4,5,6])
-// [1,2,3,4,5,6]
-// ```
-//
-// O(N)
+/// Concatenate list `l` with list `other`:
+///
+/// Example:
+/// ```
+/// > [1,2,3].append([4,5,6])
+/// [1,2,3,4,5,6]
+/// ```
+///
+/// O(N)
 def append[A](l: List[A], other: List[A]): List[A] =
   l.reverse.reverseOnto(other)
 
-// Flatten a list of lists into a single list.
-//
-// Examples:
-// ```
-// > [[1, 2, 3], [4, 5], [6]].join()
-// [1, 2, 3, 4, 5, 6]
-//
-// > [[]].join()
-// []
-// ```
-//
-// O(N)
+/// Flatten a list of lists into a single list.
+///
+/// Examples:
+/// ```
+/// > [[1, 2, 3], [4, 5], [6]].join()
+/// [1, 2, 3, 4, 5, 6]
+///
+/// > [[]].join()
+/// []
+/// ```
+///
+/// O(N)
 def join[A](lists: List[List[A]]): List[A] = {
   var acc: List[A] = Nil()
   lists.foreach { list =>
@@ -313,19 +313,19 @@ def join[A](lists: List[List[A]]): List[A] = {
   acc
 }
 
-// Flatten a list of lists into a single list,
-// putting the `between` list in between each list in the input.
-//
-// Examples:
-// ```
-// > [[100], [200, 300], [400]].join([1, 2, 3])
-// [100, 1, 2, 3, 200, 300, 1, 2, 3, 400]
-//
-// > [[]].join([1, 2, 3])
-// []
-// ```
-//
-// O(N)
+/// Flatten a list of lists into a single list,
+/// putting the `between` list in between each list in the input.
+///
+/// Examples:
+/// ```
+/// > [[100], [200, 300], [400]].join([1, 2, 3])
+/// [100, 1, 2, 3, 200, 300, 1, 2, 3, 400]
+///
+/// > [[]].join([1, 2, 3])
+/// []
+/// ```
+///
+/// O(N)
 def join[A](lists: List[List[A]], between: List[A]): List[A] = {
   lists match {
     case Nil() => Nil()
@@ -336,27 +336,27 @@ def join[A](lists: List[List[A]], between: List[A]): List[A] = {
   }
 }
 
-// Take the first `n` elements of a given list.
-//
-// Examples:
-// ```
-// > [1, 2, 3].take(2)
-// [1, 2]
-//
-// > [1, 2, 3].take(0)
-// []
-//
-// > [1, 2, 3].take(3)
-// [1, 2, 3]
-//
-// > [1, 2, 3].take(5)
-// [1, 2, 3]
-//
-// > [1, 2, 3].take(-1)
-// []
-// ```
-//
-// O(n)
+/// Take the first `n` elements of a given list.
+///
+/// Examples:
+/// ```
+/// > [1, 2, 3].take(2)
+/// [1, 2]
+///
+/// > [1, 2, 3].take(0)
+/// []
+///
+/// > [1, 2, 3].take(3)
+/// [1, 2, 3]
+///
+/// > [1, 2, 3].take(5)
+/// [1, 2, 3]
+///
+/// > [1, 2, 3].take(-1)
+/// []
+/// ```
+///
+/// O(n)
 def take[A](l: List[A], n: Int): List[A] =
   if (n <= 0) {
     Nil()
@@ -365,27 +365,27 @@ def take[A](l: List[A], n: Int): List[A] =
     case Cons(a, rest) => Cons(a, rest.take(n - 1))
   }
 
-// Drop the first `n` elements of a given list.
-//
-// Examples:
-// ```
-// > [1, 2, 3].drop(2)
-// [3]
-//
-// > [1, 2, 3].drop(0)
-// [1, 2, 3]
-//
-// > [1, 2, 3].drop(3)
-// []
-//
-// > [1, 2, 3].drop(5)
-// []
-//
-// > [1, 2, 3].drop(-1)
-// [1, 2, 3]
-// ```
-//
-// O(n)
+/// Drop the first `n` elements of a given list.
+///
+/// Examples:
+/// ```
+/// > [1, 2, 3].drop(2)
+/// [3]
+///
+/// > [1, 2, 3].drop(0)
+/// [1, 2, 3]
+///
+/// > [1, 2, 3].drop(3)
+/// []
+///
+/// > [1, 2, 3].drop(5)
+/// []
+///
+/// > [1, 2, 3].drop(-1)
+/// [1, 2, 3]
+/// ```
+///
+/// O(n)
 def drop[A](l: List[A], n: Int): List[A] =
   if (n <= 0) {
     l
@@ -394,57 +394,57 @@ def drop[A](l: List[A], n: Int): List[A] =
     case Cons(a, rest) => rest.drop(n - 1)
   }
 
-// Return a slice of a given list from the starting index (inclusive)
-// to the given end index (exclusive).
-//
-// Examples:
-// ```
-// > [1, 2, 3, 4, 5, 6].slice(1, 4)
-// [2, 3, 4]
-//
-// > [1, 2, 3, 4, 5, 6].slice(1, 2)
-// [2]
-//
-// > [1, 2, 3, 4, 5, 6].slice(1, 1)
-// []
-//
-// > [1, 2, 3, 4, 5, 6].slice(4, 1)
-// []
-//
-// > [1, 2, 3, 4, 5, 6].slice(-100, 100)
-// [1, 2, 3, 4, 5, 6]
-// ```
-//
-// O(N)
+/// Return a slice of a given list from the starting index (inclusive)
+/// to the given end index (exclusive).
+///
+/// Examples:
+/// ```
+/// > [1, 2, 3, 4, 5, 6].slice(1, 4)
+/// [2, 3, 4]
+///
+/// > [1, 2, 3, 4, 5, 6].slice(1, 2)
+/// [2]
+///
+/// > [1, 2, 3, 4, 5, 6].slice(1, 1)
+/// []
+///
+/// > [1, 2, 3, 4, 5, 6].slice(4, 1)
+/// []
+///
+/// > [1, 2, 3, 4, 5, 6].slice(-100, 100)
+/// [1, 2, 3, 4, 5, 6]
+/// ```
+///
+/// O(N)
 def slice[A](list: List[A], start: Int, stopExclusive: Int): List[A] = {
   val prefix = list.drop(start)
   val length = stopExclusive - start
   prefix.take(length)
 }
 
-// Split the list at given index.
-//
-// Law: `val (l, r) = list.splitAt(i); l.append(r) === list`
-//
-// O(N)
+/// Split the list at given index.
+///
+/// Law: `val (l, r) = list.splitAt(i); l.append(r) === list`
+///
+/// O(N)
 def splitAt[A](list: List[A], index: Int): (List[A], List[A]) = {
   (list.take(index), list.drop(index))
 }
 
-// Update the element at given index in the list using the `update` function.
-// Returns the original list if the index is out of bounds.
-//
-// See: `modifyAt`
-// Examples:
-// ```
-// > [1, 2, 3].updateAt(1) { n => n + 100 }
-// [1, 102, 3]
-//
-// > [1, 2, 3].updateAt(10) { n => n + 100 }
-// [1, 2, 3]
-// ```
-//
-// O(N)
+/// Update the element at given index in the list using the `update` function.
+/// Returns the original list if the index is out of bounds.
+///
+/// See: `modifyAt`
+/// Examples:
+/// ```
+/// > [1, 2, 3].updateAt(1) { n => n + 100 }
+/// [1, 102, 3]
+///
+/// > [1, 2, 3].updateAt(10) { n => n + 100 }
+/// [1, 2, 3]
+/// ```
+///
+/// O(N)
 def updateAt[A](list: List[A], index: Int) { update: A => A }: List[A] = {
   list.splitAt(index) match {
     case (left, Cons(x, right)) =>
@@ -453,20 +453,20 @@ def updateAt[A](list: List[A], index: Int) { update: A => A }: List[A] = {
   }
 }
 
-// Modify the element at given index in the list using the `update` function.
-// Throws `OutOfBounds` if the index is out of bounds.
-//
-// See: `updateAt`
-// Examples:
-// ```
-// > [1, 2, 3].modifyAt(1) { n => n + 100 }
-// Some([1, 102, 3])
-//
-// > [1, 2, 3].modifyAt(10) { n => n + 100 }
-// None()
-// ```
-//
-// O(N)
+/// Modify the element at given index in the list using the `update` function.
+/// Throws `OutOfBounds` if the index is out of bounds.
+///
+/// See: `updateAt`
+/// Examples:
+/// ```
+/// > [1, 2, 3].modifyAt(1) { n => n + 100 }
+/// Some([1, 102, 3])
+///
+/// > [1, 2, 3].modifyAt(10) { n => n + 100 }
+/// None()
+/// ```
+///
+/// O(N)
 def modifyAt[A](list: List[A], index: Int) { update: A => A }: List[A] / Exception[OutOfBounds] = {
   list.splitAt(index) match {
     case (left, Cons(x, right)) =>
@@ -475,69 +475,69 @@ def modifyAt[A](list: List[A], index: Int) { update: A => A }: List[A] / Excepti
   }
 }
 
-// Delete the element at given index in the list.
-//
-// Example:
-// ```
-// > [1, 2, 3, 4].deleteAt(1)
-// [1, 3, 4]
-//
-// > [1, 2, 3, 4].deleteAt(-1)
-// [1, 2, 3, 4]
-//
-// > [1, 2, 3, 4].deleteAt(10)
-// [1, 2, 3, 4]
-// ```
-//
-// O(N)
+/// Delete the element at given index in the list.
+///
+/// Example:
+/// ```
+/// > [1, 2, 3, 4].deleteAt(1)
+/// [1, 3, 4]
+///
+/// > [1, 2, 3, 4].deleteAt(-1)
+/// [1, 2, 3, 4]
+///
+/// > [1, 2, 3, 4].deleteAt(10)
+/// [1, 2, 3, 4]
+/// ```
+///
+/// O(N)
 def deleteAt[A](list: List[A], index: Int): List[A] = {
   val left = list.slice(0, index)
   val right = list.slice(index + 1, list.size())
   left.append(right)
 }
 
-// Add an element at given index in the list.
-//
-// Examples:
-// ```
-// > [1, 2, 3].insert(-1, 0)
-// [0, 1, 2, 3]
-//
-// > [1, 2, 3].insert(0, 0)
-// [0, 1, 2, 3]
-//
-// > [1, 2, 3].insert(1, 0)
-// [1, 0, 2, 3]
-//
-// > [1, 2, 3].insert(3, 0)
-// [1, 2, 3, 0]
-//
-// > [1, 2, 3].insert(10, 0)
-// [1, 2, 3, 0]
-// ```
-//
-// O(N)
+/// Add an element at given index in the list.
+///
+/// Examples:
+/// ```
+/// > [1, 2, 3].insert(-1, 0)
+/// [0, 1, 2, 3]
+///
+/// > [1, 2, 3].insert(0, 0)
+/// [0, 1, 2, 3]
+///
+/// > [1, 2, 3].insert(1, 0)
+/// [1, 0, 2, 3]
+///
+/// > [1, 2, 3].insert(3, 0)
+/// [1, 2, 3, 0]
+///
+/// > [1, 2, 3].insert(10, 0)
+/// [1, 2, 3, 0]
+/// ```
+///
+/// O(N)
 def insert[A](list: List[A], index: Int, x: A): List[A] = {
   val (left, right) = list.splitAt(index)
   left.append(Cons(x, right))
 }
 
-// Replace an element at given index in the list.
-// Returns the original list when the index is out of bounds.
-//
-// Examples:
-// ```
-// > [1, 2, 3].replace(0, 42)
-// [42, 2, 3]
-//
-// > [1, 2, 3].replace(-1, 42)
-// [1, 2, 3]
-//
-// > [1, 2, 3].replace(10, 42)
-// [1, 2, 3]
-// ```
-//
-// O(N)
+/// Replace an element at given index in the list.
+/// Returns the original list when the index is out of bounds.
+///
+/// Examples:
+/// ```
+/// > [1, 2, 3].replace(0, 42)
+/// [42, 2, 3]
+///
+/// > [1, 2, 3].replace(-1, 42)
+/// [1, 2, 3]
+///
+/// > [1, 2, 3].replace(10, 42)
+/// [1, 2, 3]
+/// ```
+///
+/// O(N)
 def replace[A](list: List[A], index: Int, x: A): List[A] = {
   if (index < 0 || index >= list.size()) {
     list
@@ -548,25 +548,25 @@ def replace[A](list: List[A], index: Int, x: A): List[A] = {
   }
 }
 
-// Produce a list of pairs from a pair of lists.
-// The length of the result is the minimum of lengths of the two lists.
-//
-// Examples:
-// ```
-// > zip([1, 2, 3], [100, 200, 300])
-// [(1, 100), (2, 200), (3, 300)]
-//
-// > zip([1, 2, 3], Nil[Int]())
-// []
-//
-// > zip(Nil[Int](), [1, 2, 3])
-// []
-//
-// > zip([1, 2, 3], [42])
-// [(1, 42)]
-// ```
-//
-// O(N)
+/// Produce a list of pairs from a pair of lists.
+/// The length of the result is the minimum of lengths of the two lists.
+///
+/// Examples:
+/// ```
+/// > zip([1, 2, 3], [100, 200, 300])
+/// [(1, 100), (2, 200), (3, 300)]
+///
+/// > zip([1, 2, 3], Nil[Int]())
+/// []
+///
+/// > zip(Nil[Int](), [1, 2, 3])
+/// []
+///
+/// > zip([1, 2, 3], [42])
+/// [(1, 42)]
+/// ```
+///
+/// O(N)
 def zip[A, B](left: List[A], right: List[B]): List[(A, B)] = {
   def go(acc: List[(A, B)], left: List[A], right: List[B]): List[(A, B)] = {
     (left, right) match {
@@ -580,25 +580,25 @@ def zip[A, B](left: List[A], right: List[B]): List[(A, B)] = {
   go(Nil(), left, right)
 }
 
-// Combine two lists with the given function.
-// The length of the result is the minimum of lengths of the two lists.
-//
-// Examples:
-// ```
-// > zipWith([1, 2, 3], [100, 200, 300]) { (a, b) => a + b }
-// [101, 202, 303]
-//
-// > zipWith([1, 2, 3], Nil[Int]()) { (a, b) => a + b }
-// []
-//
-// > zipWith(Nil[Int](), [1, 2, 3]) { (a, b) => a + b }
-// []
-//
-// > zipWith([1, 2, 3], [42]) { (a, b) => a + b }
-// [43]
-// ```
-//
-// O(N)
+/// Combine two lists with the given function.
+/// The length of the result is the minimum of lengths of the two lists.
+///
+/// Examples:
+/// ```
+/// > zipWith([1, 2, 3], [100, 200, 300]) { (a, b) => a + b }
+/// [101, 202, 303]
+///
+/// > zipWith([1, 2, 3], Nil[Int]()) { (a, b) => a + b }
+/// []
+///
+/// > zipWith(Nil[Int](), [1, 2, 3]) { (a, b) => a + b }
+/// []
+///
+/// > zipWith([1, 2, 3], [42]) { (a, b) => a + b }
+/// [43]
+/// ```
+///
+/// O(N)
 def zipWith[A, B, C](left: List[A], right: List[B]) { combine : (A, B) => C }: List[C] = {
   def go(acc: List[C], left: List[A], right: List[B]): List[C] = {
     (left, right) match {
@@ -612,15 +612,15 @@ def zipWith[A, B, C](left: List[A], right: List[B]) { combine : (A, B) => C }: L
   go(Nil(), left, right)
 }
 
-// Produce a pair of lists from a list of pairs.
-//
-// Examples:
-// ```
-// > [(1, 100), (2, 200), (3, 300)].unzip()
-// ([1, 2, 3], [100, 200, 300])
-// ```
-//
-// O(N)
+/// Produce a pair of lists from a list of pairs.
+///
+/// Examples:
+/// ```
+/// > [(1, 100), (2, 200), (3, 300)].unzip()
+/// ([1, 2, 3], [100, 200, 300])
+/// ```
+///
+/// O(N)
 def unzip[A, B](pairs: List[(A, B)]): (List[A], List[B]) = {
   pairs match {
     case Nil() => (Nil(), Nil())
@@ -630,11 +630,11 @@ def unzip[A, B](pairs: List[(A, B)]): (List[A], List[B]) = {
   }
 }
 
-// Partition a given list into two lists.
-// The left list contains the elements that satsify the predicate,
-// the right list contains the elements that do not.
-//
-// O(N)
+/// Partition a given list into two lists.
+/// The left list contains the elements that satsify the predicate,
+/// the right list contains the elements that do not.
+///
+/// O(N)
 def partition[A](l: List[A]) { pred: A => Bool }: (List[A], List[A]) = {
   var lefts: List[A] = Nil()
   var rights: List[A] = Nil()
@@ -649,11 +649,11 @@ def partition[A](l: List[A]) { pred: A => Bool }: (List[A], List[A]) = {
   (lefts.reverse, rights.reverse)
 }
 
-// Sort a list using a given comparison function.
-//
-// Note: this implementation is not stacksafe!
-//
-// O(N log N)
+/// Sort a list using a given comparison function.
+///
+/// Note: this implementation is not stacksafe!
+///
+/// O(N log N)
 def sortBy[A](l: List[A]) { compare: (A, A) => Bool }: List[A] =
   l match {
     case Nil() => Nil()
@@ -667,9 +667,9 @@ def sortBy[A](l: List[A]) { compare: (A, A) => Bool }: List[A] =
 def sort(l: List[Int]): List[Int] = l.sortBy { (a, b) => a < b }
 def sort(l: List[Double]): List[Double] = l.sortBy { (a, b) => a < b }
 
-// Check if a list is sorted according to the given comparison function.
-//
-// O(N)
+/// Check if a list is sorted according to the given comparison function.
+///
+/// O(N)
 def isSortedBy[A](list: List[A]) { compare: (A, A) => Bool }: Bool = {
   def go(list: List[A]): Bool = {
     list match {