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

Definition at line 65 of file TQpVar.h.

Public Types

enum  EVarBlock {
  kno_block, kt_block, klambda_block, ku_block,
  kpi_block, kv_block, kgamma_block, kw_block,
  kphi_block
}
 
- 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) }
 

Public Member Functions

 TQpVar ()
 
 TQpVar (TVectorD &x_in, TVectorD &s_in, TVectorD &y_in, TVectorD &z_in, TVectorD &v_in, TVectorD &gamma_in, TVectorD &w_in, TVectorD &phi_in, TVectorD &t_in, TVectorD &lambda_in, TVectorD &u_in, TVectorD &pi_in, TVectorD &ixlow_in, TVectorD &ixupp_in, TVectorD &iclow_in, TVectorD &icupp_in)
 Constructor. More...
 
 TQpVar (Int_t nx, Int_t my, Int_t mz, TVectorD &ixlow, TVectorD &ixupp, TVectorD &iclow, TVectorD &icupp)
 Constructor. More...
 
 TQpVar (const TQpVar &another)
 Copy constructor. More...
 
virtual ~TQpVar ()
 
virtual Double_t GetMu ()
 compute complementarity gap, obtained by taking the inner product of the complementary vectors and dividing by the total number of components computes mu = (t'lambda +u'pi + v'gamma + w'phi)/(mclow+mcupp+nxlow+nxupp) More...
 
virtual Double_t MuStep (TQpVar *step, Double_t alpha)
 Compute the complementarity gap resulting from a step of length "alpha" along direction "step". More...
 
virtual void Saxpy (TQpVar *b, Double_t alpha)
 Perform a "saxpy" operation on all data vectors : x += alpha*y. More...
 
virtual void Negate ()
 Perform a "negate" operation on all data vectors : x = -x. More...
 
virtual Double_t StepBound (TQpVar *b)
 calculate the largest alpha in (0,1] such that the/ nonnegative variables stay nonnegative in the given search direction. More...
 
virtual Double_t FindBlocking (TQpVar *step, Double_t &primalValue, Double_t &primalStep, Double_t &dualValue, Double_t &dualStep, Int_t &firstOrSecond)
 Performs the same function as StepBound, and supplies additional information about which component of the nonnegative variables is responsible for restricting alpha. More...
 
virtual void InteriorPoint (Double_t alpha, Double_t beta)
 Sets components of (u,t,v,w) to alpha and of (lambda,pi,phi,gamma) to beta. More...
 
virtual void ShiftBoundVariables (Double_t alpha, Double_t beta)
 Add alpha to components of (u,t,v,w) and beta to components of (lambda,pi,phi,gamma) More...
 
virtual Bool_t IsInteriorPoint ()
 Is the current position an interior point ? More...
 
virtual Double_t Violation ()
 The amount by which the current variables violate the non-negativity constraints. More...
 
virtual void Print (Option_t *option="") const
 Print class members. More...
 
virtual Double_t Norm1 ()
 Return the sum of the vector-norm1's. More...
 
virtual Double_t NormInf ()
 Return the sum of the vector-normInf's. More...
 
virtual Bool_t ValidNonZeroPattern ()
 Check that the variables conform to the non-zero indices. More...
 
TQpVaroperator= (const TQpVar &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 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

Int_t fNComplementaryVariables
 
TVectorD fX
 
TVectorD fS
 
TVectorD fY
 
TVectorD fZ
 
TVectorD fV
 
TVectorD fPhi
 
TVectorD fW
 
TVectorD fGamma
 
TVectorD fT
 
TVectorD fLambda
 
TVectorD fU
 
TVectorD fPi
 

Static Protected Member Functions

static Double_t StepBound (TVectorD &v, TVectorD &dir, Double_t maxStep)
 Find the maximum stepsize of v in direction dir before violating the nonnegativity constraints. More...
 
static Double_t FindBlocking (TVectorD &w, TVectorD &wstep, TVectorD &u, TVectorD &ustep, Double_t maxStep, Double_t &w_elt, Double_t &wstep_elt, Double_t &u_elt, Double_t &ustep_elt, int &first_or_second)
 See other FindBlocking function. More...
 
static Double_t FindBlockingSub (Int_t n, Double_t *w, Int_t incw, Double_t *wstep, Int_t incwstep, Double_t *u, Int_t incu, Double_t *ustep, Int_t incustep, Double_t maxStep, Double_t &w_elt, Double_t &wstep_elt, Double_t &u_elt, Double_t &ustep_elt, Int_t &first_or_second)
 See FindBlocking function. More...
 

Protected Attributes

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

Additional Inherited Members

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

+ Inheritance diagram for TQpVar:
+ Collaboration diagram for TQpVar:

Member Enumeration Documentation

Enumerator
kno_block 
kt_block 
klambda_block 
ku_block 
kpi_block 
kv_block 
kgamma_block 
kw_block 
kphi_block 

Definition at line 133 of file TQpVar.h.

Constructor & Destructor Documentation

TQpVar::TQpVar ( )
TQpVar::TQpVar ( TVectorD x_in,
TVectorD s_in,
TVectorD y_in,
TVectorD z_in,
TVectorD v_in,
TVectorD gamma_in,
TVectorD w_in,
TVectorD phi_in,
TVectorD t_in,
TVectorD lambda_in,
TVectorD u_in,
TVectorD pi_in,
TVectorD ixlow_in,
TVectorD ixupp_in,
TVectorD iclow_in,
TVectorD icupp_in 
)

Constructor.

Definition at line 74 of file TQpVar.cxx.

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

Constructor.

Definition at line 129 of file TQpVar.cxx.

TQpVar::TQpVar ( const TQpVar another)

Copy constructor.

Definition at line 180 of file TQpVar.cxx.

virtual TQpVar::~TQpVar ( )
inlinevirtual

Definition at line 126 of file TQpVar.h.

Member Function Documentation

Double_t TQpVar::FindBlocking ( TVectorD w,
TVectorD wstep,
TVectorD u,
TVectorD ustep,
Double_t  maxStep,
Double_t w_elt,
Double_t wstep_elt,
Double_t u_elt,
Double_t ustep_elt,
int &  first_or_second 
)
staticprotected

See other FindBlocking function.

Definition at line 445 of file TQpVar.cxx.

Referenced by TQpSolverBase::FinalStepLength(), and FindBlocking().

Double_t TQpVar::FindBlocking ( TQpVar step,
Double_t primalValue,
Double_t primalStep,
Double_t dualValue,
Double_t dualStep,
Int_t fIrstOrSecond 
)
virtual

Performs the same function as StepBound, and supplies additional information about which component of the nonnegative variables is responsible for restricting alpha.

In terms of the abstract formulation, the components have the following meanings :

primalValue : the value of the blocking component of the primal variables (u,t,v,w). primalStep : the corresponding value of the blocking component of the primal step variables (b->u,b->t,b->v,b->w) dualValue : the value of the blocking component of the dual variables/ (lambda,pi,phi,gamma). dualStep : the corresponding value of the blocking component of the dual step variables (b->lambda,b->pi,b->phi,b->gamma) firstOrSecond : 1 if the primal step is blocking, 2 if the dual step is block, 0 if no step is blocking.

Definition at line 413 of file TQpVar.cxx.

Double_t TQpVar::FindBlockingSub ( Int_t  n,
Double_t w,
Int_t  incw,
Double_t wstep,
Int_t  incwstep,
Double_t u,
Int_t  incu,
Double_t ustep,
Int_t  incustep,
Double_t  maxStep,
Double_t w_elt,
Double_t wstep_elt,
Double_t u_elt,
Double_t ustep_elt,
Int_t first_or_second 
)
staticprotected

See FindBlocking function.

Definition at line 464 of file TQpVar.cxx.

Referenced by FindBlocking().

Double_t TQpVar::GetMu ( )
virtual

compute complementarity gap, obtained by taking the inner product of the complementary vectors and dividing by the total number of components computes mu = (t'lambda +u'pi + v'gamma + w'phi)/(mclow+mcupp+nxlow+nxupp)

Definition at line 191 of file TQpVar.cxx.

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

void TQpVar::InteriorPoint ( Double_t  alpha,
Double_t  beta 
)
virtual

Sets components of (u,t,v,w) to alpha and of (lambda,pi,phi,gamma) to beta.

Definition at line 533 of file TQpVar.cxx.

Referenced by TQpSolverBase::DefStart(), TQpSolverBase::DumbStart(), and TQpSolverBase::SteveStart().

Bool_t TQpVar::IsInteriorPoint ( )
virtual

Is the current position an interior point ?

Definition at line 374 of file TQpVar.cxx.

Double_t TQpVar::MuStep ( TQpVar step,
Double_t  alpha 
)
virtual

Compute the complementarity gap resulting from a step of length "alpha" along direction "step".

Definition at line 210 of file TQpVar.cxx.

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

void TQpVar::Negate ( )
virtual

Perform a "negate" operation on all data vectors : x = -x.

Definition at line 271 of file TQpVar.cxx.

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

Double_t TQpVar::Norm1 ( )
virtual

Return the sum of the vector-norm1's.

Definition at line 675 of file TQpVar.cxx.

Referenced by TQpSolverBase::SteveStart().

Double_t TQpVar::NormInf ( )
virtual

Return the sum of the vector-normInf's.

Definition at line 699 of file TQpVar.cxx.

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

Assignment operator.

Definition at line 771 of file TQpVar.cxx.

void TQpVar::Print ( Option_t option = "") const
virtual

Print class members.

Reimplemented from TObject.

Definition at line 638 of file TQpVar.cxx.

void TQpVar::Saxpy ( TQpVar b,
Double_t  alpha 
)
virtual

Perform a "saxpy" operation on all data vectors : x += alpha*y.

Definition at line 231 of file TQpVar.cxx.

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

void TQpVar::ShiftBoundVariables ( Double_t  alpha,
Double_t  beta 
)
virtual

Add alpha to components of (u,t,v,w) and beta to components of (lambda,pi,phi,gamma)

Definition at line 614 of file TQpVar.cxx.

Referenced by TQpSolverBase::DefStart(), and TQpSolverBase::SteveStart().

Double_t TQpVar::StepBound ( TVectorD v,
TVectorD dir,
Double_t  maxStep 
)
staticprotected

Find the maximum stepsize of v in direction dir before violating the nonnegativity constraints.

Definition at line 347 of file TQpVar.cxx.

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

Double_t TQpVar::StepBound ( TQpVar b)
virtual

calculate the largest alpha in (0,1] such that the/ nonnegative variables stay nonnegative in the given search direction.

In the general QP problem formulation this is the largest value of alpha such that (t,u,v,w,lambda,pi,phi,gamma) + alpha * (b->t,b->u,b->v,b->w,b->lambda,b->pi, b->phi,b->gamma) >= 0.

Definition at line 303 of file TQpVar.cxx.

Bool_t TQpVar::ValidNonZeroPattern ( )
virtual

Check that the variables conform to the non-zero indices.

Definition at line 739 of file TQpVar.cxx.

Referenced by TQpLinSolverBase::Factor(), and TQpLinSolverBase::Solve().

Double_t TQpVar::Violation ( )
virtual

The amount by which the current variables violate the non-negativity constraints.

Definition at line 573 of file TQpVar.cxx.

Referenced by TQpSolverBase::DefStart(), and TQpSolverBase::SteveStart().

Member Data Documentation

TVectorD TQpVar::fCloIndex
protected
TVectorD TQpVar::fCupIndex
protected
TVectorD TQpVar::fGamma
TVectorD TQpVar::fLambda
Int_t TQpVar::fMclo
protected
Int_t TQpVar::fMcup
protected
Int_t TQpVar::fMy
protected

Definition at line 70 of file TQpVar.h.

Referenced by operator=(), Print(), and TQpVar().

Int_t TQpVar::fMz
protected

Definition at line 71 of file TQpVar.h.

Referenced by operator=(), Print(), and TQpVar().

Int_t TQpVar::fNComplementaryVariables

Definition at line 94 of file TQpVar.h.

Referenced by GetMu(), MuStep(), operator=(), TQpSolverBase::SteveStart(), and TQpVar().

Int_t TQpVar::fNx
protected

Definition at line 69 of file TQpVar.h.

Referenced by operator=(), Print(), and TQpVar().

Int_t TQpVar::fNxlo
protected
Int_t TQpVar::fNxup
protected
TVectorD TQpVar::fPhi
TVectorD TQpVar::fPi
TVectorD TQpVar::fS
TVectorD TQpVar::fT
TVectorD TQpVar::fU
TVectorD TQpVar::fV
TVectorD TQpVar::fW
TVectorD TQpVar::fX
TVectorD TQpVar::fXloIndex
protected
TVectorD TQpVar::fXupIndex
protected
TVectorD TQpVar::fY
TVectorD TQpVar::fZ

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