Logo ROOT  
Reference Guide
TQpSolverBase Class Referenceabstract

The Solver class contains methods for monitoring and checking the convergence status of the algorithm, methods to determine the step length along a given direction, methods to define the starting point, and the solve method that implements the interior-point algorithm

Definition at line 72 of file TQpSolverBase.h.

Public Member Functions

 TQpSolverBase ()
 Default constructor. More...
 
 TQpSolverBase (const TQpSolverBase &another)
 Copy constructor. More...
 
virtual ~TQpSolverBase ()
 Deconstructor. More...
 
Double_t DataNorm ()
 
virtual void DefMonitor (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)=0
 
virtual void DefStart (TQpProbBase *formulation, TQpVar *iterate, TQpDataBase *prob, TQpResidual *resid, TQpVar *step)
 Default starting point. More...
 
virtual Int_t DefStatus (TQpDataBase *data, TQpVar *vars, TQpResidual *resids, Int_t i, Double_t mu, Int_t level)
 Default status method. More...
 
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. More...
 
virtual Int_t DoStatus (TQpDataBase *data, TQpVar *vars, TQpResidual *resids, Int_t i, Double_t mu, Int_t level)
 Tests for termination. More...
 
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 . More...
 
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. More...
 
Double_t GetArTol ()
 
TQpLinSolverBaseGetLinearSystem ()
 
Double_t GetMuTol ()
 
TQpSolverBaseoperator= (const TQpSolverBase &source)
 Assignment operator. More...
 
void SetArTol (Double_t ar)
 
void SetMuTol (Double_t m)
 
virtual Int_t Solve (TQpDataBase *prob, TQpVar *iterate, TQpResidual *resids)=0
 
virtual void Start (TQpProbBase *formulation, TQpVar *iterate, TQpDataBase *prob, TQpResidual *resid, TQpVar *step)
 Implements a default starting-point heuristic. More...
 
virtual void SteveStart (TQpProbBase *formulation, TQpVar *iterate, TQpDataBase *prob, TQpResidual *resid, TQpVar *step)
 Starting point algoritm according to Stephen Wright. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Public Attributes

Int_t fIter
 

Protected Attributes

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 = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
void MakeZombie ()
 

#include <TQpSolverBase.h>

Inheritance diagram for TQpSolverBase:
[legend]

Constructor & Destructor Documentation

◆ TQpSolverBase() [1/2]

TQpSolverBase::TQpSolverBase ( )

Default constructor.

Definition at line 62 of file TQpSolverBase.cxx.

◆ TQpSolverBase() [2/2]

TQpSolverBase::TQpSolverBase ( const TQpSolverBase another)

Copy constructor.

Definition at line 92 of file TQpSolverBase.cxx.

◆ ~TQpSolverBase()

TQpSolverBase::~TQpSolverBase ( )
virtual

Deconstructor.

Definition at line 101 of file TQpSolverBase.cxx.

Member Function Documentation

◆ DataNorm()

Double_t TQpSolverBase::DataNorm ( )
inline

Definition at line 160 of file TQpSolverBase.h.

◆ DefMonitor()

virtual void TQpSolverBase::DefMonitor ( 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 
)
pure virtual

Implemented in TGondzioSolver, and TMehrotraSolver.

◆ DefStart()

void TQpSolverBase::DefStart ( TQpProbBase formulation,
TQpVar iterate,
TQpDataBase prob,
TQpResidual resid,
TQpVar step 
)
virtual

Default starting point.

Definition at line 128 of file TQpSolverBase.cxx.

◆ DefStatus()

Int_t TQpSolverBase::DefStatus ( TQpDataBase data,
TQpVar vars,
TQpResidual resids,
Int_t  i,
Double_t  mu,
Int_t  level 
)
virtual

Default status method.

Definition at line 278 of file TQpSolverBase.cxx.

◆ DoMonitor()

void TQpSolverBase::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 
)
virtual

Monitor progress / convergence aat each interior-point iteration.

Definition at line 255 of file TQpSolverBase.cxx.

◆ DoStatus()

Int_t TQpSolverBase::DoStatus ( TQpDataBase data,
TQpVar vars,
TQpResidual resids,
Int_t  i,
Double_t  mu,
Int_t  level 
)
virtual

Tests for termination.

Unless the user supplies a specific termination routine, this method calls another method defaultStatus, which returns a code indicating the current convergence status.

Definition at line 268 of file TQpSolverBase.cxx.

◆ DumbStart()

void TQpSolverBase::DumbStart ( TQpProbBase formulation,
TQpVar iterate,
TQpDataBase prob,
TQpResidual resid,
TQpVar step 
)
virtual

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 .

Definition at line 202 of file TQpSolverBase.cxx.

◆ FinalStepLength()

Double_t TQpSolverBase::FinalStepLength ( TQpVar iterate,
TQpVar step 
)
virtual

Implements a version of Mehrotra starting point heuristic, modified to ensure identical steps in the primal and dual variables.

Definition at line 218 of file TQpSolverBase.cxx.

◆ GetArTol()

Double_t TQpSolverBase::GetArTol ( )
inline

Definition at line 159 of file TQpSolverBase.h.

◆ GetLinearSystem()

TQpLinSolverBase* TQpSolverBase::GetLinearSystem ( )
inline

Definition at line 154 of file TQpSolverBase.h.

◆ GetMuTol()

Double_t TQpSolverBase::GetMuTol ( )
inline

Definition at line 156 of file TQpSolverBase.h.

◆ operator=()

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

Assignment operator.

Definition at line 330 of file TQpSolverBase.cxx.

◆ SetArTol()

void TQpSolverBase::SetArTol ( Double_t  ar)
inline

Definition at line 158 of file TQpSolverBase.h.

◆ SetMuTol()

void TQpSolverBase::SetMuTol ( Double_t  m)
inline

Definition at line 155 of file TQpSolverBase.h.

◆ Solve()

virtual Int_t TQpSolverBase::Solve ( TQpDataBase prob,
TQpVar iterate,
TQpResidual resids 
)
pure virtual

Implemented in TGondzioSolver, and TMehrotraSolver.

◆ Start()

void TQpSolverBase::Start ( TQpProbBase formulation,
TQpVar iterate,
TQpDataBase prob,
TQpResidual resid,
TQpVar step 
)
virtual

Implements a default starting-point heuristic.

While interior-point theory places fairly loose restrictions on the choice of starting point, the choice of heuristic can significantly affect the robustness and efficiency of the algorithm.

Definition at line 118 of file TQpSolverBase.cxx.

◆ SteveStart()

void TQpSolverBase::SteveStart ( TQpProbBase formulation,
TQpVar iterate,
TQpDataBase prob,
TQpResidual resid,
TQpVar step 
)
virtual

Starting point algoritm according to Stephen Wright.

Definition at line 154 of file TQpSolverBase.cxx.

Member Data Documentation

◆ fArtol

Double_t TQpSolverBase::fArtol
protected

Definition at line 81 of file TQpSolverBase.h.

◆ fDnorm

Double_t TQpSolverBase::fDnorm
protected

Definition at line 78 of file TQpSolverBase.h.

◆ fGamma_a

Double_t TQpSolverBase::fGamma_a
protected

Definition at line 84 of file TQpSolverBase.h.

◆ fGamma_f

Double_t TQpSolverBase::fGamma_f
protected

Definition at line 83 of file TQpSolverBase.h.

◆ fIter

Int_t TQpSolverBase::fIter

Definition at line 97 of file TQpSolverBase.h.

◆ fMaxit

Int_t TQpSolverBase::fMaxit
protected

Definition at line 87 of file TQpSolverBase.h.

◆ fMu_history

Double_t* TQpSolverBase::fMu_history
protected

Definition at line 89 of file TQpSolverBase.h.

◆ fMutol

Double_t TQpSolverBase::fMutol
protected

Definition at line 80 of file TQpSolverBase.h.

◆ fPhi

Double_t TQpSolverBase::fPhi
protected

Definition at line 85 of file TQpSolverBase.h.

◆ fPhi_history

Double_t* TQpSolverBase::fPhi_history
protected

Definition at line 91 of file TQpSolverBase.h.

◆ fPhi_min_history

Double_t* TQpSolverBase::fPhi_min_history
protected

Definition at line 93 of file TQpSolverBase.h.

◆ fRnorm_history

Double_t* TQpSolverBase::fRnorm_history
protected

Definition at line 90 of file TQpSolverBase.h.

◆ fSys

TQpLinSolverBase* TQpSolverBase::fSys
protected

Definition at line 76 of file TQpSolverBase.h.

Libraries for TQpSolverBase:
[legend]

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