OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Private Member Functions | Private Attributes | List of all members
LMDif Class Reference

The LMDIF command. More...

#include <LMDif.h>

Inheritance diagram for LMDif:
Inheritance graph
[legend]
Collaboration diagram for LMDif:
Collaboration graph
[legend]

Public Member Functions

 LMDif ()
 Exemplar constructor. More...
 
virtual ~LMDif ()
 
virtual LMDifclone (const std::string &name)
 Make clone. More...
 
virtual void execute ()
 Execute the command. More...
 
- Public Member Functions inherited from Action
virtual ~Action ()
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed. More...
 
virtual const std::string getCategory () const
 Return the object category as a string. More...
 
virtual bool shouldTrace () const
 Trace flag. More...
 
virtual bool shouldUpdate () const
 Update flag. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 
void copyAttributes (const Object &)
 Copy attributes from another object. More...
 
virtual AttributefindAttribute (const std::string &name)
 Find an attribute by name. More...
 
virtual const AttributefindAttribute (const std::string &name) const
 Find an attribute by name. More...
 
virtual ObjectmakeTemplate (const std::string &, TokenStream &, Statement &)
 Macro handler function. More...
 
virtual ObjectmakeInstance (const std::string &name, Statement &, const Parser *)
 Macro handler function. More...
 
virtual void parse (Statement &)
 Parse the object. More...
 
virtual void parseShortcut (Statement &)
 Parser for single-attribute commands. More...
 
virtual void print (std::ostream &) const
 Print the object. More...
 
virtual void printValue (std::ostream &) const
 
virtual void printHelp (std::ostream &) const
 Print help. More...
 
virtual void replace (Object *oldObject, Object *newObject)
 Replace references. More...
 
virtual void update ()
 Update this object. More...
 
bool isBuiltin () const
 True, if [b]this[/b] is a built-in object. More...
 
virtual bool isShared () const
 Shared flag. More...
 
virtual void setShared (bool)
 Set/reset shared flag. More...
 
void setDirty (bool)
 Set/reset the [b]modified[/b] flag. More...
 
bool isDirty () const
 True, if the [b]modified[/b] flag is set. More...
 
void setFlag (bool)
 Flag/unflag this object, e. g. to control output of objects for. More...
 
bool isFlagged () const
 True, if [b]this[/b] is flagged by setFlag(true). More...
 
const ObjectgetBaseObject () const
 Return the object's base type object. More...
 
const std::string & getOpalName () const
 Return object name. More...
 
ObjectgetParent () const
 Return parent pointer. More...
 
bool isTreeMember (const Object *subTree) const
 Test for tree membership. More...
 
void setOpalName (const std::string &name)
 Set object name. More...
 
void setParent (Object *)
 Set parent object. More...
 
void clear ()
 Clear the occurrence counter. More...
 
int increment ()
 Increment and return the occurrence counter. More...
 
int occurrenceCount ()
 Return the occurrence counter. More...
 
void registerReference (Invalidator *a)
 Register a reference to this object. More...
 
void unregisterReference (Invalidator *a)
 Unegister a reference to this object. More...
 
void registerOwnership (const AttributeHandler::OwnerType &itsClass) const
 
- Public Member Functions inherited from RCObject
int addReference () const
 Increment reference count. More...
 
int removeReference () const
 Decrement the reference count. More...
 
bool isShared () const
 Test for sharing. More...
 

Private Member Functions

 LMDif (const LMDif &)
 
void operator= (const LMDif &)
 
 LMDif (const std::string &name, LMDif *parent)
 
bool findJacobian (Vector< double > &X, Vector< double > &F)
 
void lmpar (QRSolver &solver, const Array1D< double > &D, const Vector< double > &F, Vector< double > &P)
 

Private Attributes

double fraction
 
double delta
 
double mu
 
Matrix< double > jacobian
 

Additional Inherited Members

- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 The object attributes (see Attribute.hh). More...
 
- Protected Member Functions inherited from Action
 Action (int size, const char *name, const char *help)
 Constructor for exemplars. More...
 
 Action (const std::string &name, Action *parent)
 Constructor for cloning. More...
 
- Protected Member Functions inherited from Object
 Object (int size, const char *name, const char *help)
 Constructor for exemplars. More...
 
 Object (const std::string &name, Object *parent)
 Constructor for clones. More...
 
- Protected Member Functions inherited from RCObject
 RCObject ()
 Default constructor. More...
 
 RCObject (const RCObject &)
 Copy constructor. More...
 
virtual ~RCObject ()=0
 
RCObjectoperator= (const RCObject &right)
 
- Protected Attributes inherited from Object
bool builtin
 Built-in flag. More...
 
bool modified
 Dirty flag. More...
 
bool flagged
 Object flag. More...
 

Detailed Description

The LMDIF command.

Definition at line 45 of file LMDif.h.

Constructor & Destructor Documentation

LMDif::LMDif ( )

Exemplar constructor.

Definition at line 48 of file LMDif.cpp.

References Physics::e, Object::itsAttr, Attributes::makeReal(), Object::registerOwnership(), and AttributeHandler::SUB_COMMAND.

Referenced by clone().

Here is the call graph for this function:

LMDif::~LMDif ( )
virtual

Definition at line 68 of file LMDif.cpp.

LMDif::LMDif ( const LMDif )
private
LMDif::LMDif ( const std::string &  name,
LMDif parent 
)
private

Definition at line 61 of file LMDif.cpp.

References delta, and fraction.

Member Function Documentation

LMDif * LMDif::clone ( const std::string &  name)
virtual

Make clone.

Implements Object.

Definition at line 72 of file LMDif.cpp.

References LMDif().

Here is the call graph for this function:

void LMDif::execute ( )
virtual
bool LMDif::findJacobian ( Vector< double > &  X,
Vector< double > &  F 
)
private

Definition at line 262 of file LMDif.cpp.

References abs(), Match::block, Match::evaluate(), fraction, jacobian, Hypervolume::n, and Array1D< T >::size().

Referenced by execute().

Here is the call graph for this function:

void LMDif::lmpar ( QRSolver solver,
const Array1D< double > &  D,
const Vector< double > &  F,
Vector< double > &  P 
)
private

Definition at line 217 of file LMDif.cpp.

References abs(), delta, max(), mu, Hypervolume::n, scaled_norm(), Array1D< T >::size(), QRSolver::solveR(), QRSolver::solveS(), and QRSolver::solveST().

Referenced by execute().

Here is the call graph for this function:

void LMDif::operator= ( const LMDif )
private

Member Data Documentation

double LMDif::delta
private

Definition at line 84 of file LMDif.h.

Referenced by execute(), LMDif(), and lmpar().

double LMDif::fraction
private

Definition at line 81 of file LMDif.h.

Referenced by findJacobian(), and LMDif().

Matrix<double> LMDif::jacobian
private

Definition at line 90 of file LMDif.h.

Referenced by execute(), and findJacobian().

double LMDif::mu
private

Definition at line 87 of file LMDif.h.

Referenced by execute(), and lmpar().


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