SepQcFunc::VariableIterator Class Reference

#include <func.h>

Inheritance diagram for SepQcFunc::VariableIterator:

Inheritance graph
[legend]
Collaboration diagram for SepQcFunc::VariableIterator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 VariableIterator (const SepQcFunc &f_, bool linear_=true, bool nonlinear_=true, bool quadratic_=false)
virtual int bnr () const
virtual int bindex () const
virtual int operator() () const
 Returns the index of the current variable.
virtual double coeff_lin () const
 Returns the coefficient in the linear part of this variable, if available.
virtual double coeff_quad () const
 Returns the coefficient in the quadratic part of this variable, if available.
virtual VarType type () const
 The type of the current variable.
virtual void operator++ ()
 Moves to next variable.
virtual operator bool () const
 Returns true, if we are not at the end of the variables.

Private Member Functions

void find_start ()

Private Attributes

const SepQcFuncf
map< int, SparsityInfo::LinearVariable
>::iterator 
it_linear
map< int, SparsityInfo::NonlinearVariable
>::iterator 
it_nonlinear
map< int, SparsityInfo::QuadraticVariable
>::iterator 
it_quadratic
VarType whereami
 Over which variable type am I just iterating?
int blocknr

Detailed Description

Definition at line 805 of file func.h.


Constructor & Destructor Documentation

SepQcFunc::VariableIterator::VariableIterator ( const SepQcFunc f_,
bool  linear_ = true,
bool  nonlinear_ = true,
bool  quadratic_ = false 
)


Member Function Documentation

void SepQcFunc::VariableIterator::find_start (  )  [private]

virtual int SepQcFunc::VariableIterator::bnr (  )  const [inline, virtual]

Definition at line 820 of file func.h.

References blocknr.

virtual int SepQcFunc::VariableIterator::bindex (  )  const [virtual]

Referenced by operator()().

virtual int SepQcFunc::VariableIterator::operator() (  )  const [inline, virtual]

Returns the index of the current variable.

Implements VariableIterator_Type.

Definition at line 822 of file func.h.

References bindex(), SepFunc::block, blocknr, and f.

virtual double SepQcFunc::VariableIterator::coeff_lin (  )  const [virtual]

Returns the coefficient in the linear part of this variable, if available.

Returns:
If the variable is linear, it returns it's coefficient. If the variable x is quadratic, it returns the coefficient before x.

Implements VariableIterator_Type.

virtual double SepQcFunc::VariableIterator::coeff_quad (  )  const [virtual]

Returns the coefficient in the quadratic part of this variable, if available.

Returns:
If the variable x is quadratic, it returns the coefficient before x^2.

Implements VariableIterator_Type.

virtual VarType SepQcFunc::VariableIterator::type (  )  const [inline, virtual]

The type of the current variable.

Implements VariableIterator_Type.

Definition at line 827 of file func.h.

References whereami.

virtual void SepQcFunc::VariableIterator::operator++ (  )  [virtual]

Moves to next variable.

Implements VariableIterator_Type.

virtual SepQcFunc::VariableIterator::operator bool (  )  const [inline, virtual]

Returns true, if we are not at the end of the variables.

Implements VariableIterator_Type.

Definition at line 831 of file func.h.

References VariableIterator_Type::END, and whereami.


Member Data Documentation

const SepQcFunc& SepQcFunc::VariableIterator::f [private]

Definition at line 807 of file func.h.

Referenced by operator()().

map<int, SparsityInfo::LinearVariable>::iterator SepQcFunc::VariableIterator::it_linear [private]

Definition at line 808 of file func.h.

map<int, SparsityInfo::NonlinearVariable>::iterator SepQcFunc::VariableIterator::it_nonlinear [private]

Definition at line 809 of file func.h.

map<int, SparsityInfo::QuadraticVariable>::iterator SepQcFunc::VariableIterator::it_quadratic [private]

Definition at line 810 of file func.h.

VarType SepQcFunc::VariableIterator::whereami [private]

Over which variable type am I just iterating?

Definition at line 813 of file func.h.

Referenced by operator bool(), and type().

int SepQcFunc::VariableIterator::blocknr [private]

Definition at line 814 of file func.h.

Referenced by bnr(), and operator()().


The documentation for this class was generated from the following file:
Generated on Tue Oct 21 03:12:41 2008 for LaGO by  doxygen 1.4.7