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

SOptimizer Class Reference

#include <SOptimizer.h>

Collaboration diagram for SOptimizer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SOptimizer ()
 constructor
 ~SOptimizer ()
 destructor
SVector minimize (const SMatrix &M, const SVector &y, const SVector &lb, const SVector &ub)
 searches for a vector x minmizing |Mx - y| while satisfying the constraints (upper and lower bounds).
SVector minimize (const SMatrix &M, const SVector &y, const SVector &lb, const SVector &ub, const SVector &gradstep)
SVector minimize (const SMatrix &M, const SVector &y)
 unconstrained minimization for |Mx - y| The result
void setVerbose (bool verbose=true)
 enable/disable verbose output (by default off)
void setItMax (int itmax)
 set max number of iterations during optimization (default 100)
void setItMaxLine (int itmaxline)
 set max n. of iterations during (cubic) line search (default 10)
void setTol (double tol)
 set threshold for objective function (default 0.001)
void setGradStep (float gradstep)
 set step size per component for finite differcing
double getNIterations () const
 get actual number of iterations for last minimization
double getResidue () const
 get residue after last minimization

Protected Attributes

bool m_Verbose
int m_ItMax
int m_ItMaxLine
double m_Tol
float m_GradStep
double m_Residue
int m_NIter

Constructor & Destructor Documentation

SOptimizer::SOptimizer  ) 
 

constructor

Definition at line 16 of file SOptimizer.cpp.

References m_GradStep, m_ItMax, m_ItMaxLine, m_NIter, m_Residue, m_Tol, and m_Verbose.

SOptimizer::~SOptimizer  ) 
 

destructor

Definition at line 27 of file SOptimizer.cpp.


Member Function Documentation

double SOptimizer::getNIterations  )  const [inline]
 

get actual number of iterations for last minimization

Definition at line 58 of file SOptimizer.h.

double SOptimizer::getResidue  )  const [inline]
 

get residue after last minimization

Definition at line 60 of file SOptimizer.h.

SVector SOptimizer::minimize const SMatrix M,
const SVector y
 

unconstrained minimization for |Mx - y| The result

Parameters:
M matrix
y vector to minimize for

Definition at line 128 of file SOptimizer.cpp.

References SMatrix::getNCols(), SMatrix::getNRows(), SMatrix::insert(), m_NIter, m_Residue, SMatrix::norm(), linalg::DimSpec::q_col_lwb(), linalg::DimSpec::q_col_upb(), linalg::DimSpec::q_row_lwb(), linalg::DimSpec::q_row_upb(), SOPT_TAU, and linalg::transposed().

Here is the call graph for this function:

SVector SOptimizer::minimize const SMatrix M,
const SVector y,
const SVector lb,
const SVector ub,
const SVector gradstep
 

Definition at line 45 of file SOptimizer.cpp.

References SMatrix::getNCols(), m_ItMax, m_ItMaxLine, m_NIter, m_Residue, m_Tol, m_Verbose, and minimize().

Here is the call graph for this function:

SVector SOptimizer::minimize const SMatrix M,
const SVector y,
const SVector lb,
const SVector ub
 

searches for a vector x minmizing |Mx - y| while satisfying the constraints (upper and lower bounds).

Parameters:
M matrix
y vector to minimize for
lb vector for lower bounds
ub vector for upper bounds per component
gradstep stepping for finite differences (default all=GradStep)

Definition at line 38 of file SOptimizer.cpp.

References SMatrix::getNCols().

Referenced by minimize().

Here is the call graph for this function:

void SOptimizer::setGradStep float  gradstep  )  [inline]
 

set step size per component for finite differcing

Definition at line 55 of file SOptimizer.h.

void SOptimizer::setItMax int  itmax  )  [inline]
 

set max number of iterations during optimization (default 100)

Definition at line 49 of file SOptimizer.h.

void SOptimizer::setItMaxLine int  itmaxline  )  [inline]
 

set max n. of iterations during (cubic) line search (default 10)

Definition at line 51 of file SOptimizer.h.

void SOptimizer::setTol double  tol  )  [inline]
 

set threshold for objective function (default 0.001)

Definition at line 53 of file SOptimizer.h.

void SOptimizer::setVerbose bool  verbose = true  )  [inline]
 

enable/disable verbose output (by default off)

Definition at line 47 of file SOptimizer.h.


Member Data Documentation

float SOptimizer::m_GradStep [protected]
 

Definition at line 68 of file SOptimizer.h.

Referenced by SOptimizer().

int SOptimizer::m_ItMax [protected]
 

Definition at line 65 of file SOptimizer.h.

Referenced by minimize(), and SOptimizer().

int SOptimizer::m_ItMaxLine [protected]
 

Definition at line 66 of file SOptimizer.h.

Referenced by minimize(), and SOptimizer().

int SOptimizer::m_NIter [protected]
 

Definition at line 71 of file SOptimizer.h.

Referenced by minimize(), and SOptimizer().

double SOptimizer::m_Residue [protected]
 

Definition at line 70 of file SOptimizer.h.

Referenced by minimize(), and SOptimizer().

double SOptimizer::m_Tol [protected]
 

Definition at line 67 of file SOptimizer.h.

Referenced by minimize(), and SOptimizer().

bool SOptimizer::m_Verbose [protected]
 

Definition at line 64 of file SOptimizer.h.

Referenced by minimize(), and SOptimizer().


The documentation for this class was generated from the following files:
Generated on Wed Dec 15 21:21:02 2004 for vuVolume by  doxygen 1.3.9.1