#include <elm/imm/list.h>

Inheritance diagram for elm::imm::list< T >:

Classes
class	Collector

Public Member Functions
	list (void)

	list (const list< T > &l)

list< T > &	operator= (list< T > l)

const T &	hd (void) const

list< T >	tl (void) const

const T &	operator* (void) const

bool	isEmpty (void) const

	operator bool (void) const

int	length (void) const

bool	contains (const T &v)

bool	equals (list< T > l) const

bool	operator== (list< T > l) const

bool	operator!= (list< T > l) const

list< T >	concat (list< T > l)

list< T >	remove (const T &h)

Static Public Member Functions
static void	add (Collector &coll)

static void	remove (Collector &coll)

static list< T >	cons (const T &h, list< T > t)

Static Public Attributes
static list< T >	null

Detailed Description

template<class T>
class elm::imm::list< T >

Implementation of immutable and garbage collected list.

As C++ does not allow to implement easily and efficiently a garbage collector, the user of this class is responsible to provided its own collector using the function list<T>::add(object) with object inheriting from list<T>::Collector and implementing the member function list<T>::Collector::collect(). This function must call mark() for each list in use as in the example below:

list<int> first_list;
genstruct::Vector<list<int> > lists;
class MyCollector: public list<int>::Collector {
protected:
 virtual void collect(void) {
    mark(first_list);
    for(int i = 0; i < lists.count(); i++)
        mark(lists[i]);
 }
};
int main(void) {
    MyCollector coll;
    list<int>::add(coll);
    // work with lists now
}

Parameters

T	Type of items in the list.

Constructor & Destructor Documentation

template<class T>

elm::imm::list< T >::list ( void )

Build an empty list.

template<class T>

elm::imm::list< T >::list ( const list< T > & l )

Clone a list.

Member Function Documentation

template<class T>

static void elm::imm::list< T >::add ( Collector & coll )

static

template<class T>

list<T> elm::imm::list< T >::concat ( list< T > l )

References elm::imm::list< T >::cons(), elm::imm::list< T >::hd(), elm::imm::list< T >::isEmpty(), and elm::imm::list< T >::tl().

Referenced by elm::imm::operator+().

template<class T>

list< T > elm::imm::list< T >::cons	(	const T &	h,
		list< T >	t
	)

static

Build a new list by prepending h to t.

Parameters

h	Item to prepend.
t	List to use as tail.

Returns: Built list.

Referenced by elm::imm::list< T >::concat(), elm::imm::cons(), and elm::imm::list< T >::remove().

template<class T>

bool elm::imm::list< T >::contains ( const T & v )

Test if v is in the list. The Equiv<T> is used to perform the test of equality. Therefore, a user can provide its own implementation of Equiv<T> to change the usual behavior of the equality tests.

Parameters