FList (chocosolver 0.1-SNAPSHOT API)

java.lang.Object
- org.clafer.collection.FList<E>

Type Parameters:
E - the type of the elements

All Implemented Interfaces:

Iterable<E>
```
public abstract class FList<E>
extends Object
implements Iterable<E>
```
Persistent singly-linked list. Useful for recursive algorithms.

Author:

jimmy

Method Summary

Methods
Modifier and Type	Method and Description
`static <E> FList<E>`	`cons(E head, FList<E> tail)` Functional-programming cons.
`static <E> FList<E>`	`empty()` Returns an empty list.
`abstract E`	`getHead()` Returns the first element of the list.
`abstract FList<E>`	`getTail()` Returns the a sublist of this list without the first element.
`abstract boolean`	`isEmpty()` Checks if the list is empty.
`static <E> FList<E>`	`single(E item)` A list containing a single element.
`static <E> FList<E>`	`snoc(FList<E> head, E tail)` Functional-programming snoc.
`abstract List<E>`	`toList()` Converts this functional list to an imperative list.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - getHead
```
public abstract E getHead()
```
    Returns the first element of the list.
    
    Returns:
    the head of the list
  - getTail
```
public abstract FList<E> getTail()
```
    Returns the a sublist of this list without the first element.
    
    Returns:
    the tail of the list
  - isEmpty
```
public abstract boolean isEmpty()
```
    Checks if the list is empty.
    
    Returns:
    true if and only if the list is empty, false otherwise
  - toList
```
public abstract List<E> toList()
```
    Converts this functional list to an imperative list.
    
    Returns:
    a copy of this list
  - empty
```
public static <E> FList<E> empty()
```
    Returns an empty list. The empty list is represented by null.
    
    Type Parameters:
    E - the type of the elements
    
    Returns:
    an empty list
  - single
```
public static <E> FList<E> single(E item)
```
    A list containing a single element.
    
    Type Parameters:
    E - the type of the elements
    Parameters:
    item - the element of the list
    
    Returns:
    a list of size 1
  - cons
```
public static <E> FList<E> cons(E head,
                FList<E> tail)
```
    Functional-programming cons. Nondestructive.
    
    Type Parameters:
    E - the type of the elements
    Parameters:
    head - the beginning of the new list
    tail - the end of the new list
    
    Returns:
    a copy of the original list with head appended at the start
  - snoc
```
public static <E> FList<E> snoc(FList<E> head,
                E tail)
```
    Functional-programming snoc. Nondestructive.
    
    Type Parameters:
    E - the type of the elements
    Parameters:
    head - the beginning of the new list
    tail - the end of the new list
    
    Returns:
    a copy of the original list with tail appended at the end

Class FList<E>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

getHead

getTail

isEmpty

toList

empty

single

cons

snoc