Class containing the variables for the general QP formulation.

In terms of in our abstract problem formulation, these variables are the vectors x, y, z and s.

Definition at line 59 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	{ 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 Member Functions
	TQpVar ()
	Default constructor.

	TQpVar (const TQpVar &another)
	Copy constructor.

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

	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.

	~TQpVar () override

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.

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)

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.

virtual Bool_t	IsInteriorPoint ()
	Is the current position an interior point ?

virtual Double_t	MuStep (TQpVar *step, Double_t alpha)
	Compute the complementarity gap resulting from a step of length "alpha" along direction "step".

virtual void	Negate ()
	Perform a "negate" operation on all data vectors : x = -x.

virtual Double_t	Norm1 ()
	Return the sum of the vector-norm1's.

virtual Double_t	NormInf ()
	Return the sum of the vector-normInf's.

TQpVar &	operator= (const TQpVar &source)
	Assignment operator.

void	Print (Option_t *option="") const override
	Print class members.

virtual void	Saxpy (TQpVar *b, Double_t alpha)
	Perform a "saxpy" operation on all data vectors : x += alpha*y.

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)

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.

virtual Bool_t	ValidNonZeroPattern ()
	Check that the variables conform to the non-zero indices.

virtual Double_t	Violation ()
	The amount by which the current variables violate the non-negativity constraints.

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.

virtual void	AppendPad (Option_t *option="")
	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 TObject *	Clone (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 TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

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

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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 TClass *	IsA () const

Bool_t	IsDestructed () const
	IsDestructed.

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 (the base implementation is no-op).

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, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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)

TObject &	operator= (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 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	Streamer (TBuffer &)
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

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

Public Attributes
TVectorD	fGamma

TVectorD	fLambda

Int_t	fNComplementaryVariables

TVectorD	fPhi

TVectorD	fPi

TVectorD	fS

TVectorD	fT

TVectorD	fU

TVectorD	fV

TVectorD	fW

TVectorD	fX

TVectorD	fY

TVectorD	fZ

Static Protected Member Functions
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.

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.

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.

Protected Attributes
TVectorD	fCloIndex

TVectorD	fCupIndex

Int_t	fMclo

Int_t	fMcup

Int_t	fMy

Int_t	fMz

Int_t	fNx

Int_t	fNxlo

Int_t	fNxup

TVectorD	fXloIndex

TVectorD	fXupIndex

Additional Inherited Members
Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_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 = (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).

void	MakeZombie ()

#include <TQpVar.h>

Inheritance diagram for TQpVar:

[legend]

Member Enumeration Documentation

◆ EVarBlock

enum TQpVar::EVarBlock

Enumerator
kno_block
kt_block
klambda_block
ku_block
kpi_block
kv_block
kgamma_block
kw_block
kphi_block

Definition at line 127 of file TQpVar.h.

Constructor & Destructor Documentation

◆ TQpVar() [1/4]

TQpVar::TQpVar ( )

Default constructor.

Definition at line 59 of file TQpVar.cxx.

◆ TQpVar() [2/4]

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 75 of file TQpVar.cxx.

◆ TQpVar() [3/4]

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

Constructor.

Definition at line 130 of file TQpVar.cxx.

◆ TQpVar() [4/4]

TQpVar::TQpVar ( const TQpVar & another )

Copy constructor.

Definition at line 181 of file TQpVar.cxx.

◆ ~TQpVar()

TQpVar::~TQpVar ( )

inlineoverride

Definition at line 120 of file TQpVar.h.

Member Function Documentation

◆ FindBlocking() [1/2]

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 414 of file TQpVar.cxx.

◆ FindBlocking() [2/2]

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 446 of file TQpVar.cxx.

◆ FindBlockingSub()

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 465 of file TQpVar.cxx.

◆ GetMu()

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 192 of file TQpVar.cxx.

◆ InteriorPoint()

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 534 of file TQpVar.cxx.

◆ IsInteriorPoint()

Bool_t TQpVar::IsInteriorPoint ( )

virtual

Is the current position an interior point ?

Definition at line 375 of file TQpVar.cxx.

◆ MuStep()

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 211 of file TQpVar.cxx.

◆ Negate()

void TQpVar::Negate ( )

virtual

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

Definition at line 272 of file TQpVar.cxx.

◆ Norm1()

Double_t TQpVar::Norm1 ( )

virtual

Return the sum of the vector-norm1's.

Definition at line 676 of file TQpVar.cxx.

◆ NormInf()

Double_t TQpVar::NormInf ( )

virtual

Return the sum of the vector-normInf's.

Definition at line 700 of file TQpVar.cxx.

◆ operator=()

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

Assignment operator.

Definition at line 772 of file TQpVar.cxx.

◆ Print()

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

overridevirtual

Print class members.

Reimplemented from TObject.

Definition at line 639 of file TQpVar.cxx.

◆ Saxpy()

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

virtual

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

Definition at line 232 of file TQpVar.cxx.

◆ ShiftBoundVariables()

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 615 of file TQpVar.cxx.

◆ StepBound() [1/2]

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 304 of file TQpVar.cxx.

◆ StepBound() [2/2]

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 348 of file TQpVar.cxx.

◆ ValidNonZeroPattern()

Bool_t TQpVar::ValidNonZeroPattern ( )

virtual

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

Definition at line 740 of file TQpVar.cxx.

◆ Violation()

Double_t TQpVar::Violation ( )

virtual

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

Definition at line 574 of file TQpVar.cxx.

Member Data Documentation

◆ fCloIndex

TVectorD TQpVar::fCloIndex

protected

Definition at line 75 of file TQpVar.h.

◆ fCupIndex

TVectorD TQpVar::fCupIndex

protected

Definition at line 74 of file TQpVar.h.

◆ fGamma

TVectorD TQpVar::fGamma

Definition at line 100 of file TQpVar.h.

◆ fLambda

TVectorD TQpVar::fLambda

Definition at line 103 of file TQpVar.h.

◆ fMclo

Int_t TQpVar::fMclo

protected

Definition at line 69 of file TQpVar.h.

◆ fMcup

Int_t TQpVar::fMcup

protected

Definition at line 68 of file TQpVar.h.

◆ fMy

Int_t TQpVar::fMy

protected

Definition at line 64 of file TQpVar.h.

◆ fMz

Int_t TQpVar::fMz

protected

Definition at line 65 of file TQpVar.h.

◆ fNComplementaryVariables

Int_t TQpVar::fNComplementaryVariables

Definition at line 88 of file TQpVar.h.

◆ fNx

Int_t TQpVar::fNx

protected

Definition at line 63 of file TQpVar.h.

◆ fNxlo

Int_t TQpVar::fNxlo

protected

Definition at line 67 of file TQpVar.h.

◆ fNxup

Int_t TQpVar::fNxup

protected

Definition at line 66 of file TQpVar.h.

◆ fPhi

TVectorD TQpVar::fPhi

Definition at line 97 of file TQpVar.h.

◆ fPi

TVectorD TQpVar::fPi

Definition at line 106 of file TQpVar.h.

◆ fS

TVectorD TQpVar::fS

Definition at line 92 of file TQpVar.h.

◆ fT

TVectorD TQpVar::fT

Definition at line 102 of file TQpVar.h.

◆ fU

TVectorD TQpVar::fU

Definition at line 105 of file TQpVar.h.

◆ fV

TVectorD TQpVar::fV

Definition at line 96 of file TQpVar.h.

◆ fW

TVectorD TQpVar::fW

Definition at line 99 of file TQpVar.h.

◆ fX

TVectorD TQpVar::fX

Definition at line 91 of file TQpVar.h.

◆ fXloIndex

TVectorD TQpVar::fXloIndex

protected

Definition at line 72 of file TQpVar.h.

◆ fXupIndex

TVectorD TQpVar::fXupIndex

protected

Definition at line 73 of file TQpVar.h.

◆ fY

TVectorD TQpVar::fY

Definition at line 93 of file TQpVar.h.

◆ fZ

TVectorD TQpVar::fZ

Definition at line 94 of file TQpVar.h.

Libraries for TQpVar:

[legend]

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

math/quadp/inc/TQpVar.h
math/quadp/src/TQpVar.cxx

Public Types

Public Member Functions

Public Attributes

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EVarBlock

Constructor & Destructor Documentation

◆ TQpVar() [1/4]

◆ TQpVar() [2/4]

◆ TQpVar() [3/4]

◆ TQpVar() [4/4]

◆ ~TQpVar()

Member Function Documentation

◆ FindBlocking() [1/2]

◆ FindBlocking() [2/2]

◆ FindBlockingSub()

◆ GetMu()

◆ InteriorPoint()

◆ IsInteriorPoint()

◆ MuStep()

◆ Negate()

◆ Norm1()

◆ NormInf()

◆ operator=()

◆ Print()

◆ Saxpy()

◆ ShiftBoundVariables()

◆ StepBound() [1/2]

◆ StepBound() [2/2]

◆ ValidNonZeroPattern()

◆ Violation()

Member Data Documentation

◆ fCloIndex

◆ fCupIndex

◆ fGamma

◆ fLambda

◆ fMclo

◆ fMcup

◆ fMy

◆ fMz

◆ fNComplementaryVariables

◆ fNx

◆ fNxlo

◆ fNxup

◆ fPhi

◆ fPi

◆ fS

◆ fT

◆ fU

◆ fV

◆ fW

◆ fX

◆ fXloIndex

◆ fXupIndex

◆ fY

◆ fZ