DataKey Class Reference

Entry identifier class for items of a DataSet.Every item in a DataSet is assigned a DataKey by which it can be accessed (using DataSet::operator[]()). A DataKey consists of an integer member idx, which is a positive number for any valid DataKey. No idx of an element in a DataSet may exceed the sets max(). This property may be used to build arrays with additional information to the elements of a DataSet. More...

#include <datakey.h>

Inheritance diagram for DataKey:

Public Member Functions
Constructors / destructors
	DataKey ()
	Default constructor. Constructs an invalid DataKey. More...
	DataKey (int p_info, int p_idx)
DataKey &	operator= (const DataKey &rhs)
	Assignment operator. More...
	DataKey (const DataKey &old)
	Copy constructor. More...
Access / modification
int	getIdx () const
	gets the index number (idx) of the DataKey. More...
void	setIdx (int p_idx)
	sets the index number (idx) of the DataKey. More...
bool	isValid () const
	returns TRUE, iff the DataKey is valid. More...
void	inValidate ()
	makes the DataKey invalid and clears the info field. More...

Public Attributes
Data
int	info
	user information to store values -1, 0, +1 More...
int	idx
	(locally) unique key index More...

Detailed Description

Entry identifier class for items of a DataSet.

Every item in a DataSet is assigned a DataKey by which it can be accessed (using DataSet::operator[]()). A DataKey consists of an integer member idx, which is a positive number for any valid DataKey. No idx of an element in a DataSet may exceed the sets max(). This property may be used to build arrays with additional information to the elements of a DataSet.

In addition, DataKeys provide a member info which can be used to store further information.

Each DataKey is unique for one DataSet but different DataSets may (and generally will) manage the same DataKeys. When an element is removed from a DataSet its DataKey may (and generally will) be reused for other elements added to the DataSet later on.

Todo:

data members should be private.

Definition at line 46 of file datakey.h.

Constructor & Destructor Documentation

DataKey

(

)

Default constructor. Constructs an invalid DataKey.

Definition at line 65 of file datakey.h.

DataKey	(	int	p_info,
		int	p_idx
	)

Definition at line 69 of file datakey.h.

DataKey

(

const DataKey &

old

)

Copy constructor.

Definition at line 86 of file datakey.h.

Member Function Documentation

int getIdx

(

)

const

gets the index number (idx) of the DataKey.

Definition at line 96 of file datakey.h.

References DataKey::idx.

Referenced by SPxId::operator<().

void inValidate

(

)

makes the DataKey invalid and clears the info field.

Definition at line 111 of file datakey.h.

bool isValid

(

)

const

returns TRUE, iff the DataKey is valid.

Definition at line 106 of file datakey.h.

DataKey& operator=

(

const DataKey &

rhs

)

Assignment operator.

Definition at line 76 of file datakey.h.

References DataKey::idx, and DataKey::info.

Referenced by SPxId::operator=().

void setIdx

(

int

p_idx

)

sets the index number (idx) of the DataKey.

Definition at line 101 of file datakey.h.

Member Data Documentation

int idx

(locally) unique key index

Definition at line 56 of file datakey.h.

Referenced by DataSet< soplex::SVSetBase::DLPSV >::create(), DataKey::getIdx(), DataSet< soplex::SVSetBase::DLPSV >::has(), DataSet< soplex::SVSetBase::DLPSV >::number(), soplex::operator<<(), DataKey::operator=(), DataSet< soplex::SVSetBase::DLPSV >::operator[](), and DataSet< soplex::SVSetBase::DLPSV >::remove().

int info

user information to store values -1, 0, +1

Definition at line 55 of file datakey.h.

Referenced by SPxId::inValidate(), SPxId::isSPxColId(), SPxId::isSPxRowId(), SPxId::isValid(), soplex::operator<<(), DataKey::operator=(), SPxId::operator=(), SPxColId::SPxColId(), SPxRowId::SPxRowId(), and SPxId::type().