Logo ROOT  
Reference Guide
 
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Loading...
Searching...
No Matches
TGondzioSolver Class Reference

Derived class of TQpSolverBase implementing Gondzio-correction version of Mehrotra's original predictor-corrector algorithm.

Definition at line 56 of file TGondzioSolver.h.

Public Member Functions

 TGondzioSolver ()
 Default constructor.
 
 TGondzioSolver (const TGondzioSolver &another)
 Copy constructor.
 
 TGondzioSolver (TQpProbBase *of, TQpDataBase *prob, Int_t verbose=0)
 Constructor.
 
 ~TGondzioSolver () override
 Deconstructor.
 
void DefMonitor (TQpDataBase *data, TQpVar *vars, TQpResidual *resids, Double_t alpha, Double_t sigma, Int_t i, Double_t mu, Int_t status_code, Int_t level) override
 Print information about the optimization process and monitor the convergence status of thye algorithm.
 
TClassIsA () const override
 
TGondzioSolveroperator= (const TGondzioSolver &source)
 Assignment operator.
 
virtual void Reset_parameters ()
 
Int_t Solve (TQpDataBase *prob, TQpVar *iterate, TQpResidual *resid) override
 Solve the quadratic programming problem as formulated through prob, store the final solution in iterate->fX .
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TQpSolverBase
 TQpSolverBase ()
 Default constructor.
 
 TQpSolverBase (const TQpSolverBase &another)
 Copy constructor.
 
 ~TQpSolverBase () override
 Deconstructor.
 
Double_t DataNorm ()
 
virtual void DefStart (TQpProbBase *formulation, TQpVar *iterate, TQpDataBase *prob, TQpResidual *resid, TQpVar *step)
 Default starting point.
 
virtual Int_t DefStatus (TQpDataBase *data, TQpVar *vars, TQpResidual *resids, Int_t i, Double_t mu, Int_t level)
 Default status method.
 
virtual void DoMonitor (TQpDataBase *data, TQpVar *vars, TQpResidual *resids, Double_t alpha, Double_t sigma, Int_t i, Double_t mu, Int_t stop_code, Int_t level)
 Monitor progress / convergence aat each interior-point iteration.
 
virtual Int_t DoStatus (TQpDataBase *data, TQpVar *vars, TQpResidual *resids, Int_t i, Double_t mu, Int_t level)
 Tests for termination.
 
virtual void DumbStart (TQpProbBase *formulation, TQpVar *iterate, TQpDataBase *prob, TQpResidual *resid, TQpVar *step)
 Alternative starting point heuristic: sets the "complementary" variables to a large positive value (based on the norm of the problem data) and the remaining variables to zero .
 
virtual Double_t FinalStepLength (TQpVar *iterate, TQpVar *step)
 Implements a version of Mehrotra starting point heuristic, modified to ensure identical steps in the primal and dual variables.
 
Double_t GetArTol ()
 
TQpLinSolverBaseGetLinearSystem ()
 
Double_t GetMuTol ()
 
TClassIsA () const override
 
TQpSolverBaseoperator= (const TQpSolverBase &source)
 Assignment operator.
 
void SetArTol (Double_t ar)
 
void SetMuTol (Double_t m)
 
virtual void Start (TQpProbBase *formulation, TQpVar *iterate, TQpDataBase *prob, TQpResidual *resid, TQpVar *step)
 Implements a default starting-point heuristic.
 
virtual void SteveStart (TQpProbBase *formulation, TQpVar *iterate, TQpDataBase *prob, TQpResidual *resid, TQpVar *step)
 Starting point algorithm according to Stephen Wright.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TQpSolverBase
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Attributes

Double_t fAcceptTol
 
Double_t fBeta_max
 
Double_t fBeta_min
 
TQpResidualfCorrector_resid
 
TQpVarfCorrector_step
 
TQpProbBasefFactory
 
Int_t fMaximum_correctors
 
Int_t fNumberGondzioCorrections
 
Int_t fPrintlevel
 
TQpVarfStep
 
Double_t fStepFactor0
 
Double_t fStepFactor1
 
Double_t fTsig
 
- Protected Attributes inherited from TQpSolverBase
Double_t fArtol
 
Double_t fDnorm
 
Double_t fGamma_a
 
Double_t fGamma_f
 
Int_t fMaxit
 
Double_tfMu_history
 
Double_t fMutol
 
Double_t fPhi
 
Double_tfPhi_history
 
Double_tfPhi_min_history
 
Double_tfRnorm_history
 
TQpLinSolverBasefSys
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Public Attributes inherited from TQpSolverBase
Int_t fIter
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

#include <TGondzioSolver.h>

Inheritance diagram for TGondzioSolver:
[legend]

Constructor & Destructor Documentation

◆ TGondzioSolver() [1/3]

TGondzioSolver::TGondzioSolver ( )

Default constructor.

Definition at line 63 of file TGondzioSolver.cxx.

◆ TGondzioSolver() [2/3]

TGondzioSolver::TGondzioSolver ( TQpProbBase * of,
TQpDataBase * prob,
Int_t verbose = 0 )

Constructor.

Definition at line 86 of file TGondzioSolver.cxx.

◆ TGondzioSolver() [3/3]

TGondzioSolver::TGondzioSolver ( const TGondzioSolver & another)

Copy constructor.

Definition at line 118 of file TGondzioSolver.cxx.

◆ ~TGondzioSolver()

TGondzioSolver::~TGondzioSolver ( )
override

Deconstructor.

Definition at line 326 of file TGondzioSolver.cxx.

Member Function Documentation

◆ Class()

static TClass * TGondzioSolver::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TGondzioSolver::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TGondzioSolver::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 103 of file TGondzioSolver.h.

◆ DeclFileName()

static const char * TGondzioSolver::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 103 of file TGondzioSolver.h.

◆ DefMonitor()

void TGondzioSolver::DefMonitor ( TQpDataBase * data,
TQpVar * vars,
TQpResidual * resids,
Double_t alpha,
Double_t sigma,
Int_t i,
Double_t mu,
Int_t status_code,
Int_t level )
overridevirtual

Print information about the optimization process and monitor the convergence status of thye algorithm.

Implements TQpSolverBase.

Definition at line 276 of file TGondzioSolver.cxx.

◆ IsA()

TClass * TGondzioSolver::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 103 of file TGondzioSolver.h.

◆ operator=()

TGondzioSolver & TGondzioSolver::operator= ( const TGondzioSolver & source)

Assignment operator.

Definition at line 337 of file TGondzioSolver.cxx.

◆ Reset_parameters()

virtual void TGondzioSolver::Reset_parameters ( )
inlinevirtual

Definition at line 95 of file TGondzioSolver.h.

◆ Solve()

Int_t TGondzioSolver::Solve ( TQpDataBase * prob,
TQpVar * iterate,
TQpResidual * resid )
overridevirtual

Solve the quadratic programming problem as formulated through prob, store the final solution in iterate->fX .

Monitor the residuals during the iterations through resid . The status is returned as defined in TQpSolverBase::ETerminationCode .

Implements TQpSolverBase.

Definition at line 129 of file TGondzioSolver.cxx.

◆ Streamer()

void TGondzioSolver::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TGondzioSolver::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 103 of file TGondzioSolver.h.

Member Data Documentation

◆ fAcceptTol

Double_t TGondzioSolver::fAcceptTol
protected

Definition at line 74 of file TGondzioSolver.h.

◆ fBeta_max

Double_t TGondzioSolver::fBeta_max
protected

Definition at line 76 of file TGondzioSolver.h.

◆ fBeta_min

Double_t TGondzioSolver::fBeta_min
protected

Definition at line 75 of file TGondzioSolver.h.

◆ fCorrector_resid

TQpResidual* TGondzioSolver::fCorrector_resid
protected

Definition at line 81 of file TGondzioSolver.h.

◆ fCorrector_step

TQpVar* TGondzioSolver::fCorrector_step
protected

Definition at line 78 of file TGondzioSolver.h.

◆ fFactory

TQpProbBase* TGondzioSolver::fFactory
protected

Definition at line 83 of file TGondzioSolver.h.

◆ fMaximum_correctors

Int_t TGondzioSolver::fMaximum_correctors
protected

Definition at line 68 of file TGondzioSolver.h.

◆ fNumberGondzioCorrections

Int_t TGondzioSolver::fNumberGondzioCorrections
protected

Definition at line 70 of file TGondzioSolver.h.

◆ fPrintlevel

Int_t TGondzioSolver::fPrintlevel
protected

Definition at line 61 of file TGondzioSolver.h.

◆ fStep

TQpVar* TGondzioSolver::fStep
protected

Definition at line 79 of file TGondzioSolver.h.

◆ fStepFactor0

Double_t TGondzioSolver::fStepFactor0
protected

Definition at line 72 of file TGondzioSolver.h.

◆ fStepFactor1

Double_t TGondzioSolver::fStepFactor1
protected

Definition at line 73 of file TGondzioSolver.h.

◆ fTsig

Double_t TGondzioSolver::fTsig
protected

Definition at line 63 of file TGondzioSolver.h.

Libraries for TGondzioSolver:

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