SEP Solver Library  1.0
 All Classes Namespaces Files Functions Variables Typedefs Macros
Public Member Functions | List of all members
SEP::CGStep Class Reference

#include <CGStep.h>

Inheritance diagram for SEP::CGStep:
SEP::Stepper

Public Member Functions

 CGStep ()
 
 CGStep (Vector &mod, Vector &data)
 
virtual bool Step (int iter, Vector &m, Vector &g, Vector &rr, Vector &gg, double &res, bool verbose=false)
 
virtual void Alloc_step (Vector &mod, Vector &data)
 
virtual ~CGStep ()
 
- Public Member Functions inherited from SEP::Stepper
 Stepper ()
 
virtual ~Stepper ()
 
virtual void Alloc_step (Vector, Vector)
 
virtual bool Step (int, Vector, Vector, Vector, Vector, double)
 

Detailed Description

Definition at line 7 of file CGStep.h.

Constructor & Destructor Documentation

SEP::CGStep::CGStep ( )
inline

Definition at line 10 of file CGStep.h.

SEP::CGStep::CGStep ( Vector mod,
Vector data 
)
inline

Definition at line 11 of file CGStep.h.

virtual SEP::CGStep::~CGStep ( )
inlinevirtual

Definition at line 17 of file CGStep.h.

Member Function Documentation

void SEP::CGStep::Alloc_step ( Vector mod,
Vector data 
)
virtual

Definition at line 6 of file CGStep.cpp.

bool SEP::CGStep::Step ( int  iter,
Vector m,
Vector g,
Vector rr,
Vector gg,
double &  res,
bool  verbose = false 
)
virtual

As a certain iteration, this updates model m with gradient g. The previous updates to m and g are rr and gg. res is the residual (Am-data). If you want an output of iter #, alpha, beta (step scale), add optional verbose = true. By default verbose = false.

Definition at line 17 of file CGStep.cpp.


The documentation for this class was generated from the following files: