IsList< T > Class Template Reference

Generic single linked list.Class IsList implements an intrusive single linked list of elements of a template class T. As an intrusive list, the objects of type T must provide methods next() for setting and inquiring a pointer to the next element in a list. The user is responsible for not modifying the next() pointer of elements currently residing in a list, which may destroy the lists integrity. For this, class IsList provides enough methods for modifying a list in a save way. See the method list for a description. More...

#include <islist.h>

Inheritance diagram for IsList< T >:

Public Types
typedef IsElement< T >	Element

Public Member Functions
Extension
void	append (T *elem)
	appends elem to IsList.
void	prepend (T *elem)
	prepends elem to IsList.
void	insert (T *elem, T *after)
	inserts elem to IsList after its element after.
void	append (IsList< T > &list)
	appends all elements of list to IsList.
void	prepend (IsList< T > &list)
	prepends all elements of list to IsList.
void	insert (IsList< T > &list, T *after)
	inserts all elements of list after element after of an IsList.
Removal
void	remove_next (T *after)
	removes the successor of after from an IsList.
void	remove (const T *elem)
	removes element elem from an IsList.
void	remove (IsList< T > &list)
	removes all elements of list from an IsList.
void	clear ()
	removes all elements from an IsList.
Access
T *	first () const
	returns the IsList's first element.
T *	last () const
	returns the IsList's last element.
T *	next (const T *elem) const
	returns successor of elem in an IsList.
int	length () const
	returns the number of elements in IsList.
int	find (const T *elem) const
	returns the position of element elem within IsList.
IsList< T >	sublist (const T *start=0, const T *end=0) const
	constructs sublist of an IsList.
Miscellaneous
void	move (ptrdiff_t delta)
	adjusts list pointers to a new memory address.
bool	isConsistent () const
	consistency check.
Constructors / Destructors
	IsList (T *pfirst=0, T *plast=0)
	default constructor.

Protected Attributes
T *	the_first
	the first element in the IsList.
T *	the_last
	the last element in the IsList.

Detailed Description

template<class T>
class soplex::IsList< T >

Generic single linked list.

Class IsList implements an intrusive single linked list of elements of a template class T. As an intrusive list, the objects of type T must provide methods next() for setting and inquiring a pointer to the next element in a list. The user is responsible for not modifying the next() pointer of elements currently residing in a list, which may destroy the lists integrity. For this, class IsList provides enough methods for modifying a list in a save way. See the method list for a description.

Definition at line 109 of file islist.h.

Member Typedef Documentation

typedef IsElement<T> Element

Definition at line 116 of file islist.h.

Constructor & Destructor Documentation

IsList ( T *  pfirst = 0, T *  plast = 0  )

explicit

default constructor.

The default constructor may be used to setup a (sub-)list, by specifying a first and last element. Then last must be a successor of first.

Definition at line 416 of file islist.h.

Member Function Documentation

void append

(

T *

elem

)

appends elem to IsList.

Definition at line 122 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::append(), and IsList< soplex::SVSet::DLPSV >::insert().

void append

(

IsList< T > &

list

)

appends all elements of list to IsList.

Appending one list to another keeps the appended list. Instead, list remains an own IsList which is then part of the concatenated list. This means that modifying list will modify the concateneted list as well and vice versa. The programmer is responsible for such changes not to yield inconsistent lists.

Definition at line 161 of file islist.h.

void clear

(

)

removes all elements from an IsList.

Definition at line 278 of file islist.h.

int find

(

const T *

elem

)

const

returns the position of element elem within IsList.

Definition at line 328 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::insert(), IdList< soplex::SVSet::DLPSV >::insert(), IsList< soplex::SVSet::DLPSV >::isConsistent(), IsList< soplex::SVSet::DLPSV >::IsList(), IsList< soplex::SVSet::DLPSV >::remove(), IdList< soplex::SVSet::DLPSV >::remove(), IsList< soplex::SVSet::DLPSV >::remove_next(), and IsList< soplex::SVSet::DLPSV >::sublist().

T* first

(

)

const

returns the IsList's first element.

Definition at line 288 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::insert(), IsList< soplex::SVSet::DLPSV >::isConsistent(), and IsList< soplex::SVSet::DLPSV >::move().

void insert	(	T *	elem,
		T *	after
	)

inserts elem to IsList after its element after.

Definition at line 142 of file islist.h.

void insert	(	IsList< T > &	list,
		T *	after
	)

inserts all elements of list after element after of an IsList.

Inserting one list into another keeps the appended list. Instead, list remains an own IsList which is then part of the concatenated list. This means that modifying list will modify the concateneted list as well and vice versa. The programmer is responsible for such changes not to yield inconsistent lists.

Definition at line 193 of file islist.h.

bool isConsistent

(

)

const

consistency check.

Definition at line 390 of file islist.h.

Referenced by IdList< soplex::SVSet::DLPSV >::isConsistent(), and IsList< soplex::SVSet::DLPSV >::IsList().

T* last

(

)

const

returns the IsList's last element.

Definition at line 294 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::insert(), IsList< soplex::SVSet::DLPSV >::isConsistent(), IsList< soplex::SVSet::DLPSV >::move(), and IsList< soplex::SVSet::DLPSV >::remove_next().

int length

(

)

const

returns the number of elements in IsList.

Definition at line 314 of file islist.h.

void move

(

ptrdiff_t

delta

)

adjusts list pointers to a new memory address.

This method is of a rather technical nature. If all list elements are taken form one array of elements, in certain circumstances the user may be forced to realloc this array. As a consequence all next() pointers of the list elements would become invalid. However, all addresses will be changed by a constant offset delta. Then move( delta ) may be called, which adjusts the next() pointers of all elements in the list.

Definition at line 376 of file islist.h.

Referenced by IdList< soplex::SVSet::DLPSV >::move().

T* next

(

const T *

elem

)

const

returns successor of elem in an IsList.

The successor of elem in a list generally corresponds to the element returned by elem->next(). However, if elem is the last element in an IsList, this method will return 0, whereas elem->next() may yield an arbitrary value. For example, if the current list is actually a sublist of another, larger IsList, elem->next() returns the successor of elem in this larger IsList.

Definition at line 308 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::find(), IsList< soplex::SVSet::DLPSV >::move(), and IsList< soplex::SVSet::DLPSV >::remove().

void prepend

(

T *

elem

)

prepends elem to IsList.

Definition at line 132 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::prepend().

void prepend

(

IsList< T > &

list

)

prepends all elements of list to IsList.

Appending one list to another keeps the appended list. Instead, list remains an own IsList which is then part of the concatenated list. This means that modifying list will modify the concateneted list as well and vice versa. The programmer is responsible for such changes not to yield inconsistent lists.

Definition at line 177 of file islist.h.

void remove

(

const T *

elem

)

removes element elem from an IsList.

Definition at line 222 of file islist.h.

void remove

(

IsList< T > &

list

)

removes all elements of list from an IsList.

Removing list from an IsList requires list to be part of the IsList. Such a situation can be achieved by previously adding (i.e., appending, inserting or prepending) a list or explicitely constructing a sublist with method sublist().

Definition at line 251 of file islist.h.

void remove_next

(

T *

after

)

removes the successor of after from an IsList.

Definition at line 210 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::remove().

IsList<T> sublist	(	const T *	start = 0,
		const T *	end = 0
	)		const

constructs sublist of an IsList.

Returns a new IsList containing a sublist of an IsList starting with element start and reaching up to element end. Both must be members of the IsList or 0, in which case the first and last element are used, respectively.

Definition at line 347 of file islist.h.

Member Data Documentation

T* the_first

protected

the first element in the IsList.

Definition at line 112 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::append(), IdList< soplex::SVSet::DLPSV >::append(), IsList< soplex::SVSet::DLPSV >::clear(), IsList< soplex::SVSet::DLPSV >::find(), IdList< soplex::SVSet::DLPSV >::first(), IsList< soplex::SVSet::DLPSV >::first(), IsList< soplex::SVSet::DLPSV >::insert(), IsList< soplex::SVSet::DLPSV >::length(), IdList< soplex::SVSet::DLPSV >::move(), IsList< soplex::SVSet::DLPSV >::move(), IsList< soplex::SVSet::DLPSV >::prepend(), IdList< soplex::SVSet::DLPSV >::prepend(), IsList< soplex::SVSet::DLPSV >::remove(), IdList< soplex::SVSet::DLPSV >::remove(), and IsList< soplex::SVSet::DLPSV >::sublist().

T* the_last

protected

the last element in the IsList.

Definition at line 113 of file islist.h.

Referenced by IsList< soplex::SVSet::DLPSV >::append(), IdList< soplex::SVSet::DLPSV >::append(), IsList< soplex::SVSet::DLPSV >::clear(), IsList< soplex::SVSet::DLPSV >::insert(), IdList< soplex::SVSet::DLPSV >::insert(), IdList< soplex::SVSet::DLPSV >::last(), IsList< soplex::SVSet::DLPSV >::last(), IsList< soplex::SVSet::DLPSV >::length(), IsList< soplex::SVSet::DLPSV >::move(), IsList< soplex::SVSet::DLPSV >::next(), IsList< soplex::SVSet::DLPSV >::prepend(), IdList< soplex::SVSet::DLPSV >::prepend(), IsList< soplex::SVSet::DLPSV >::remove(), IdList< soplex::SVSet::DLPSV >::remove(), IsList< soplex::SVSet::DLPSV >::remove_next(), and IsList< soplex::SVSet::DLPSV >::sublist().