Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

OPTPP::LinearEquation Class Reference

#include <LinearEquation.h>

Inheritance diagram for OPTPP::LinearEquation:

OPTPP::LinearConstraint OPTPP::ConstraintBase List of all members.

Public Member Functions

 LinearEquation ()
 LinearEquation (const NEWMAT::Matrix &A, const NEWMAT::ColumnVector &rhs)
virtual ~LinearEquation ()
virtual NEWMAT::ColumnVector getConstraintType () const
NEWMAT::ColumnVector getB () const
virtual NEWMAT::ColumnVector evalAx (const NEWMAT::ColumnVector &xc) const
virtual NEWMAT::ColumnVector evalResidual (const NEWMAT::ColumnVector &xc) const
virtual void evalCFGH (const NEWMAT::ColumnVector &xc) const
virtual NEWMAT::Matrix evalGradient (const NEWMAT::ColumnVector &xc) const
virtual bool amIFeasible (const NEWMAT::ColumnVector &xc, double epsilon) const

Protected Attributes

NEWMAT::ColumnVector b_
 Right-hand side of equation.
NEWMAT::ColumnVector ctype_
 Type of constraint - Leqn.

Constructor & Destructor Documentation

OPTPP::LinearEquation::LinearEquation (   ) 
 

Default Constructor

See also:
LinearEquation(const NEWMAT::Matrix& A, const NEWMAT::ColumnVector& rhs);

OPTPP::LinearEquation::LinearEquation (  const NEWMAT::Matrix &  A,
const NEWMAT::ColumnVector &  rhs
) 
 

Parameters:
A a real NEWMAT::Matrix
rhs NEWMAT::ColumnVector
See also:
LinearEquation()

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

Destructor

Member Function Documentation

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

Takes two arguments and returns a bool.

Parameters:
xc a ColumnVector
epsilon a real argument.
Returns:
The feasibility of the linear equations at xc.

Implements OPTPP::LinearConstraint.

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

Takes one argument and returns a ColumnVector.

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

Implements OPTPP::LinearConstraint.

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

Implements OPTPP::LinearConstraint.

Matrix OPTPP::LinearEquation::evalGradient (  const NEWMAT::ColumnVector &  xc  )  const [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::LinearConstraint.

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

Takes one argument and returns a ColumnVector.

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

Implements OPTPP::LinearConstraint.

NEWMAT::ColumnVector OPTPP::LinearEquation::getB (   )  const [inline]
 

Returns:
The right-hand side of the equation.

virtual NEWMAT::ColumnVector OPTPP::LinearEquation::getConstraintType (   )  const [inline, virtual]
 

Returns:
Type of constraint - Leqn

Implements OPTPP::LinearConstraint.

Member Data Documentation

NEWMAT::ColumnVector OPTPP::LinearEquation::b_ [protected]
 

Right-hand side of equation.

NEWMAT::ColumnVector OPTPP::LinearEquation::ctype_ [protected]
 

Type of constraint - Leqn.

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.