ABA_COLUMN Class Reference

class ABA_COLUMN refines ABA_SPARVEC for the representation of variables in column format. More...

#include <column.h>

Inheritance diagram for ABA_COLUMN:

List of all members.

Public Member Functions
	ABA_COLUMN (ABA_GLOBAL *glob, double obj, double lb, double ub, int nnz, ABA_ARRAY< int > &s, ABA_ARRAY< double > &c)
	ABA_COLUMN (ABA_GLOBAL *glob, int maxNnz)
	ABA_COLUMN (ABA_GLOBAL *glob, double obj, double lb, double ub, ABA_SPARVEC &vec)
	~ABA_COLUMN ()
double	obj () const
void	obj (double c)
	This version of the function obj() sets the objective function coefficient of the column.
double	lBound () const
void	lBound (double l)
	This version of the function lBound() sets the lower bound of the column.
double	uBound () const
void	uBound (double u)
	This version of the function uBound() sets the upper bound of the column.
void	copy (const ABA_COLUMN &col)
	Is very similar to the assignment operator, yet the columns do not have to be of equal size. A reallocation is performed if required.
Private Attributes
double	obj_
double	lBound_
double	uBound_
Friends
ostream &	operator<< (ostream &out, const ABA_COLUMN &rhs)

---

Detailed Description

class ABA_COLUMN refines ABA_SPARVEC for the representation of variables in column format.

Definition at line 44 of file column.h.

---

Constructor & Destructor Documentation

ABA_COLUMN::ABA_COLUMN	(	ABA_GLOBAL *	glob,
		double	obj,
		double	lb,
		double	ub,
		int	nnz,
		ABA_ARRAY< int > &	s,
		ABA_ARRAY< double > &	c
	)

A constructor.

Parameters:

	glob	A pointer to the corresponding global object.
	obj	{The objective function coefficient.
	lb	The lower bound.
	ub	The upper bound.
	nnz	The number of nonzero elements stored in the arrays |s| and |c|.
	s	An array of the nonzero elements of the column.
	c	An array of the nonzero coefficients associated with the elements of |s|.

ABA_COLUMN::ABA_COLUMN	(	ABA_GLOBAL *	glob,
		int	maxNnz
	)

Another constructor generating an uninitialized column.

Parameters:

	glob	A pointer to the corresponding global object.
	maxNnz	The maximal number of nonzero elements that can be stored in the row.

ABA_COLUMN::ABA_COLUMN	(	ABA_GLOBAL *	glob,
		double	obj,
		double	lb,
		double	ub,
		ABA_SPARVEC &	vec
	)

A constructor using a sparse vector for the initialization.

Parameters:

	glob	A pointer to the corresponding global object.
	obj	The objective function coefficient.
	lb	The lower bound.
	ub	The upper bound.
	vec	A sparse vector storing the support and the coefficients of the column.

ABA_COLUMN::~ABA_COLUMN

(

)

---

Member Function Documentation

double ABA_COLUMN::obj

(

)

const [inline]

Returns:

The objective function coefficient of the column.

Definition at line 172 of file column.h.

void ABA_COLUMN::obj

(

double

c

)

[inline]

This version of the function obj() sets the objective function coefficient of the column.

Parameters:

c

The new value of the objective function coefficient.

Definition at line 177 of file column.h.

double ABA_COLUMN::lBound

(

)

const [inline]

Returns:

The lower bound of the column.

Definition at line 182 of file column.h.

void ABA_COLUMN::lBound

(

double

l

)

[inline]

This version of the function lBound() sets the lower bound of the column.

Parameters:

l

The new value of the lower bound.

Definition at line 187 of file column.h.

double ABA_COLUMN::uBound

(

)

const [inline]

Returns:

The upper bound of the column.

Definition at line 192 of file column.h.

void ABA_COLUMN::uBound

(

double

u

)

[inline]

This version of the function uBound() sets the upper bound of the column.

Parameters:

u

The new value of the upper bound.

Definition at line 197 of file column.h.

void ABA_COLUMN::copy

(

const ABA_COLUMN &

col

)

Is very similar to the assignment operator, yet the columns do not have to be of equal size. A reallocation is performed if required.

Parameters:

col

The column that is copied.

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	out,
		const ABA_COLUMN &	rhs
	)			[friend]

The output operator.

Returns:

A reference to the output stream.

Parameters:

	out	The output stream.
	rhs	The column being output.

---

Member Data Documentation

double ABA_COLUMN::obj_ [private]

The objective function coefficient of the column.

Definition at line 160 of file column.h.

double ABA_COLUMN::lBound_ [private]

The lower bound of the column.

Definition at line 164 of file column.h.

double ABA_COLUMN::uBound_ [private]

The upper bound of the column.

Definition at line 168 of file column.h.

---

The documentation for this class was generated from the following file:

• Include/abacus/column.h

---