Set of data objects.Class DataSet manages of sets of data objects of a template type DATA. For constructing a DataSet the maximum number of entries must be given. The current maximum number may be inquired with method max(). More...

#include <dataset.h>

Classes
struct	Item

Public Member Functions
Extension
Whenever a new element is added to a DataSet, the latter assigns it a DataKey. For this all methods that extend a DataSet by one ore more elements are provided with two signatures, one of them having a parameter for returning the assigned DataKey(s).
void	add (DataKey &newkey, const DATA &item)
	adds an element.

void	add (const DATA &item)
	adds element `item`.

void	add (DataKey newkey[], const DATA *item, int n)
	add several items.

void	add (const DATA *items, int n)
	adds `n` elements from `items`.

void	add (DataKey newkey[], const DataSet< DATA > &set)
	adds several new items.

void	add (const DataSet< DATA > &set)
	adds all elements of `set`.

DATA *	create (DataKey &newkey)
	creates new data element in DataSet.

DATA *	create ()
	creates new (uninitialized) data element in DataSet.

Shrinkage
When elements are removed from a DataSet, the remaining ones are renumbered from 0 through the new size()-1. How this renumbering is performed will not be revealed, since it might be target of future changes. However, some methods provide a parameter `int* perm`, which returns the new order after the removal: If `perm[i] < 0`, the element numbered i prior to the removal operation has been removed from the set. Otherwise, `perm[i] = j >= 0` means that the element with number i prior to the removal operation has been renumbered to j. Removing a single element from a DataSet yields a simple renumbering of the elements: The last element in the set (i.e., element num()-1) is moved to the index of the removed element.
void	remove (int removenum)
	removes the `removenum` 'th element.

void	remove (const DataKey &removekey)
	removes element with key `removekey`.

void	remove (int perm[])
	remove multiple elements.

void	remove (const DataKey keys, int n, int perm)
	remove `n` elements given by `keys` and `perm`.

void	remove (const DataKey *keys, int n)
	remove `n` elements given by `keys`.

void	remove (const int nums, int n, int perm)
	remove `n` elements given by `nums` and `perm`.

void	remove (const int *nums, int n)
	remove `n` elements with numbers `nums`.

void	clear ()
	remove all elements.

Access
When accessing elements from a DataSet with one of the index operators, it must be ensured that the index is valid for the DataSet. If this is not known afore, it is the programmers responsability to ensure this using the inquiry methods below.
DATA &	operator[] (int n)

const DATA &	operator[] (int n) const
	returns element number `n`.

DATA &	operator[] (const DataKey &k)

const DATA &	operator[] (const DataKey &k) const
	returns element with DataKey `k`.

Inquiry
int	max () const
	returns maximum number of elements that would fit into DataSet.

int	num () const
	returns number of elements currently in DataSet.

int	size () const
	returns the maximum DataKey::idx currently in DataSet.

DataKey	key (int n) const
	returns DataKey of `n` 'th element in DataSet.

DataKey	key (const DATA *item) const
	returns DataKey of element `item` in DataSet.

int	number (const DataKey &k) const
	returns the number of the element with DataKey `k` in DataSet or -1, if it doesn't exist.

int	number (const DATA *item) const
	returns the number of element `item` in DataSet or -1, if it doesn't exist.

bool	has (const DataKey &k) const
	Is `k` a valid DataKey of an element in DataSet?

bool	has (int n) const
	Is `n` a valid number of an element in DataSet?

bool	has (const DATA *item) const
	Does `item` belong to DataSet?

Miscellaneous
ptrdiff_t	reMax (int newmax=0)
	resets max() to `newmax`.

bool	isConsistent () const
	consistency check.

Constructors / Destructors
	DataSet (int pmax=8)
	default constructor.

	DataSet (const DataSet &old)
	copy constructor.

DataSet< DATA > &	operator= (const DataSet< DATA > &rhs)
	assignment operator.

	~DataSet ()
	destructor.

Protected Attributes
Types
struct soplex::DataSet::Item *	theitem
	array of elements in the DataSet

Data
DataKey *	thekey
	DataKey::idx's of elements.

int	themax
	length of arrays theitem and thekey

int	thesize
	highest used element in theitem

int	thenum
	number of elements in DataSet

int	firstfree
	first unused element in theitem

Detailed Description

template<class DATA>
class soplex::DataSet< DATA >

Set of data objects.

Class DataSet manages of sets of data objects of a template type DATA. For constructing a DataSet the maximum number of entries must be given. The current maximum number may be inquired with method max().

Adding more then max() elements to a DataSet will core dump. However, method reMax() allows to reset max() without loss of elements currently in the DataSet. The current number of elements in a DataSet is returned by method num().

Adding elements to a DataSet is done via methods add() or create(), while remove() removes elements from a DataSet. When adding an element to a DataSet the new element is assigned a DataKey. DataKeys serve to access DATA elements in a set via a version of the subscript operator[](DataKey).

For convenience all elements in a DataSet are implicitely numbered from 0 through num()-1 and can be accessed with these numbers using a 2nd subscript operator[](int). The reason for providing DataKeys to access elements of a DataSet is that the Key of an element remains unchanged as long as the element is a member of the DataSet, while the numbers will change in an undefined way, if other elements are added to or removed from the DataSet.

The elements in a DataSet and their DataKeys are stored in two arrays:

theitem keeps the elements data along with their number stored in item.
thekey keeps the DataKey::idx's of the elements in a DataSet.

Both arrays have size themax.

In thekey only elements 0 thru thenum-1 contain DataKey::idx's of valid elements, i.e., elements currently in the DataSet. The current number of elements in the DataSet is counted in thenum.

In theitem only elements 0 thru thesize-1 are used, but only some of them actually contain real data elements of the DataSet. They are recognized by having info >= 0, which gives the number of that element. Otherwise info < 0 indicates an unused element. Unused elements are linked in a single linked list: starting with element -firstfree-1, the next free element is given by -info-1. The last free element in the list is marked by info == -themax-1. Finally all elements in theitem with index >= thesize are unused as well.

Warning: malloc/realloc and memcpy are used to handle the members of the set. If you use DataSet with something that is not a Data Object you will be in severe trouble.

Definition at line 86 of file dataset.h.

Constructor & Destructor Documentation

DataSet ( int pmax = 8 )

explicit

default constructor.

Definition at line 519 of file dataset.h.

DataSet ( const DataSet< DATA > & old )

copy constructor.

Definition at line 545 of file dataset.h.

~DataSet ( )

destructor.

Definition at line 616 of file dataset.h.

Member Function Documentation

void add	(	DataKey &	newkey,
		const DATA &	item
	)

adds an element.

Definition at line 123 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::add().

void add ( const DATA & item )

adds element item.

Returns: 0 on success and non-zero, if an error occured.

Definition at line 134 of file dataset.h.

void add	(	DataKey	newkey[],
		const DATA *	item,
		int	n
	)

add several items.

Definition at line 144 of file dataset.h.

void add	(	const DATA *	items,
		int	n
	)

adds n elements from items.

Definition at line 154 of file dataset.h.

void add	(	DataKey	newkey[],
		const DataSet< DATA > &	set
	)

adds several new items.

Definition at line 164 of file dataset.h.

void add ( const DataSet< DATA > & set )

adds all elements of set.

Definition at line 173 of file dataset.h.

void clear ( )

remove all elements.

Definition at line 331 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::operator=().

DATA* create ( DataKey & newkey )

creates new data element in DataSet.

Returns: Pointer to the newly created element.

Definition at line 184 of file dataset.h.

DATA* create ( )

creates new (uninitialized) data element in DataSet.

Returns: Pointer to the newly created element.

Definition at line 205 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::add(), and DataSet< soplex::SVSet::DLPSV >::create().

bool has ( const DataKey & k ) const

Is k a valid DataKey of an element in DataSet?

Definition at line 442 of file dataset.h.

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

bool has ( int n ) const

Is n a valid number of an element in DataSet?

Definition at line 448 of file dataset.h.

bool has ( const DATA * item ) const

Does item belong to DataSet?

Definition at line 454 of file dataset.h.

bool isConsistent ( ) const

consistency check.

Definition at line 490 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::DataSet(), and DataSet< soplex::SVSet::DLPSV >::operator=().

DataKey key ( int n ) const

returns DataKey of n 'th element in DataSet.

Definition at line 396 of file dataset.h.

DataKey key ( const DATA * item ) const

returns DataKey of element item in DataSet.

Definition at line 403 of file dataset.h.

int max ( ) const

returns maximum number of elements that would fit into DataSet.

Definition at line 378 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::add(), DataSet< soplex::SVSet::DLPSV >::create(), and DataSet< soplex::SVSet::DLPSV >::operator=().

int num ( ) const

returns number of elements currently in DataSet.

Definition at line 384 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::add(), DataSet< soplex::SVSet::DLPSV >::create(), DataSet< soplex::SVSet::DLPSV >::has(), DataSet< soplex::SVSet::DLPSV >::key(), DataSet< soplex::SVSet::DLPSV >::operator=(), and DataSet< soplex::SVSet::DLPSV >::remove().

int number ( const DataKey & k ) const

returns the number of the element with DataKey k in DataSet or -1, if it doesn't exist.

Definition at line 411 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::has(), DataSet< soplex::SVSet::DLPSV >::key(), and DataSet< soplex::SVSet::DLPSV >::remove().

int number ( const DATA * item ) const

returns the number of element item in DataSet or -1, if it doesn't exist.

Todo:: Please check whether this is correctly implemented!

Definition at line 420 of file dataset.h.

DataSet< DATA >& operator= ( const DataSet< DATA > & rhs )

assignment operator.

The assignment operator involves reMax()ing the lvalue DataSet to the size needed for copying all elements of the rvalue. After the assignment all DataKeys from the lvalue are valid for the rvalue as well. They refer to a copy of the corresponding data elements.

Definition at line 579 of file dataset.h.

DATA& operator[] ( int n )

Definition at line 348 of file dataset.h.

const DATA& operator[] ( int n ) const

returns element number n.

Definition at line 354 of file dataset.h.

DATA& operator[] ( const DataKey & k )

Definition at line 361 of file dataset.h.

const DATA& operator[] ( const DataKey & k ) const

returns element with DataKey k.

Definition at line 367 of file dataset.h.

ptrdiff_t reMax ( int newmax = 0 )

resets max() to newmax.

This method will not succeed if newmax < size(), in which case newmax == size() will be taken. As generally this method involves copying the DataSets elements in memory, reMax() returns the number of bytes the addresses of elements in the DataSet have been moved. Note, that this is identical for all elements in the DataSet.

Definition at line 471 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::operator=().

void remove ( int removenum )

removes the removenum 'th element.

Definition at line 229 of file dataset.h.

void remove ( const DataKey & removekey )

removes element with key removekey.

Definition at line 254 of file dataset.h.

void remove ( int perm[] )

remove multiple elements.

This method removes all elements for the DataSet with an index i such that perm[i] < 0. Upon completion, perm contains the new numbering of elements.

Definition at line 264 of file dataset.h.

void remove	(	const DataKey *	keys,
		int	n,
		int *	perm
	)

remove n elements given by keys and perm.

Definition at line 298 of file dataset.h.

void remove	(	const DataKey *	keys,
		int	n
	)

remove n elements given by keys.

Definition at line 308 of file dataset.h.

void remove	(	const int *	nums,
		int	n,
		int *	perm
	)

remove n elements given by nums and perm.

Definition at line 314 of file dataset.h.

void remove	(	const int *	nums,
		int	n
	)

remove n elements with numbers nums.

Definition at line 324 of file dataset.h.

int size ( ) const

returns the maximum DataKey::idx currently in DataSet.

Definition at line 390 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::number(), DataSet< soplex::SVSet::DLPSV >::operator=(), and DataSet< soplex::SVSet::DLPSV >::reMax().

Member Data Documentation

int firstfree

protected

first unused element in theitem

Definition at line 109 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::clear(), DataSet< soplex::SVSet::DLPSV >::create(), DataSet< soplex::SVSet::DLPSV >::DataSet(), DataSet< soplex::SVSet::DLPSV >::isConsistent(), DataSet< soplex::SVSet::DLPSV >::operator=(), DataSet< soplex::SVSet::DLPSV >::reMax(), and DataSet< soplex::SVSet::DLPSV >::remove().

struct soplex::DataSet::Item* theitem

protected

array of elements in the DataSet

Referenced by DataSet< soplex::SVSet::DLPSV >::create(), DataSet< soplex::SVSet::DLPSV >::DataSet(), DataSet< soplex::SVSet::DLPSV >::has(), DataSet< soplex::SVSet::DLPSV >::isConsistent(), DataSet< soplex::SVSet::DLPSV >::number(), DataSet< soplex::SVSet::DLPSV >::operator=(), DataSet< soplex::SVSet::DLPSV >::operator[](), DataSet< soplex::SVSet::DLPSV >::reMax(), DataSet< soplex::SVSet::DLPSV >::remove(), and DataSet< soplex::SVSet::DLPSV >::~DataSet().

DataKey* thekey

protected

DataKey::idx's of elements.

Definition at line 105 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::create(), DataSet< soplex::SVSet::DLPSV >::DataSet(), DataSet< soplex::SVSet::DLPSV >::isConsistent(), DataSet< soplex::SVSet::DLPSV >::key(), DataSet< soplex::SVSet::DLPSV >::operator=(), DataSet< soplex::SVSet::DLPSV >::operator[](), DataSet< soplex::SVSet::DLPSV >::reMax(), DataSet< soplex::SVSet::DLPSV >::remove(), and DataSet< soplex::SVSet::DLPSV >::~DataSet().

int themax

protected

length of arrays theitem and thekey

Definition at line 106 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::clear(), DataSet< soplex::SVSet::DLPSV >::create(), DataSet< soplex::SVSet::DLPSV >::DataSet(), DataSet< soplex::SVSet::DLPSV >::isConsistent(), DataSet< soplex::SVSet::DLPSV >::max(), DataSet< soplex::SVSet::DLPSV >::operator=(), and DataSet< soplex::SVSet::DLPSV >::reMax().

int thenum

protected

number of elements in DataSet

Definition at line 108 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::clear(), DataSet< soplex::SVSet::DLPSV >::create(), DataSet< soplex::SVSet::DLPSV >::isConsistent(), DataSet< soplex::SVSet::DLPSV >::num(), DataSet< soplex::SVSet::DLPSV >::operator=(), DataSet< soplex::SVSet::DLPSV >::operator[](), and DataSet< soplex::SVSet::DLPSV >::remove().

int thesize

protected

highest used element in theitem

Definition at line 107 of file dataset.h.

Referenced by DataSet< soplex::SVSet::DLPSV >::clear(), DataSet< soplex::SVSet::DLPSV >::create(), DataSet< soplex::SVSet::DLPSV >::isConsistent(), DataSet< soplex::SVSet::DLPSV >::operator=(), DataSet< soplex::SVSet::DLPSV >::operator[](), DataSet< soplex::SVSet::DLPSV >::remove(), and DataSet< soplex::SVSet::DLPSV >::size().

Classes

Public Member Functions

Protected Attributes

Detailed Description

template<class DATA> class soplex::DataSet< DATA >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class DATA>
class soplex::DataSet< DATA >