ROOT   Reference Guide
Searching...
No Matches
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.

TQpResidual (const TQpResidual &another)
Copy constructor.

TQpResidual (Int_t nx, Int_t my, Int_t mz, TVectorD &ixlow, TVectorD &ixupp, TVectorD &iclow, TVectorD &icupp)
Constructor.

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.

void CalcResids (TQpDataBase *problem, TQpVar *vars)
Calculate residuals, their norms, and duality complementarity gap, given a problem and variable set.

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

void Clear_r3 ()
set the complementarity component of the residuals to 0.

Double_t GetDualityGap ()

Double_t GetResidualNorm ()

TQpResidualoperator= (const TQpResidual &source)
Assignment operator.

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

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 .

Bool_t ValidNonZeroPattern ()
Check if vector elements as selected through array indices are non-zero.

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.

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 for instance with: gROOT->SetSelectedPad(gPad).

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=0)
Execute method on this object with the given parameter string, e.g.

virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
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)

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.

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)
Operator delete [].

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.

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.

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=0, Int_t option=0, Int_t bufsize=0)
Write this object to the current directory.

virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
Write this object to the current directory.

## 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].

## 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

Public Types inherited from TObject
enum  {
kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
}

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.

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 Types inherited from TObject
enum  { kOnlyPrepStep = BIT(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 <TQpResidual.h>

Inheritance diagram for TQpResidual:
[legend]

## ◆ 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 106 of file TQpResidual.h.

## Member Function Documentation

 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 109 of file TQpResidual.h.

## ◆ GetResidualNorm()

 Double_t TQpResidual::GetResidualNorm ( )
inline

Definition at line 108 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.

## ◆ fCloIndex

 TVectorD TQpResidual::fCloIndex
protected

Definition at line 83 of file TQpResidual.h.

## ◆ fCupIndex

 TVectorD TQpResidual::fCupIndex
protected

Definition at line 82 of file TQpResidual.h.

## ◆ fDualityGap

 Double_t TQpResidual::fDualityGap
protected

Definition at line 66 of file TQpResidual.h.

## ◆ fMclo

 Double_t TQpResidual::fMclo
protected

Definition at line 77 of file TQpResidual.h.

## ◆ fMcup

 Double_t TQpResidual::fMcup
protected

Definition at line 76 of file TQpResidual.h.

## ◆ fMy

 Int_t TQpResidual::fMy
protected

Definition at line 71 of file TQpResidual.h.

## ◆ fMz

 Int_t TQpResidual::fMz
protected

Definition at line 72 of file TQpResidual.h.

## ◆ fNx

 Int_t TQpResidual::fNx
protected

Definition at line 70 of file TQpResidual.h.

## ◆ fNxlo

 Double_t TQpResidual::fNxlo
protected

Definition at line 75 of file TQpResidual.h.

## ◆ fNxup

 Double_t TQpResidual::fNxup
protected

Definition at line 74 of file TQpResidual.h.

## ◆ fRA

 TVectorD TQpResidual::fRA

Definition at line 89 of file TQpResidual.h.

## ◆ fRC

 TVectorD TQpResidual::fRC

Definition at line 90 of file TQpResidual.h.

## ◆ fResidualNorm

 Double_t TQpResidual::fResidualNorm
protected

Definition at line 65 of file TQpResidual.h.

## ◆ fRgamma

 TVectorD TQpResidual::fRgamma

Definition at line 96 of file TQpResidual.h.

## ◆ fRlambda

 TVectorD TQpResidual::fRlambda

Definition at line 98 of file TQpResidual.h.

## ◆ fRphi

 TVectorD TQpResidual::fRphi

Definition at line 97 of file TQpResidual.h.

## ◆ fRpi

 TVectorD TQpResidual::fRpi

Definition at line 99 of file TQpResidual.h.

## ◆ fRQ

 TVectorD TQpResidual::fRQ

Definition at line 88 of file TQpResidual.h.

## ◆ fRt

 TVectorD TQpResidual::fRt

Definition at line 94 of file TQpResidual.h.

## ◆ fRu

 TVectorD TQpResidual::fRu

Definition at line 95 of file TQpResidual.h.

## ◆ fRv

 TVectorD TQpResidual::fRv

Definition at line 92 of file TQpResidual.h.

## ◆ fRw

 TVectorD TQpResidual::fRw

Definition at line 93 of file TQpResidual.h.

## ◆ fRz

 TVectorD TQpResidual::fRz

Definition at line 91 of file TQpResidual.h.

## ◆ fXloIndex

 TVectorD TQpResidual::fXloIndex
protected

Definition at line 81 of file TQpResidual.h.

## ◆ fXupIndex

 TVectorD TQpResidual::fXupIndex
protected

Definition at line 80 of file TQpResidual.h.

Libraries for TQpResidual:

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