ROOT  6.06/09
Reference Guide
Public Member Functions | Public Attributes | Static Protected Member Functions | Protected Attributes | List of all members
TQpResidual Class Reference

Definition at line 69 of file TQpResidual.h.

Public Member Functions

 TQpResidual ()
 
 TQpResidual (Int_t nx, Int_t my, Int_t mz, TVectorD &ixlow, TVectorD &ixupp, TVectorD &iclow, TVectorD &icupp)
 Constructor. More...
 
 TQpResidual (const TQpResidual &another)
 Copy constructor. More...
 
virtual ~TQpResidual ()
 
Double_t GetResidualNorm ()
 
Double_t GetDualityGap ()
 
void CalcResids (TQpDataBase *problem, TQpVar *vars)
 Calculate residuals, their norms, and duality complementarity gap, given a problem and variable set. More...
 
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 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...
 
void Clear_r3 ()
 set the complementarity component of the residuals to 0. 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 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...
 
Bool_t ValidNonZeroPattern ()
 Check if vector elements as selected through array indices are non-zero. More...
 
TQpResidualoperator= (const TQpResidual &source)
 Assignment operator. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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 pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. 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...
 
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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). 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 IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Public Attributes

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

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

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

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

#include <TQpResidual.h>

+ Inheritance diagram for TQpResidual:
+ Collaboration diagram for TQpResidual:

Constructor & Destructor Documentation

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

Constructor.

Definition at line 83 of file TQpResidual.cxx.

TQpResidual::TQpResidual ( const TQpResidual another)

Copy constructor.

Definition at line 129 of file TQpResidual.cxx.

virtual TQpResidual::~TQpResidual ( )
inlinevirtual

Definition at line 114 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 239 of file TQpResidual.cxx.

Referenced by Set_r3_xz_alpha(), TMehrotraSolver::Solve(), and TGondzioSolver::Solve().

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

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

Definition at line 139 of file TQpResidual.cxx.

Referenced by TQpSolverBase::DefStart(), TMehrotraSolver::Solve(), TGondzioSolver::Solve(), and TQpSolverBase::SteveStart().

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 282 of file TQpResidual.cxx.

Referenced by TGondzioSolver::Solve().

void TQpResidual::Clear_r3 ( )

set the complementarity component of the residuals to 0.

Definition at line 269 of file TQpResidual.cxx.

Referenced by Set_r3_xz_alpha().

Double_t TQpResidual::GetDualityGap ( )
inline
Double_t TQpResidual::GetResidualNorm ( )
inline
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 359 of file TQpResidual.cxx.

Referenced by Project_r3().

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

Assignment operator.

Definition at line 380 of file TQpResidual.cxx.

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 301 of file TQpResidual.cxx.

Referenced by TGondzioSolver::Solve().

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 259 of file TQpResidual.cxx.

Referenced by TQpSolverBase::DefStart(), TMehrotraSolver::Solve(), TGondzioSolver::Solve(), and TQpSolverBase::SteveStart().

Bool_t TQpResidual::ValidNonZeroPattern ( )

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

Definition at line 325 of file TQpResidual.cxx.

Member Data Documentation

TVectorD TQpResidual::fCloIndex
protected
TVectorD TQpResidual::fCupIndex
protected
Double_t TQpResidual::fDualityGap
protected

Definition at line 74 of file TQpResidual.h.

Referenced by CalcResids(), GetDualityGap(), operator=(), and TQpResidual().

Double_t TQpResidual::fMclo
protected
Double_t TQpResidual::fMcup
protected
Int_t TQpResidual::fMy
protected

Definition at line 79 of file TQpResidual.h.

Referenced by operator=(), and TQpResidual().

Int_t TQpResidual::fMz
protected

Definition at line 80 of file TQpResidual.h.

Referenced by operator=(), and TQpResidual().

Int_t TQpResidual::fNx
protected

Definition at line 78 of file TQpResidual.h.

Referenced by operator=(), and TQpResidual().

Double_t TQpResidual::fNxlo
protected
Double_t TQpResidual::fNxup
protected
TVectorD TQpResidual::fRA

Definition at line 97 of file TQpResidual.h.

Referenced by CalcResids(), Clear_r1r2(), operator=(), TQpLinSolverBase::Solve(), and TQpResidual().

TVectorD TQpResidual::fRC

Definition at line 98 of file TQpResidual.h.

Referenced by CalcResids(), Clear_r1r2(), operator=(), TQpLinSolverBase::Solve(), and TQpResidual().

Double_t TQpResidual::fResidualNorm
protected

Definition at line 73 of file TQpResidual.h.

Referenced by CalcResids(), GetResidualNorm(), operator=(), and TQpResidual().

TVectorD TQpResidual::fRgamma
TVectorD TQpResidual::fRlambda
TVectorD TQpResidual::fRphi
TVectorD TQpResidual::fRpi
TVectorD TQpResidual::fRQ

Definition at line 96 of file TQpResidual.h.

Referenced by CalcResids(), Clear_r1r2(), operator=(), TQpLinSolverBase::Solve(), and TQpResidual().

TVectorD TQpResidual::fRt
TVectorD TQpResidual::fRu
TVectorD TQpResidual::fRv
TVectorD TQpResidual::fRw
TVectorD TQpResidual::fRz

Definition at line 99 of file TQpResidual.h.

Referenced by CalcResids(), Clear_r1r2(), operator=(), TQpLinSolverBase::Solve(), and TQpResidual().

TVectorD TQpResidual::fXloIndex
protected
TVectorD TQpResidual::fXupIndex
protected

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