SoPlex: LPCol Class Reference

SoPlex Doxygen Documentation

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

LP column.Class LPCol provides a datatype for storing the column of an LP a the form similar to

$\begin{array}{rl} \hbox{max} & c^T x \\ \hbox{s.t.} & Ax \le b \\ & l \le x \le u \end{array}$

Hence, an LPCol consists of an objective value, a column DSVector and an upper and lower bound to the corresponding variable, which may include $\pm\infty$ . However, it depends on the LP code to use, what values are actually treated as $\infty$ . More...

#include <lpcol.h>

Public Member Functions
Construction / destruction
	LPCol (int defDim=0)
	default constructor.

	LPCol (Real p_obj, const SVector &p_vector, Real p_upper, Real p_lower)
	initializing constructor.

	LPCol (const LPCol &old)
	copy constructor.

	~LPCol ()
	destructor

Access / modification
Real	obj () const
	get objective value.

void	setObj (Real p_object)
	access objective value.

Real	upper () const
	get upper bound.

void	setUpper (Real p_up)
	access upper bound.

Real	lower () const
	get lower bound.

void	setLower (Real p_low)
	access lower bound.

const SVector &	colVector () const
	get constraint column vector.

void	setColVector (const SVector &p_vec)
	access constraint column vector.

Consistency check
bool	isConsistent () const
	check consistency.

Private Attributes
Data
Real	up
	upper bound

Real	low
	lower bound

Real	object
	objective value

DSVector	vec
	the column vector

Detailed Description

LP column.

Class LPCol provides a datatype for storing the column of an LP a the form similar to

$\begin{array}{rl} \hbox{max} & c^T x \\ \hbox{s.t.} & Ax \le b \\ & l \le x \le u \end{array}$

Hence, an LPCol consists of an objective value, a column DSVector and an upper and lower bound to the corresponding variable, which may include $\pm\infty$ . However, it depends on the LP code to use, what values are actually treated as $\infty$ .

Definition at line 46 of file lpcol.h.

Constructor & Destructor Documentation

LPCol ( int defDim = 0 )

explicit

default constructor.

Construct LPCol with a column vector ready for taking defDim nonzeros.

Definition at line 68 of file lpcol.h.

References LPCol::isConsistent().

LPCol	(	Real	p_obj,
		const SVector &	p_vector,
		Real	p_upper,
		Real	p_lower
	)

initializing constructor.

Definition at line 78 of file lpcol.h.

References LPCol::isConsistent().

LPCol ( const LPCol & old )

copy constructor.

Definition at line 85 of file lpcol.h.

References LPCol::isConsistent().

~LPCol ( )

destructor

Definition at line 92 of file lpcol.h.

Member Function Documentation

const SVector& colVector ( ) const

get constraint column vector.

Definition at line 133 of file lpcol.h.

References LPCol::vec.

Referenced by LPColSet::add(), SPxLP::changeCol(), and SPxLP::doAddCol().

bool isConsistent ( ) const

check consistency.

Definition at line 149 of file lpcol.h.

References DSVector::isConsistent(), and LPCol::vec.

Referenced by LPCol::LPCol().

Real lower ( ) const

get lower bound.

Definition at line 122 of file lpcol.h.

References LPCol::low.

Referenced by LPColSet::add(), and SPxLP::changeCol().

Real obj ( ) const

get objective value.

Definition at line 100 of file lpcol.h.

References LPCol::object.

Referenced by LPColSet::add(), and SPxLP::changeCol().

void setColVector ( const SVector & p_vec )

access constraint column vector.

Definition at line 139 of file lpcol.h.

References LPCol::vec.

Referenced by SPxLP::getCol().

void setLower ( Real p_low )

access lower bound.

Definition at line 127 of file lpcol.h.

References LPCol::low.

Referenced by SPxLP::getCol().

void setObj ( Real p_object )

access objective value.

Definition at line 105 of file lpcol.h.

Referenced by SPxLP::getCol().

void setUpper ( Real p_up )

access upper bound.

Definition at line 116 of file lpcol.h.

References LPCol::up.

Referenced by SPxLP::getCol().

Real upper ( ) const

get upper bound.

Definition at line 111 of file lpcol.h.

References LPCol::up.

Referenced by LPColSet::add(), and SPxLP::changeCol().

Member Data Documentation

Real low

private

lower bound

Definition at line 54 of file lpcol.h.

Referenced by LPCol::lower(), and LPCol::setLower().

Real object

private

objective value

Definition at line 55 of file lpcol.h.

Referenced by LPCol::obj().

private

upper bound

Definition at line 53 of file lpcol.h.

Referenced by LPCol::setUpper(), and LPCol::upper().

private

the column vector

Definition at line 56 of file lpcol.h.

Referenced by LPCol::colVector(), LPCol::isConsistent(), and LPCol::setColVector().