list.h File Reference

Declaration of the IlList class. More...

#include <ilog/alloc.h>

Classes
class	IlList
	A predefined list class that stores IlvAnys. More...
class	IlList
	A predefined list class that stores IlvAnys. More...
class	IlListIterator
	A predefined list iterator class that iterates on IlLists. More...
class	IlListIterator
	A predefined list iterator class that iterates on IlLists. More...
class	IlListIteratorOf(NAME)
	An unsafe iterator of lists. More...
class	IlListOf(NAME)
	A generic class that handles lists. More...
class	IlSafeListIterator
	A predefined safe list iterator class that iterates on IlLists. More...
class	IlSafeListIterator
	A predefined safe list iterator class that iterates on IlLists. More...
class	IlSafeListIteratorOf(NAME)
	A safe iterator of lists. More...
Defines
#define	IlDefineListOf(NAME, TYPE)
	Defines a new list.
#define	IlMapList(list, type, arg, exp)
	Enumerates a new list.
#define	IlMapList(LIST, TYPE, VARIABLE, EXPRESSION)
	Enumerates a new list.

---

Detailed Description

Declaration of the IlList class.

[library ilog ilog/list.h]

---

Define Documentation

#define IlDefineListOf	(	NAME,
		TYPE		)

Defines a new list.

This macro defines a new class, called IlListOf(NAME), that is a list of elements of the type TYPE.

Parameters:

	NAME	The identifier of the new list, as it appears in IlListOf(NAME).
	TYPE	The type of the elements stored in this list. Note that this type must be able to be cast to and from a void*.

#define IlMapList	(	list,
		type,
		arg,
		exp		)

Enumerates a new list.

This macro calls the expression EXPRESSION for each element of the list LIST. Each element is stored in the variable VARIABLE before EXPRESSION is called. You must have defined VARIABLE as a variable of the type TYPE before you call IlMapList.

Parameters:

	LIST	The list that is enumerated. This must be a pointer to a list that stores elements of the type TYPE.
	TYPE	The type of the elements of this list.
	VARIABLE	The name of the variable to be set.
	EXPRESSION	The expression that is called for each element. Use the contents of VARIABLE in the expression to get the elements.

#define IlMapList	(	LIST,
		TYPE,
		VARIABLE,
		EXPRESSION		)

Enumerates a new list.

This macro calls the expression EXPRESSION for each element of the list LIST. Each element is stored in the variable VARIABLE before EXPRESSION is called. You must have defined VARIABLE as a variable of the type TYPE before you call IlMapList.

Parameters:

	LIST	The list that is enumerated. This must be a pointer to a list that stores elements of the type TYPE.
	TYPE	The type of the elements of this list.
	VARIABLE	The name of the variable to be set.
	EXPRESSION	The expression that is called for each element. Use the contents of VARIABLE in the expression to get the elements.