OPTPP::LinearConstraint Class Reference

#include <LinearConstraint.h>

Inheritance diagram for OPTPP::LinearConstraint:

OPTPP::ConstraintBase OPTPP::LinearEquation OPTPP::LinearInequality List of all members.

Public Member Functions

 LinearConstraint ()
 LinearConstraint (const NEWMAT::Matrix &A)
 LinearConstraint (const NEWMAT::Matrix &A, const NEWMAT::ColumnVector &b)
 LinearConstraint (const NEWMAT::Matrix &A, const NEWMAT::ColumnVector &b, const bool rowFlag)
 LinearConstraint (const NEWMAT::Matrix &A, const NEWMAT::ColumnVector &lower, const NEWMAT::ColumnVector &upper)
virtual ~LinearConstraint ()
virtual int getNumOfCons () const
virtual int getNumOfVars () const
virtual NEWMAT::ColumnVector getLower () const
virtual NEWMAT::ColumnVector getUpper () const
virtual NEWMAT::ColumnVector getConstraintValue () const
virtual NEWMAT::ColumnVector getConstraintViolation () const
OptppArray< int > getConstraintMappingIndices () const
void setA (NEWMAT::Matrix &A)
virtual NEWMAT::ColumnVector getConstraintType () const =0
virtual NEWMAT::ColumnVector evalAx (const NEWMAT::ColumnVector &xc) const =0
virtual NEWMAT::ColumnVector evalResidual (const NEWMAT::ColumnVector &xc) const =0
virtual void evalCFGH (const NEWMAT::ColumnVector &xc) const =0
virtual NEWMAT::Matrix evalGradient (const NEWMAT::ColumnVector &xc) const =0
virtual bool amIFeasible (const NEWMAT::ColumnVector &xc, double epsilon) const =0

Protected Attributes

int numOfCons_
 Number of constraints.
int numOfVars_
 Number of variables.
int nnzl_
 Number of finite lower bounds.
int nnzu_
 Number of finite upper bounds.
NEWMAT::Matrix A_
 Matrix representation of the constraints.
NEWMAT::ColumnVector Ax_
 Matrix-vector product.
NEWMAT::ColumnVector lower_
 Lower bounds on the variables.
NEWMAT::ColumnVector upper_
 Upper bounds on the variables.
NEWMAT::ColumnVector cvalue_
 The value of the linear constraints.
NEWMAT::ColumnVector cviolation_
 The constraint violation, zero if all constraints satisfied.
OptppArray< int > constraintMappingIndices_
 Indices of finite bounds.
bool stdForm_
 Standard form representation of constraints.

Private Member Functions

virtual NEWMAT::SymmetricMatrix evalHessian (NEWMAT::ColumnVector &xc) const
virtual OptppArray< NEWMAT::SymmetricMatrix > evalHessian (NEWMAT::ColumnVector &xc, int darg) const
bool dimMatch (NEWMAT::Matrix &A)

Constructor & Destructor Documentation

OPTPP::LinearConstraint::LinearConstraint (  ) 

Default Constructor

OPTPP::LinearConstraint::LinearConstraint ( const NEWMAT::Matrix &  A  ) 

Parameters:
A a real Matrix
See also:
LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& b)

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& b, const bool rowFlag)

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& lower, const NEWMAT::ColumnVector& upper)

OPTPP::LinearConstraint::LinearConstraint ( const NEWMAT::Matrix &  A,
const NEWMAT::ColumnVector &  b 
)

Parameters:
A a real Matrix
b a ColumnVector
See also:
LinearConstraint(const Matrix& A);

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& b, const bool rowFlag)

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& lower, const NEWMAT::ColumnVector& upper)

OPTPP::LinearConstraint::LinearConstraint ( const NEWMAT::Matrix &  A,
const NEWMAT::ColumnVector &  b,
const bool  rowFlag 
)

Parameters:
A a real Matrix
b a ColumnVector
rowFlag a bool
See also:
LinearConstraint(const Matrix& A);

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& b)

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& lower, const NEWMAT::ColumnVector& upper)

OPTPP::LinearConstraint::LinearConstraint ( const NEWMAT::Matrix &  A,
const NEWMAT::ColumnVector &  lower,
const NEWMAT::ColumnVector &  upper 
)

Parameters:
A a real Matrix
lower a ColumnVector
upper a ColumnVector
See also:
LinearConstraint(const Matrix& A);

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& b)

LinearConstraint(const Matrix& A, const NEWMAT::ColumnVector& b, const bool rowFlag)

virtual OPTPP::LinearConstraint::~LinearConstraint (  )  [inline, virtual]

Destructor


Member Function Documentation

virtual bool OPTPP::LinearConstraint::amIFeasible ( const NEWMAT::ColumnVector &  xc,
double  epsilon 
) const [pure virtual]

Takes two arguments and returns a bool.

Parameters:
xc a ColumnVector
epsilon a real argument
Returns:
A bool

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::LinearEquation, and OPTPP::LinearInequality.

bool OPTPP::LinearConstraint::dimMatch ( NEWMAT::Matrix &  A  )  [private]

Takes one arguments and returns a bool.

Parameters:
A a Matrix
Returns:
A bool

virtual NEWMAT::ColumnVector OPTPP::LinearConstraint::evalAx ( const NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Takes one argument and returns a ColumnVector.

Parameters:
xc a ColumnVector
Returns:
Matrix-vector product of A and xc.

Implemented in OPTPP::LinearEquation, and OPTPP::LinearInequality.

virtual void OPTPP::LinearConstraint::evalCFGH ( const NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::LinearEquation, and OPTPP::LinearInequality.

virtual NEWMAT::Matrix OPTPP::LinearConstraint::evalGradient ( const NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Takes one argument and returns a real Matrix.

Parameters:
xc a ColumnVector
Returns:
The gradient of the linear equations evaluated at xc.

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::LinearEquation, and OPTPP::LinearInequality.

virtual OptppArray<NEWMAT::SymmetricMatrix> OPTPP::LinearConstraint::evalHessian ( NEWMAT::ColumnVector &  xc,
int  darg 
) const [private, virtual]

Takes two arguments and returns an array of real SymmetricMatrices.

Parameters:
xc a ColumnVector
darg an integer argument
Returns:
An array of constraint Hessians.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::SymmetricMatrix OPTPP::LinearConstraint::evalHessian ( NEWMAT::ColumnVector &  xc  )  const [private, virtual]

Takes one argument and returns a SymmetricMatrix

Parameters:
xc a ColumnVector
Returns:
The constraint Hessain evaluated at xc

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::LinearConstraint::evalResidual ( const NEWMAT::ColumnVector &  xc  )  const [pure virtual]

Takes one argument and returns a ColumnVector.

Parameters:
xc a ColumnVector
Returns:
The residual of the linear equations evaluated at xc.

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::LinearEquation, and OPTPP::LinearInequality.

OptppArray<int> OPTPP::LinearConstraint::getConstraintMappingIndices (  )  const [inline, virtual]

Returns:
Indices of constraints with finite bounds

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::LinearConstraint::getConstraintType (  )  const [pure virtual]

Returns:
Type of constraint - Leqn

Implements OPTPP::ConstraintBase.

Implemented in OPTPP::LinearEquation, and OPTPP::LinearInequality.

virtual NEWMAT::ColumnVector OPTPP::LinearConstraint::getConstraintValue (  )  const [inline, virtual]

Returns:
Value of the linear constraints.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::LinearConstraint::getConstraintViolation (  )  const [inline, virtual]

Returns:
Constraint violation.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::LinearConstraint::getLower (  )  const [inline, virtual]

Returns:
The lower bounds on the variables.

Implements OPTPP::ConstraintBase.

virtual int OPTPP::LinearConstraint::getNumOfCons (  )  const [inline, virtual]

Returns:
The number of constraints.

Implements OPTPP::ConstraintBase.

virtual int OPTPP::LinearConstraint::getNumOfVars (  )  const [inline, virtual]

Returns:
The number of variables.

Implements OPTPP::ConstraintBase.

virtual NEWMAT::ColumnVector OPTPP::LinearConstraint::getUpper (  )  const [inline, virtual]

Returns:
The upper bounds on the variables.

Implements OPTPP::ConstraintBase.

void OPTPP::LinearConstraint::setA ( NEWMAT::Matrix &  A  ) 

Assigns a value to the constraint matrix.


Member Data Documentation

NEWMAT::Matrix OPTPP::LinearConstraint::A_ [protected]

Matrix representation of the constraints.

NEWMAT::ColumnVector OPTPP::LinearConstraint::Ax_ [protected]

Matrix-vector product.

OptppArray<int> OPTPP::LinearConstraint::constraintMappingIndices_ [protected]

Indices of finite bounds.

NEWMAT::ColumnVector OPTPP::LinearConstraint::cvalue_ [mutable, protected]

The value of the linear constraints.

NEWMAT::ColumnVector OPTPP::LinearConstraint::cviolation_ [mutable, protected]

The constraint violation, zero if all constraints satisfied.

NEWMAT::ColumnVector OPTPP::LinearConstraint::lower_ [protected]

Lower bounds on the variables.

int OPTPP::LinearConstraint::nnzl_ [protected]

Number of finite lower bounds.

int OPTPP::LinearConstraint::nnzu_ [protected]

Number of finite upper bounds.

int OPTPP::LinearConstraint::numOfCons_ [protected]

Number of constraints.

int OPTPP::LinearConstraint::numOfVars_ [protected]

Number of variables.

bool OPTPP::LinearConstraint::stdForm_ [protected]

Standard form representation of constraints.

NEWMAT::ColumnVector OPTPP::LinearConstraint::upper_ [protected]

Upper bounds on the variables.


The documentation for this class was generated from the following files:
Bug Reports    OPT++ Developers    Copyright Information    GNU Lesser General Public License
Documentation, generated by , last revised August 30, 2006.