Logo ROOT  
Reference Guide
TMehrotraSolver Class Reference

Derived class of TQpSolverBase implementing the original Mehrotra predictor-corrector algorithm.

Definition at line 55 of file TMehrotraSolver.h.

Public Member Functions

 TMehrotraSolver ()
 Default constructor. More...
 
 TMehrotraSolver (const TMehrotraSolver &another)
 Copy constructor. More...
 
 TMehrotraSolver (TQpProbBase *of, TQpDataBase *prob, Int_t verbose=0)
 Constructor. More...
 
 ~TMehrotraSolver () override
 Deconstructor. More...
 
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. More...
 
TClassIsA () const override
 
TMehrotraSolveroperator= (const TMehrotraSolver &source)
 Assignment operator. More...
 
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 . More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TQpSolverBase
 TQpSolverBase ()
 Default constructor. More...
 
 TQpSolverBase (const TQpSolverBase &another)
 Copy constructor. More...
 
 ~TQpSolverBase () override
 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 ()
 
TClassIsA () const override
 
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...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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=nullptr)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 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 TClassIsA () const
 
Bool_t IsDestructed () const
 IsDestructed. More...
 
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...
 
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. 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 Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

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. 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 Attributes

TQpProbBasefFactory
 
Int_t fPrintlevel
 
TQpVarfStep
 
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). More...
 
void MakeZombie ()
 

#include <TMehrotraSolver.h>

Inheritance diagram for TMehrotraSolver:
[legend]

Constructor & Destructor Documentation

◆ TMehrotraSolver() [1/3]

TMehrotraSolver::TMehrotraSolver ( )

Default constructor.

Definition at line 61 of file TMehrotraSolver.cxx.

◆ TMehrotraSolver() [2/3]

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

Constructor.

Definition at line 73 of file TMehrotraSolver.cxx.

◆ TMehrotraSolver() [3/3]

TMehrotraSolver::TMehrotraSolver ( const TMehrotraSolver another)

Copy constructor.

Definition at line 86 of file TMehrotraSolver.cxx.

◆ ~TMehrotraSolver()

TMehrotraSolver::~TMehrotraSolver ( )
override

Deconstructor.

Definition at line 213 of file TMehrotraSolver.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 85 of file TMehrotraSolver.h.

◆ DeclFileName()

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

Definition at line 85 of file TMehrotraSolver.h.

◆ DefMonitor()

void TMehrotraSolver::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 171 of file TMehrotraSolver.cxx.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 85 of file TMehrotraSolver.h.

◆ operator=()

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

Assignment operator.

Definition at line 222 of file TMehrotraSolver.cxx.

◆ Solve()

Int_t TMehrotraSolver::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 97 of file TMehrotraSolver.cxx.

◆ Streamer()

void TMehrotraSolver::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMehrotraSolver::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 85 of file TMehrotraSolver.h.

Member Data Documentation

◆ fFactory

TQpProbBase* TMehrotraSolver::fFactory
protected

Definition at line 68 of file TMehrotraSolver.h.

◆ fPrintlevel

Int_t TMehrotraSolver::fPrintlevel
protected

Definition at line 59 of file TMehrotraSolver.h.

◆ fStep

TQpVar* TMehrotraSolver::fStep
protected

Definition at line 66 of file TMehrotraSolver.h.

◆ fTsig

Double_t TMehrotraSolver::fTsig
protected

Definition at line 61 of file TMehrotraSolver.h.

Libraries for TMehrotraSolver:
[legend]

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