BasisStatus Class Reference

a data structure to represent an LP basis on both input and output More...

#include <OSGeneral.h>

Collaboration diagram for BasisStatus:


Public Member Functions
	BasisStatus ()
	~BasisStatus ()
bool	IsEqual (BasisStatus *that)
	A function to check for the equality of two objects.
bool	setRandom (double density, bool conformant, int iMin, int iMax)
	A function to make a random instance of this class.
bool	setIntVector (int status, int *i, int ni)
	Set the indices for a particular status.
bool	addIdx (int status, int idx)
	Add one index to a particular status.
int	getNumberOfEl (int status)
	Get the number of indices for a particular status.
int	getEl (int status, int j)
	Get one entry in the array of indices for a particular status.
bool	getIntVector (int status, int *i)
	Get the entire array of indices for a particular status.
Public Attributes
IntVector *	basic
IntVector *	atLower
IntVector *	atUpper
IntVector *	isFree
IntVector *	superbasic
IntVector *	unknown

Detailed Description

a data structure to represent an LP basis on both input and output

Definition at line 571 of file OSGeneral.h.

Constructor & Destructor Documentation

BasisStatus::BasisStatus ( )

Definition at line 649 of file OSGeneral.cpp.

BasisStatus::~BasisStatus ( )

Definition at line 663 of file OSGeneral.cpp.

References atLower, atUpper, basic, isFree, superbasic, and unknown.

Member Function Documentation

bool BasisStatus::IsEqual ( BasisStatus * that )

A function to check for the equality of two objects.

Definition at line 911 of file OSGeneral.cpp.

References atLower, atUpper, basic, isFree, superbasic, and unknown.

bool BasisStatus::setRandom	(	double	density,
		bool	conformant,
		int	iMin,
		int	iMax
	)

A function to make a random instance of this class.

Parameters:

	density,:	corresponds to the probability that a particular child element is created
	conformant,:	if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
	iMin,:	lowest index value (inclusive) that an entry in this basis can take
	iMax,:	greatest index value (inclusive) that an entry in this basis can take

Definition at line 949 of file OSGeneral.cpp.

References atLower, atUpper, basic, isFree, OSRand(), IntVector::setRandom(), superbasic, and unknown.

Referenced by ConstraintOption::setRandom(), ObjectiveOption::setRandom(), and VariableOption::setRandom().

bool BasisStatus::setIntVector	(	int	status,
		int *	i,
		int	ni
	)

Set the indices for a particular status.

Parameters:

	status	is a string representing the allowed statuses (as defined in enumeration ENUM_BASIS_STATUS - see below)
	i	contains the array of indices
	ni	contains the number of elements in i

Definition at line 701 of file OSGeneral.cpp.

References atLower, atUpper, basic, ENUM_BASIS_STATUS_atLower, ENUM_BASIS_STATUS_atUpper, ENUM_BASIS_STATUS_basic, ENUM_BASIS_STATUS_isFree, ENUM_BASIS_STATUS_superbasic, ENUM_BASIS_STATUS_unknown, isFree, IntVector::setIntVector(), superbasic, and unknown.

Referenced by OSResult::setBasisStatus(), and OSOption::setInitBasisStatus().

bool BasisStatus::addIdx	(	int	status,
		int	idx
	)

Add one index to a particular status.

Parameters:

	status	is a string representing the allowed statuses (as defined in enumeration ENUM_BASIS_STATUS - see below)
	idx	contains the value of the index

Definition at line 746 of file OSGeneral.cpp.

References atLower, atUpper, basic, ENUM_BASIS_STATUS_atLower, ENUM_BASIS_STATUS_atUpper, ENUM_BASIS_STATUS_basic, ENUM_BASIS_STATUS_isFree, ENUM_BASIS_STATUS_superbasic, ENUM_BASIS_STATUS_unknown, IntVector::extendIntVector(), isFree, superbasic, and unknown.

Referenced by OSOption::setAnotherInitBasisStatus().

int BasisStatus::getNumberOfEl ( int status )

Get the number of indices for a particular status.

Parameters:

status

is a string representing the allowed statuses (at present "basic", "atLower", "atUpper", "isFree", "superbasic", "unknown")

Returns:: the number of indices or -1 if the object does not exist

Definition at line 826 of file OSGeneral.cpp.

Referenced by OSResult::getBasisStatusNumberOfEl(), and OSOption::getNumberOfInitialBasisElements().

int BasisStatus::getEl	(	int	status,
		int	j
	)

Get one entry in the array of indices for a particular status.

Parameters:

	status	is an integer representing the allowed statuses (as governed by enumeration ENUM_BASIS_STATUS --- see below)
	j	is the (zero-based) position of the entry within the array

Returns:: the value

Definition at line 866 of file OSGeneral.cpp.

References atLower, atUpper, basic, IntVector::el, ENUM_BASIS_STATUS_atLower, ENUM_BASIS_STATUS_atUpper, ENUM_BASIS_STATUS_basic, ENUM_BASIS_STATUS_isFree, ENUM_BASIS_STATUS_superbasic, ENUM_BASIS_STATUS_unknown, isFree, superbasic, and unknown.

Referenced by OSResult::getBasisStatusEl().

bool BasisStatus::getIntVector	(	int	status,
		int *	i
	)

Get the entire array of indices for a particular status.

Parameters:

	status	is a string representing the allowed statuses (as governed by enumeration ENUM_BASIS_STATUS --- see below)
	i	is the location where the user wants to store the array