BCP_row Class Reference

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

#include <BCP_matrix.hpp>

Inheritance diagram for BCP_row:

Inheritance graph
[legend]
Collaboration diagram for BCP_row:

Collaboration graph
[legend]
List of all members.

Public Member Functions

Query methods
double LowerBound () const
 Return the lower bound.
double UpperBound () const
 Return the upper bound.
General modifying methods
void LowerBound (double lb)
 Set the lower bound to the given value.
void UpperBound (double ub)
 Set the upper bound to the given value.
BCP_rowoperator= (const BCP_row &x)
 Assignment operator: copy over the contents of x.
void assign (const int size, int *&ElementIndices, double *&ElementValues, const double LB, const double UB)
 Set the lower and upper bounds to the given values.
void copy (const int size, const int *ElementIndices, const double *ElementValues, 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 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_row ()
 The default constructor creates an empty row with -infinity as lower and +infinity as upper bound.
 BCP_row (const BCP_row &x)
 The copy constructor makes a copy of x.
 BCP_row (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 LB, const double UB)
 This constructor acts exactly like the copy method with the same argument list.
 BCP_row (const int size, int *&ElementIndices, double *&ElementValues, const double LB, const double UB)
 This constructor acts exactly like the assign method with the same argument list.
 BCP_row (const CoinPackedVectorBase &vec, const double LB, const double UB)
 The default constructor creates an empty row with -infinity as lower and +infinity as upper bound.
 ~BCP_row ()
 The destructor deletes all data members.

Protected Attributes

Data members
double _LowerBound
 The lower bound corresponding to the row.
double _UpperBound
 The upper bound corresponding to the row.

Detailed Description

This class holds a row in a compressed form.

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

Definition at line 151 of file BCP_matrix.hpp.


Constructor & Destructor Documentation

BCP_row::BCP_row (  )  [inline]

The default constructor creates an empty row with -infinity as lower and +infinity as upper bound.

Definition at line 227 of file BCP_matrix.hpp.

BCP_row::BCP_row ( const BCP_row x  )  [inline]

The copy constructor makes a copy of x.

Definition at line 230 of file BCP_matrix.hpp.

BCP_row::BCP_row ( 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  LB,
const double  UB 
) [inline]

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

Definition at line 235 of file BCP_matrix.hpp.

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

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

Definition at line 245 of file BCP_matrix.hpp.

References CoinPackedVector::assignVector().

BCP_row::BCP_row ( const CoinPackedVectorBase vec,
const double  LB,
const double  UB 
) [inline]

The default constructor creates an empty row with -infinity as lower and +infinity as upper bound.

Definition at line 251 of file BCP_matrix.hpp.

BCP_row::~BCP_row (  )  [inline]

The destructor deletes all data members.

Definition at line 256 of file BCP_matrix.hpp.


Member Function Documentation

double BCP_row::LowerBound (  )  const [inline]

Return the lower bound.

Definition at line 166 of file BCP_matrix.hpp.

References _LowerBound.

Referenced by operator=().

double BCP_row::UpperBound (  )  const [inline]

Return the upper bound.

Definition at line 168 of file BCP_matrix.hpp.

References _UpperBound.

Referenced by operator=().

void BCP_row::LowerBound ( double  lb  )  [inline]

Set the lower bound to the given value.

Definition at line 175 of file BCP_matrix.hpp.

References _LowerBound.

void BCP_row::UpperBound ( double  ub  )  [inline]

Set the upper bound to the given value.

Definition at line 177 of file BCP_matrix.hpp.

References _UpperBound.

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

Assignment operator: copy over the contents of x.

Definition at line 180 of file BCP_matrix.hpp.

References _LowerBound, _UpperBound, LowerBound(), CoinPackedVector::operator=(), and UpperBound().

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

Set the lower and upper bounds to the given values.

Also invokes the assign method of the underlying packed vector.

Definition at line 190 of file BCP_matrix.hpp.

References _LowerBound, _UpperBound, and CoinPackedVector::assignVector().

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

Copy the arguments into the appropriate data members.

Definition at line 199 of file BCP_matrix.hpp.

References _LowerBound, _UpperBound, and CoinPackedVector::setVector().

void BCP_row::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  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 210 of file BCP_matrix.hpp.

References _LowerBound, _UpperBound, and CoinPackedVector::setVector().


Member Data Documentation

double BCP_row::_LowerBound [protected]

The lower bound corresponding to the row.

Definition at line 156 of file BCP_matrix.hpp.

Referenced by assign(), copy(), LowerBound(), and operator=().

double BCP_row::_UpperBound [protected]

The upper bound corresponding to the row.

Definition at line 158 of file BCP_matrix.hpp.

Referenced by assign(), copy(), operator=(), and UpperBound().


The documentation for this class was generated from the following file:
Generated on Wed Aug 22 03:02:54 2007 for coin-Bcp by  doxygen 1.4.7