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

ObjCryst::SimplexObj Class Reference

Conjugate Gradient Algorithm object. More...

Inheritance diagram for ObjCryst::SimplexObj:

Inheritance graph
[legend]
Collaboration diagram for ObjCryst::SimplexObj:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SimplexObj (const string name="Unnamed Simplex Object")
 Constructor.

virtual void Optimize (long &nbSteps, const bool silent=false, const REAL finalcost=0, const REAL maxTime=-1)
 Launch optimization (a single run) for N steps.

virtual void MultiRunOptimize (long &nbCycle, long &nbSteps, const bool silent=false, const REAL finalcost=0, const REAL maxTime=-1)
 Launch optimization for multiple runs of N steps.

virtual void XMLOutput (ostream &os, int indent=0) const
 Output a description of the object in XML format to a stream.

virtual void XMLInput (istream &is, const XMLCrystTag &tag)
 Input in XML format from a stream, restoring the set of refined objects and the associated cost functions. Note that the corresponding objects must have been loaded in memory before, else shit happens.


Private Member Functions

REAL GenerateNewSimplexConfiguration (CrystVector_REAL &vLLK, CrystVector_long &vIndex, unsigned long worst, REAL f)
 Try a new configuration by expanding the worst vertex from the center by a factor f.


Detailed Description

Conjugate Gradient Algorithm object.

currently does not handle parameters hitting limits, and is not very efficient (uses numerical derivatives)


Constructor & Destructor Documentation

ObjCryst::SimplexObj::SimplexObj const string  name = "Unnamed Simplex Object"  ) 
 

Constructor.


Member Function Documentation

REAL ObjCryst::SimplexObj::GenerateNewSimplexConfiguration CrystVector_REAL &  vLLK,
CrystVector_long &  vIndex,
unsigned long  worst,
REAL  f
[private]
 

Try a new configuration by expanding the worst vertex from the center by a factor f.

If it is better, store it as new worst. Return the new obtained llk

virtual void ObjCryst::SimplexObj::MultiRunOptimize long &  nbCycle,
long &  nbSteps,
const bool  silent = false,
const REAL  finalcost = 0,
const REAL  maxTime = -1
[virtual]
 

Launch optimization for multiple runs of N steps.

Parameters:
nbCycle: the number of runs (cycles) to perform. The structure is randomized at the beginning of each cycle. If nbCycle==-1, this will run indefinitely. The nbCycle parameter is decreased after each run.
nbSteps: the number of steps to go. This number is modified (decreases!) as the refinement goes on.
silent : if true, absolutely no message should be printed (except debugging)
finalcost: the optimization will stop if overall cost fallse below this value
maxTime: the optimization will stop after the given number of seconds has been spent optimizing (ignored if <0).

Implements ObjCryst::OptimizationObj.

virtual void ObjCryst::SimplexObj::Optimize long &  nbSteps,
const bool  silent = false,
const REAL  finalcost = 0,
const REAL  maxTime = -1
[virtual]
 

Launch optimization (a single run) for N steps.

Parameters:
nbSteps: the number of steps to go. This number is modified (decreases!) as the refinement goes on.
silent : if true, absolutely no message should be printed (except debugging)
finalcost: the optimization will stop if overall cost fallse below this value
maxTime: the optimization will stop after the given number of seconds has been spent optimizing (ignored if <0).

Implements ObjCryst::OptimizationObj.

virtual void ObjCryst::SimplexObj::XMLInput istream &  is,
const XMLCrystTag tag
[virtual]
 

Input in XML format from a stream, restoring the set of refined objects and the associated cost functions. Note that the corresponding objects must have been loaded in memory before, else shit happens.

Implements ObjCryst::OptimizationObj.

virtual void ObjCryst::SimplexObj::XMLOutput ostream &  os,
int  indent = 0
const [virtual]
 

Output a description of the object in XML format to a stream.

This saves the list of refined object and the cost functions, as well as options for the refinement. The refined objects are not saved, so this must be done somewhere else (they must be reloaded before this object).

Implements ObjCryst::OptimizationObj.


The documentation for this class was generated from the following file:
Generated on Tue Nov 14 15:06:08 2006 for ObjCryst++ by doxygen 1.3.6