Set of class objects. More...

#include <classset.h>

Classes
struct	Item

Public Member Functions
Extension
Whenever a new element is added to a ClassSet, the latter assigns it a DataKey. For this all methods that extend a ClassSet 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 T &item)
	adds an element. More...

void	add (const T &item)
	adds element `item`. More...

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

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

void	add (DataKey newkey[], const ClassSet< T > &set)
	adds several new items. More...

void	add (const ClassSet< T > &set)
	adds all elements of `set`. More...

T *	create (DataKey &newkey)
	creates new class element in ClassSet. More...

T *	create ()
	creates new (uninitialized) class element in ClassSet. More...

Shrinkage
When elements are removed from a ClassSet, 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 ClassSet 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. More...

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

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

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

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

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

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

void	clear ()
	remove all elements. More...

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

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

T &	operator[] (const DataKey &k)

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

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

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

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

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

DataKey	key (const T *item) const
	returns DataKey of element `item` in ClassSet. More...

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

int	number (const T *item) const
	returns the number of element `item` in ClassSet, throws exception if it doesn't exist. More...

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

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

bool	has (const T *item) const
	Does `item` belong to ClassSet? More...

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

bool	isConsistent () const
	consistency check. More...

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

	ClassSet (const ClassSet &old)
	copy constructor. More...

ClassSet< T > &	operator= (const ClassSet< T > &rhs)
	assignment operator. More...

	~ClassSet ()
	destructor. More...

Protected Attributes
Types
struct soplex::ClassSet::Item *	theitem
	array of elements in the ClassSet More...

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

int	themax
	length of arrays theitem and thekey More...

int	thesize
	highest used element in theitem More...

int	thenum
	number of elements in ClassSet More...

int	firstfree
	first unused element in theitem More...

Detailed Description

template<class T>
class soplex::ClassSet< T >

Set of class objects.

Class ClassSet manages of sets of class objects of a template type T. For constructing a ClassSet 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 ClassSet will core dump. However, method reMax() allows to reset max() without loss of elements currently in the ClassSet. The current number of elements in a ClassSet is returned by method num().

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

For convenience all elements in a ClassSet 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 ClassSet is that the Key of an element remains unchanged as long as the element is a member of the ClassSet, while the numbers will change in an undefined way, if other elements are added to or removed from the ClassSet.

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

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

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 ClassSet. The current number of elements in the ClassSet is counted in thenum.

In theitem only elements 0 thru thesize-1 are used, but only some of them actually contain real class elements of the ClassSet. 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.

Definition at line 94 of file classset.h.

Constructor & Destructor Documentation

◆ ClassSet() [1/2]

ClassSet ( int pmax = 8 )

explicit

default constructor.

Definition at line 560 of file classset.h.

References ClassSet< T >::firstfree, ClassSet< T >::isConsistent(), soplex::spx_alloc(), soplex::spx_free(), ClassSet< T >::theitem, ClassSet< T >::thekey, and ClassSet< T >::themax.

◆ ClassSet() [2/2]

ClassSet ( const ClassSet< T > & old )

copy constructor.

Definition at line 590 of file classset.h.

References ClassSet< T >::firstfree, ClassSet< T >::isConsistent(), soplex::spx_alloc(), soplex::spx_free(), ClassSet< T >::theitem, ClassSet< T >::thekey, ClassSet< T >::themax, and ClassSet< T >::thenum.

◆ ~ClassSet()

~ClassSet ( )

destructor.

Definition at line 674 of file classset.h.

References soplex::spx_free(), ClassSet< T >::theitem, and ClassSet< T >::thekey.

Member Function Documentation

◆ add() [1/6]

void add ( const ClassSet< T > & set )

adds all elements of set.

Definition at line 179 of file classset.h.

References ClassSet< T >::add(), ClassSet< T >::max(), and ClassSet< T >::num().

◆ add() [2/6]

void add ( const T & item )

adds element item.

Definition at line 140 of file classset.h.

References ClassSet< T >::create().

◆ add() [3/6]

void add	(	const T *	items,
		int	n
	)

adds n elements from items.

Definition at line 160 of file classset.h.

References ClassSet< T >::add(), ClassSet< T >::max(), and ClassSet< T >::num().

◆ add() [4/6]

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

adds an element.

Definition at line 131 of file classset.h.

References ClassSet< T >::create().

Referenced by ClassSet< T >::add().

◆ add() [5/6]

void add	(	DataKey	newkey[],
		const ClassSet< T > &	set
	)

adds several new items.

Definition at line 170 of file classset.h.

References ClassSet< T >::add(), ClassSet< T >::max(), and ClassSet< T >::num().

◆ add() [6/6]

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

add several items.

Definition at line 150 of file classset.h.

References ClassSet< T >::add(), ClassSet< T >::max(), and ClassSet< T >::num().

◆ clear()

void clear ( )

remove all elements.

Definition at line 347 of file classset.h.

References ClassSet< T >::firstfree, ClassSet< T >::themax, ClassSet< T >::thenum, and ClassSet< T >::thesize.

Referenced by ClassSet< T >::operator=().

◆ create() [1/2]

T * create ( )

creates new (uninitialized) class element in ClassSet.

Returns: Pointer to the newly created element.

Definition at line 211 of file classset.h.

References ClassSet< T >::create().

Referenced by ClassSet< T >::add(), and ClassSet< T >::create().

◆ create() [2/2]

T * create ( DataKey & newkey )

creates new class element in ClassSet.

Returns: Pointer to the newly created element.

Definition at line 190 of file classset.h.

References ClassSet< T >::Item::data, ClassSet< T >::firstfree, DataKey::idx, ClassSet< T >::Item::info, ClassSet< T >::max(), ClassSet< T >::num(), ClassSet< T >::theitem, ClassSet< T >::thekey, ClassSet< T >::themax, ClassSet< T >::thenum, and ClassSet< T >::thesize.

◆ has() [1/3]

bool has ( const DataKey & k ) const

Is k a valid DataKey of an element in ClassSet?

Definition at line 449 of file classset.h.

References DataKey::idx, ClassSet< T >::Item::info, and ClassSet< T >::theitem.

Referenced by ClassSet< T >::remove().

◆ has() [2/3]

bool has ( const T * item ) const

Does item belong to ClassSet?

Definition at line 461 of file classset.h.

References ClassSet< T >::number().

◆ has() [3/3]

bool has ( int n ) const

Is n a valid number of an element in ClassSet?

Definition at line 455 of file classset.h.

References ClassSet< T >::num().

◆ isConsistent()

bool isConsistent ( ) const

consistency check.

Definition at line 529 of file classset.h.

References ClassSet< T >::firstfree, SPX_MSG_INCONSISTENT, ClassSet< T >::theitem, ClassSet< T >::thekey, ClassSet< T >::themax, ClassSet< T >::thenum, and ClassSet< T >::thesize.

Referenced by ClassSet< T >::ClassSet(), and ClassSet< T >::operator=().

◆ key() [1/2]

DataKey key ( const T * item ) const

returns DataKey of element item in ClassSet.

Definition at line 419 of file classset.h.

References ClassSet< T >::number(), and ClassSet< T >::thekey.

◆ key() [2/2]

DataKey key ( int n ) const

returns DataKey of n 'th element in ClassSet.

Definition at line 412 of file classset.h.

References ClassSet< T >::num(), and ClassSet< T >::thekey.

◆ max()

int max ( ) const

returns maximum number of elements that would fit into ClassSet.

Definition at line 394 of file classset.h.

References ClassSet< T >::themax.

Referenced by ClassSet< T >::add(), ClassSet< T >::create(), ClassSet< T >::operator=(), and ClassSet< T >::reMax().

◆ num()

int num ( ) const

returns number of elements currently in ClassSet.

Definition at line 400 of file classset.h.

References ClassSet< T >::thenum.

Referenced by ClassSet< T >::add(), ClassSet< T >::create(), ClassSet< T >::has(), ClassSet< T >::key(), ClassSet< T >::operator=(), and ClassSet< T >::remove().

◆ number() [1/2]

int number ( const DataKey & k ) const

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

Definition at line 427 of file classset.h.

References DataKey::idx, ClassSet< T >::Item::info, ClassSet< T >::size(), and ClassSet< T >::theitem.

Referenced by ClassSet< T >::has(), ClassSet< T >::key(), and ClassSet< T >::remove().

◆ number() [2/2]

int number ( const T * item ) const

returns the number of element item in ClassSet, throws exception if it doesn't exist.

Todo:: Please check whether this is correctly implemented!

Definition at line 438 of file classset.h.

References ClassSet< T >::Item::info, ClassSet< T >::size(), and ClassSet< T >::theitem.

◆ operator=()

ClassSet< T > & operator= ( const ClassSet< T > & rhs )

assignment operator.

The assignment operator involves reMax()ing the lvalue ClassSet 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 class elements.

Definition at line 634 of file classset.h.

References ClassSet< T >::clear(), ClassSet< T >::firstfree, ClassSet< T >::Item::info, ClassSet< T >::isConsistent(), ClassSet< T >::max(), ClassSet< T >::num(), ClassSet< T >::reMax(), ClassSet< T >::size(), ClassSet< T >::theitem, ClassSet< T >::thekey, ClassSet< T >::themax, ClassSet< T >::thenum, and ClassSet< T >::thesize.

◆ operator[]() [1/4]

T & operator[] ( const DataKey & k )

Definition at line 377 of file classset.h.

References ClassSet< T >::Item::data, DataKey::idx, ClassSet< T >::theitem, and ClassSet< T >::thesize.

◆ operator[]() [2/4]

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

returns element with DataKey k.

Definition at line 383 of file classset.h.

References ClassSet< T >::Item::data, DataKey::idx, ClassSet< T >::theitem, and ClassSet< T >::thesize.

◆ operator[]() [3/4]

T & operator[] ( int n )

Definition at line 364 of file classset.h.

References ClassSet< T >::Item::data, DataKey::idx, ClassSet< T >::theitem, ClassSet< T >::thekey, and ClassSet< T >::thenum.

◆ operator[]() [4/4]

const T & operator[] ( int n ) const

returns element number n.

Definition at line 370 of file classset.h.

References ClassSet< T >::Item::data, DataKey::idx, ClassSet< T >::theitem, ClassSet< T >::thekey, and ClassSet< T >::thenum.

◆ reMax()

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 ClassSets elements in memory, reMax() returns the number of bytes the addresses of elements in the ClassSet have been moved. Note, that this is identical for all elements in the ClassSet.

Definition at line 489 of file classset.h.

References ClassSet< T >::Item::data, ClassSet< T >::firstfree, ClassSet< T >::Item::info, ClassSet< T >::max(), ClassSet< T >::size(), soplex::spx_alloc(), soplex::spx_free(), soplex::spx_realloc(), ClassSet< T >::theitem, ClassSet< T >::thekey, and ClassSet< T >::themax.

Referenced by ClassSet< T >::operator=().

◆ remove() [1/7]

void remove ( const DataKey & removekey )

removes element with key removekey.

Definition at line 261 of file classset.h.

References ClassSet< T >::number(), and ClassSet< T >::remove().

◆ remove() [2/7]

void remove	(	const DataKey *	keys,
		int	n
	)

remove n elements given by keys.

Definition at line 321 of file classset.h.

References DataArray< T >::get_ptr(), ClassSet< T >::num(), and ClassSet< T >::remove().

◆ remove() [3/7]

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

remove n elements given by keys and perm.

Definition at line 308 of file classset.h.

References ClassSet< T >::num(), ClassSet< T >::number(), and ClassSet< T >::remove().

◆ remove() [4/7]

void remove	(	const int *	nums,
		int	n
	)

remove n elements with numbers nums.

Definition at line 340 of file classset.h.

References DataArray< T >::get_ptr(), ClassSet< T >::num(), and ClassSet< T >::remove().

◆ remove() [5/7]

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

remove n elements given by nums and perm.

Definition at line 327 of file classset.h.

References ClassSet< T >::num(), and ClassSet< T >::remove().

◆ remove() [6/7]

void remove ( int perm[] )

remove multiple elements.

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

Definition at line 271 of file classset.h.

References ClassSet< T >::firstfree, DataKey::idx, ClassSet< T >::Item::info, ClassSet< T >::num(), ClassSet< T >::theitem, ClassSet< T >::thekey, and ClassSet< T >::thenum.

◆ remove() [7/7]

void remove ( int removenum )

removes the removenum 'th element.

Definition at line 235 of file classset.h.

References ClassSet< T >::firstfree, ClassSet< T >::has(), DataKey::idx, ClassSet< T >::Item::info, ClassSet< T >::theitem, ClassSet< T >::thekey, ClassSet< T >::thenum, and ClassSet< T >::thesize.

Referenced by ClassSet< T >::remove().

◆ size()

int size ( ) const

returns the maximum DataKey::idx currently in ClassSet.

Definition at line 406 of file classset.h.

References ClassSet< T >::thesize.

Referenced by ClassSet< T >::number(), ClassSet< T >::operator=(), and ClassSet< T >::reMax().

Member Data Documentation

◆ firstfree

int firstfree

protected

first unused element in theitem

Definition at line 117 of file classset.h.

Referenced by ClassSet< T >::ClassSet(), ClassSet< T >::clear(), ClassSet< T >::create(), ClassSet< T >::isConsistent(), ClassSet< T >::operator=(), ClassSet< T >::reMax(), and ClassSet< T >::remove().

◆ theitem

struct soplex::ClassSet::Item* theitem

protected

array of elements in the ClassSet

Referenced by ClassSet< T >::ClassSet(), ClassSet< T >::create(), ClassSet< T >::has(), ClassSet< T >::isConsistent(), ClassSet< T >::number(), ClassSet< T >::operator=(), ClassSet< T >::operator[](), ClassSet< T >::reMax(), ClassSet< T >::remove(), and ClassSet< T >::~ClassSet().

◆ thekey

DataKey* thekey

protected

DataKey::idx's of elements.

Definition at line 113 of file classset.h.

Referenced by ClassSet< T >::ClassSet(), ClassSet< T >::create(), ClassSet< T >::isConsistent(), ClassSet< T >::key(), ClassSet< T >::operator=(), ClassSet< T >::operator[](), ClassSet< T >::reMax(), ClassSet< T >::remove(), and ClassSet< T >::~ClassSet().

◆ themax

int themax

protected

length of arrays theitem and thekey

Definition at line 114 of file classset.h.

Referenced by ClassSet< T >::ClassSet(), ClassSet< T >::clear(), ClassSet< T >::create(), ClassSet< T >::isConsistent(), ClassSet< T >::max(), ClassSet< T >::operator=(), and ClassSet< T >::reMax().

◆ thenum

int thenum

protected

number of elements in ClassSet

Definition at line 116 of file classset.h.

Referenced by ClassSet< T >::ClassSet(), ClassSet< T >::clear(), ClassSet< T >::create(), ClassSet< T >::isConsistent(), ClassSet< T >::num(), ClassSet< T >::operator=(), ClassSet< T >::operator[](), and ClassSet< T >::remove().

◆ thesize

int thesize

protected

highest used element in theitem

Definition at line 115 of file classset.h.

Referenced by ClassSet< T >::clear(), ClassSet< T >::create(), ClassSet< T >::isConsistent(), ClassSet< T >::operator=(), ClassSet< T >::operator[](), ClassSet< T >::remove(), and ClassSet< T >::size().

SoPlex

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ClassSet() [1/2]

◆ ClassSet() [2/2]

◆ ~ClassSet()

Member Function Documentation

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ clear()

◆ create() [1/2]

◆ create() [2/2]

◆ has() [1/3]

◆ has() [2/3]

◆ has() [3/3]

◆ isConsistent()

◆ key() [1/2]

◆ key() [2/2]

◆ max()

◆ num()

◆ number() [1/2]

◆ number() [2/2]

◆ operator=()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ reMax()

◆ remove() [1/7]

◆ remove() [2/7]

◆ remove() [3/7]

◆ remove() [4/7]

◆ remove() [5/7]

◆ remove() [6/7]

◆ remove() [7/7]

◆ size()

Member Data Documentation

◆ firstfree

◆ theitem

◆ thekey

◆ themax

◆ thenum

◆ thesize