Logo ROOT  
Reference Guide
TQpResidual Class Reference

The Residuals class calculates and stores the quantities that appear on the right-hand side of the linear systems that arise at each interior-point iteration. These residuals can be partitioned into two fundamental categories: the components arising from the linear equations in the KKT conditions, and the components arising from the complementarity conditions.

Definition at line 61 of file TQpResidual.h.

Public Member Functions

 TQpResidual ()
 Constructor. More...
 
 TQpResidual (const TQpResidual &another)
 Copy constructor. More...
 
 TQpResidual (Int_t nx, Int_t my, Int_t mz, TVectorD &ixlow, TVectorD &ixupp, TVectorD &iclow, TVectorD &icupp)
 Constructor. More...
 
virtual ~TQpResidual ()
 
void Add_r3_xz_alpha (TQpVar *vars, Double_t alpha)
 Modify the "complementarity" component of the residuals, by adding the pairwise products of the complementary variables plus a constant alpha to this term. More...
 
void CalcResids (TQpDataBase *problem, TQpVar *vars)
 Calculate residuals, their norms, and duality complementarity gap, given a problem and variable set. More...
 
void Clear_r1r2 ()
 set the noncomplementarity components of the residual (the terms arising from the linear equalities in the KKT conditions) to 0. More...
 
void Clear_r3 ()
 set the complementarity component of the residuals to 0. More...
 
Double_t GetDualityGap ()
 
Double_t GetResidualNorm ()
 
TQpResidualoperator= (const TQpResidual &source)
 Assignment operator. More...
 
void Project_r3 (Double_t rmin, Double_t rmax)
 Perform the projection operation required by Gondzio algorithm: replace each component r3_i of the complementarity component of the residuals by r3p_i-r3_i, where r3p_i is the projection of r3_i onto the box [rmin, rmax]. More...
 
void Set_r3_xz_alpha (TQpVar *vars, Double_t alpha)
 Set the "complementarity" component of the residuals to the pairwise products of the complementary variables plus a constant alpha . More...
 
Bool_t ValidNonZeroPattern ()
 Check if vector elements as selected through array indices are non-zero. 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

TVectorD fRA
 
TVectorD fRC
 
TVectorD fRgamma
 
TVectorD fRlambda
 
TVectorD fRphi
 
TVectorD fRpi
 
TVectorD fRQ
 
TVectorD fRt
 
TVectorD fRu
 
TVectorD fRv
 
TVectorD fRw
 
TVectorD fRz
 

Static Protected Member Functions

static void GondzioProjection (TVectorD &v, Double_t rmin, Double_t rmax)
 Replace each component r3_i of the complementarity component of the residuals by r3p_i-r3_i, where r3p_i is the projection of r3_i onto the box [rmin, rmax]. More...
 

Protected Attributes

TVectorD fCloIndex
 
TVectorD fCupIndex
 
Double_t fDualityGap
 
Double_t fMclo
 
Double_t fMcup
 
Int_t fMy
 
Int_t fMz
 
Int_t fNx
 
Double_t fNxlo
 
Double_t fNxup
 
Double_t fResidualNorm
 
TVectorD fXloIndex
 
TVectorD fXupIndex
 

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 <TQpResidual.h>

Inheritance diagram for TQpResidual:
[legend]

Constructor & Destructor Documentation

◆ TQpResidual() [1/3]

TQpResidual::TQpResidual ( )

Constructor.

Definition at line 63 of file TQpResidual.cxx.

◆ TQpResidual() [2/3]

TQpResidual::TQpResidual ( Int_t  nx,
Int_t  my,
Int_t  mz,
TVectorD ixlow,
TVectorD ixupp,
TVectorD iclow,
TVectorD icupp 
)

Constructor.

Definition at line 81 of file TQpResidual.cxx.

◆ TQpResidual() [3/3]

TQpResidual::TQpResidual ( const TQpResidual another)

Copy constructor.

Definition at line 127 of file TQpResidual.cxx.

◆ ~TQpResidual()

virtual TQpResidual::~TQpResidual ( )
inlinevirtual

Definition at line 141 of file TQpResidual.h.

Member Function Documentation

◆ Add_r3_xz_alpha()

void TQpResidual::Add_r3_xz_alpha ( TQpVar vars,
Double_t  alpha 
)

Modify the "complementarity" component of the residuals, by adding the pairwise products of the complementary variables plus a constant alpha to this term.

Definition at line 237 of file TQpResidual.cxx.

◆ CalcResids()

void TQpResidual::CalcResids ( TQpDataBase problem,
TQpVar vars 
)

Calculate residuals, their norms, and duality complementarity gap, given a problem and variable set.

Definition at line 137 of file TQpResidual.cxx.

◆ Clear_r1r2()

void TQpResidual::Clear_r1r2 ( )

set the noncomplementarity components of the residual (the terms arising from the linear equalities in the KKT conditions) to 0.

Definition at line 280 of file TQpResidual.cxx.

◆ Clear_r3()

void TQpResidual::Clear_r3 ( )

set the complementarity component of the residuals to 0.

Definition at line 267 of file TQpResidual.cxx.

◆ GetDualityGap()

Double_t TQpResidual::GetDualityGap ( )
inline

Definition at line 144 of file TQpResidual.h.

◆ GetResidualNorm()

Double_t TQpResidual::GetResidualNorm ( )
inline

Definition at line 143 of file TQpResidual.h.

◆ GondzioProjection()

void TQpResidual::GondzioProjection ( TVectorD v,
Double_t  rmin,
Double_t  rmax 
)
staticprotected

Replace each component r3_i of the complementarity component of the residuals by r3p_i-r3_i, where r3p_i is the projection of r3_i onto the box [rmin, rmax].

Then if the resulting value is less than -rmax, replace it by -rmax.

Definition at line 357 of file TQpResidual.cxx.

◆ operator=()

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

Assignment operator.

Definition at line 378 of file TQpResidual.cxx.

◆ Project_r3()

void TQpResidual::Project_r3 ( Double_t  rmin,
Double_t  rmax 
)

Perform the projection operation required by Gondzio algorithm: replace each component r3_i of the complementarity component of the residuals by r3p_i-r3_i, where r3p_i is the projection of r3_i onto the box [rmin, rmax].

Then if the resulting value is less than -rmax, replace it by -rmax.

Definition at line 299 of file TQpResidual.cxx.

◆ Set_r3_xz_alpha()

void TQpResidual::Set_r3_xz_alpha ( TQpVar vars,
Double_t  alpha 
)

Set the "complementarity" component of the residuals to the pairwise products of the complementary variables plus a constant alpha .

Definition at line 257 of file TQpResidual.cxx.

◆ ValidNonZeroPattern()

Bool_t TQpResidual::ValidNonZeroPattern ( )

Check if vector elements as selected through array indices are non-zero.

Definition at line 323 of file TQpResidual.cxx.

Member Data Documentation

◆ fCloIndex

TVectorD TQpResidual::fCloIndex
protected

Definition at line 118 of file TQpResidual.h.

◆ fCupIndex

TVectorD TQpResidual::fCupIndex
protected

Definition at line 117 of file TQpResidual.h.

◆ fDualityGap

Double_t TQpResidual::fDualityGap
protected

Definition at line 101 of file TQpResidual.h.

◆ fMclo

Double_t TQpResidual::fMclo
protected

Definition at line 112 of file TQpResidual.h.

◆ fMcup

Double_t TQpResidual::fMcup
protected

Definition at line 111 of file TQpResidual.h.

◆ fMy

Int_t TQpResidual::fMy
protected

Definition at line 106 of file TQpResidual.h.

◆ fMz

Int_t TQpResidual::fMz
protected

Definition at line 107 of file TQpResidual.h.

◆ fNx

Int_t TQpResidual::fNx
protected

Definition at line 105 of file TQpResidual.h.

◆ fNxlo

Double_t TQpResidual::fNxlo
protected

Definition at line 110 of file TQpResidual.h.

◆ fNxup

Double_t TQpResidual::fNxup
protected

Definition at line 109 of file TQpResidual.h.

◆ fRA

TVectorD TQpResidual::fRA

Definition at line 124 of file TQpResidual.h.

◆ fRC

TVectorD TQpResidual::fRC

Definition at line 125 of file TQpResidual.h.

◆ fResidualNorm

Double_t TQpResidual::fResidualNorm
protected

Definition at line 100 of file TQpResidual.h.

◆ fRgamma

TVectorD TQpResidual::fRgamma

Definition at line 131 of file TQpResidual.h.

◆ fRlambda

TVectorD TQpResidual::fRlambda

Definition at line 133 of file TQpResidual.h.

◆ fRphi

TVectorD TQpResidual::fRphi

Definition at line 132 of file TQpResidual.h.

◆ fRpi

TVectorD TQpResidual::fRpi

Definition at line 134 of file TQpResidual.h.

◆ fRQ

TVectorD TQpResidual::fRQ

Definition at line 123 of file TQpResidual.h.

◆ fRt

TVectorD TQpResidual::fRt

Definition at line 129 of file TQpResidual.h.

◆ fRu

TVectorD TQpResidual::fRu

Definition at line 130 of file TQpResidual.h.

◆ fRv

TVectorD TQpResidual::fRv

Definition at line 127 of file TQpResidual.h.

◆ fRw

TVectorD TQpResidual::fRw

Definition at line 128 of file TQpResidual.h.

◆ fRz

TVectorD TQpResidual::fRz

Definition at line 126 of file TQpResidual.h.

◆ fXloIndex

TVectorD TQpResidual::fXloIndex
protected

Definition at line 116 of file TQpResidual.h.

◆ fXupIndex

TVectorD TQpResidual::fXupIndex
protected

Definition at line 115 of file TQpResidual.h.

Libraries for TQpResidual:
[legend]

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