BCP_col Class Reference

This class holds a column in a compressed form. More...

#include <BCP_matrix.hpp>

Inheritance diagram for BCP_col:

[legend]

Collaboration diagram for BCP_col:

[legend]

List of all members.

Public Member Functions
Query methods

double	Objective () const
	Return the objective coefficient.
double	LowerBound () const
	Return the lower bound.
double	UpperBound () const
	Return the upper bound.
General modifying methods

void	Objective (const double obj)
	Set the objective coefficient to the given value.
void	LowerBound (const double lb)
	Set the lower bound to the given value.
void	UpperBound (const double ub)
	Set the upper bound to the given value.
BCP_col &	operator= (const BCP_col &x)
	Assignment operator: copy over the contents of `x`.
void	assign (const int size, int &ElementIndices, double &ElementValues, const double Obj, const double LB, const double UB)
	Set the objective coefficient, lower and upper bounds to the given values.
void	copy (const int size, const int ElementIndices, const double ElementValues, const double Obj, const double LB, const double UB)
	Copy the arguments into the appropriate data members.
void	copy (BCP_vec< int >::const_iterator firstind, BCP_vec< int >::const_iterator lastind, BCP_vec< double >::const_iterator firstval, BCP_vec< double >::const_iterator lastval, const double Obj, const double LB, const double UB)
	Same as the other `copy()` method, except that instead of using vectors the indices (values) are given in `[firstind,lastind)` (`[firstval,lastval)`).
Constructors / Destructor

	BCP_col ()
	The default constructor creates an empty column with 0 as objective coefficient, 0.0 as lower and +infinity as upper bound.
	BCP_col (const BCP_col &x)
	The copy constructor makes a copy of `x`.
	BCP_col (BCP_vec< int >::const_iterator firstind, BCP_vec< int >::const_iterator lastind, BCP_vec< double >::const_iterator firstval, BCP_vec< double >::const_iterator lastval, const double Obj, const double LB, const double UB)
	This constructor acts exactly like the `copy` method with the same argument list.
	BCP_col (const int size, int &ElementIndices, double &ElementValues, const double Obj, const double LB, const double UB)
	This constructor acts exactly like the `assign` method with the same argument list.
	BCP_col (const CoinPackedVectorBase &vec, const double Obj, const double LB, const double UB)
	The default constructor creates an empty column with 0 as objective coefficient, 0.0 as lower and +infinity as upper bound.
	~BCP_col ()
	The destructor deletes all data members.
Protected Attributes
Data members

double	_Objective
	The objective function coefficient corresponding to the column.
double	_LowerBound
	The lower bound corresponding to the column.
double	_UpperBound
	The upper bound corresponding to the column.

Detailed Description

This class holds a column in a compressed form.

That is, it is a packed vector with an objective coefficient, lower and upper bound.

Definition at line 26 of file BCP_matrix.hpp.

Constructor & Destructor Documentation

BCP_col::BCP_col ( ) [inline]

The default constructor creates an empty column with 0 as objective coefficient, 0.0 as lower and +infinity as upper bound.

Definition at line 113 of file BCP_matrix.hpp.

BCP_col::BCP_col ( const BCP_col & x ) [inline]

The copy constructor makes a copy of x.

Definition at line 116 of file BCP_matrix.hpp.

BCP_col::BCP_col	(	BCP_vec< int >::const_iterator	firstind,
		BCP_vec< int >::const_iterator	lastind,
		BCP_vec< double >::const_iterator	firstval,
		BCP_vec< double >::const_iterator	lastval,
		const double	Obj,
		const double	LB,
		const double	UB
	)			`[inline]`

This constructor acts exactly like the copy method with the same argument list.

Definition at line 121 of file BCP_matrix.hpp.

BCP_col::BCP_col	(	const int	size,
		int *&	ElementIndices,
		double *&	ElementValues,
		const double	Obj,
		const double	LB,
		const double	UB
	)			`[inline]`

This constructor acts exactly like the assign method with the same argument list.

Definition at line 131 of file BCP_matrix.hpp.

BCP_col::BCP_col	(	const CoinPackedVectorBase &	vec,
		const double	Obj,
		const double	LB,
		const double	UB
	)			`[inline]`

The default constructor creates an empty column with 0 as objective coefficient, 0.0 as lower and +infinity as upper bound.

Definition at line 137 of file BCP_matrix.hpp.

BCP_col::~BCP_col ( ) [inline]

The destructor deletes all data members.

Definition at line 143 of file BCP_matrix.hpp.

Member Function Documentation

double BCP_col::Objective ( ) const [inline]

Return the objective coefficient.

Definition at line 44 of file BCP_matrix.hpp.

double BCP_col::LowerBound ( ) const [inline]

Return the lower bound.

Definition at line 46 of file BCP_matrix.hpp.

double BCP_col::UpperBound ( ) const [inline]

Return the upper bound.

Definition at line 48 of file BCP_matrix.hpp.

void BCP_col::Objective ( const double obj ) [inline]

Set the objective coefficient to the given value.

Definition at line 55 of file BCP_matrix.hpp.

void BCP_col::LowerBound ( const double lb ) [inline]

Set the lower bound to the given value.

Definition at line 57 of file BCP_matrix.hpp.

void BCP_col::UpperBound ( const double ub ) [inline]

Set the upper bound to the given value.

Definition at line 59 of file BCP_matrix.hpp.

BCP_col& BCP_col::operator= ( const BCP_col & x ) [inline]

Assignment operator: copy over the contents of x.

Reimplemented from CoinPackedVector.

Definition at line 62 of file BCP_matrix.hpp.

void BCP_col::assign	(	const int	size,
		int *&	ElementIndices,
		double *&	ElementValues,
		const double	Obj,
		const double	LB,
		const double	UB
	)			`[inline]`

Set the objective coefficient, lower and upper bounds to the given values.

Also invokes the assign method of the underlying packed vector.

Definition at line 73 of file BCP_matrix.hpp.

void BCP_col::copy	(	const int	size,
		const int *	ElementIndices,
		const double *	ElementValues,
		const double	Obj,
		const double	LB,
		const double	UB
	)			`[inline]`

Copy the arguments into the appropriate data members.

Definition at line 83 of file BCP_matrix.hpp.

void BCP_col::copy	(	BCP_vec< int >::const_iterator	firstind,
		BCP_vec< int >::const_iterator	lastind,
		BCP_vec< double >::const_iterator	firstval,
		BCP_vec< double >::const_iterator	lastval,
		const double	Obj,
		const double	LB,
		const double	UB
	)			`[inline]`

Same as the other copy() method, except that instead of using vectors the indices (values) are given in [firstind,lastind) ([firstval,lastval)).

Definition at line 95 of file BCP_matrix.hpp.

Member Data Documentation

double BCP_col::_Objective [protected]

The objective function coefficient corresponding to the column.

Definition at line 32 of file BCP_matrix.hpp.

double BCP_col::_LowerBound [protected]

The lower bound corresponding to the column.

Definition at line 34 of file BCP_matrix.hpp.

double BCP_col::_UpperBound [protected]

The upper bound corresponding to the column.

Definition at line 36 of file BCP_matrix.hpp.

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

/home/coin/svn-release/OptimizationSuite-1.1.0/Bcp/src/include/BCP_matrix.hpp

BCP_col Class Reference

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation