Specialized CompoundVector class specifically for the algorithm iterates. More...

#include <IpIteratesVector.hpp>

Inheritance diagram for Ipopt::IteratesVector:

Public Member Functions

	IteratesVector (const IteratesVectorSpace *owner_space, bool create_new)
	Constructors / Destructors.


SmartPtr< IteratesVector >	MakeNewIteratesVector (bool create_new=true) const
	Make New methods.

SmartPtr< IteratesVector >	MakeNewIteratesVectorCopy () const
	Use this method to create a new iterates vector with a copy of all the data.

SmartPtr< IteratesVector >	MakeNewContainer () const
	Use this method to create a new iterates vector container.


SmartPtr< const Vector >	x () const
	Iterates Set/Get Methods.

SmartPtr< Vector >	x_NonConst ()
	Get the x iterate (non-const) - this can only be called if the vector was created internally, or the Set_x_NonConst method was used.

SmartPtr< Vector >	create_new_x ()
	Create a new vector in the x entry.

SmartPtr< Vector >	create_new_x_copy ()
	Create a new vector in the x entry and copy the current values into it.

void	Set_x (const Vector &vec)
	Set the x iterate (const).

void	Set_x_NonConst (Vector &vec)
	Set the x iterate (non-const).

SmartPtr< const Vector >	s () const
	Get the s iterate (const)

SmartPtr< Vector >	s_NonConst ()
	Get the s iterate (non-const) - this can only be called if the vector was created internally, or the Set_s_NonConst method was used.

SmartPtr< Vector >	create_new_s ()
	Create a new vector in the s entry.

SmartPtr< Vector >	create_new_s_copy ()
	Create a new vector in the s entry and copy the current values into it.

void	Set_s (const Vector &vec)
	Set the s iterate (const).

void	Set_s_NonConst (Vector &vec)
	Set the s iterate (non-const).

SmartPtr< const Vector >	y_c () const
	Get the y_c iterate (const)

SmartPtr< Vector >	y_c_NonConst ()
	Get the y_c iterate (non-const) - this can only be called if the vector was created internally, or the Set_y_c_NonConst method was used.

SmartPtr< Vector >	create_new_y_c ()
	Create a new vector in the y_c entry.

SmartPtr< Vector >	create_new_y_c_copy ()
	Create a new vector in the y_c entry and copy the current values into it.

void	Set_y_c (const Vector &vec)
	Set the y_c iterate (const).

void	Set_y_c_NonConst (Vector &vec)
	Set the y_c iterate (non-const).

SmartPtr< const Vector >	y_d () const
	Get the y_d iterate (const)

SmartPtr< Vector >	y_d_NonConst ()
	Get the y_d iterate (non-const) - this can only be called if the vector was created internally, or the Set_y_d_NonConst method was used.

SmartPtr< Vector >	create_new_y_d ()
	Create a new vector in the y_d entry.

SmartPtr< Vector >	create_new_y_d_copy ()
	Create a new vector in the y_d entry and copy the current values into it.

void	Set_y_d (const Vector &vec)
	Set the y_d iterate (const).

void	Set_y_d_NonConst (Vector &vec)
	Set the y_d iterate (non-const).

SmartPtr< const Vector >	z_L () const
	Get the z_L iterate (const)

SmartPtr< Vector >	z_L_NonConst ()
	Get the z_L iterate (non-const) - this can only be called if the vector was created internally, or the Set_z_L_NonConst method was used.

SmartPtr< Vector >	create_new_z_L ()
	Create a new vector in the z_L entry.

SmartPtr< Vector >	create_new_z_L_copy ()
	Create a new vector in the z_L entry and copy the current values into it.

void	Set_z_L (const Vector &vec)
	Set the z_L iterate (const).

void	Set_z_L_NonConst (Vector &vec)
	Set the z_L iterate (non-const).

SmartPtr< const Vector >	z_U () const
	Get the z_U iterate (const)

SmartPtr< Vector >	z_U_NonConst ()
	Get the z_U iterate (non-const) - this can only be called if the vector was created internally, or the Set_z_U_NonConst method was used.

SmartPtr< Vector >	create_new_z_U ()
	Create a new vector in the z_U entry.

SmartPtr< Vector >	create_new_z_U_copy ()
	Create a new vector in the z_U entry and copy the current values into it.

void	Set_z_U (const Vector &vec)
	Set the z_U iterate (const).

void	Set_z_U_NonConst (Vector &vec)
	Set the z_U iterate (non-const).

SmartPtr< const Vector >	v_L () const
	Get the v_L iterate (const)

SmartPtr< Vector >	v_L_NonConst ()
	Get the v_L iterate (non-const) - this can only be called if the vector was created internally, or the Set_v_L_NonConst method was used.

SmartPtr< Vector >	create_new_v_L ()
	Create a new vector in the v_L entry.

SmartPtr< Vector >	create_new_v_L_copy ()
	Create a new vector in the v_L entry and copy the current values into it.

void	Set_v_L (const Vector &vec)
	Set the v_L iterate (const).

void	Set_v_L_NonConst (Vector &vec)
	Set the v_L iterate (non-const).

SmartPtr< const Vector >	v_U () const
	Get the v_U iterate (const)

SmartPtr< Vector >	v_U_NonConst ()
	Get the v_U iterate (non-const) - this can only be called if the vector was created intenally, or the Set_v_U_NonConst method was used.

SmartPtr< Vector >	create_new_v_U ()
	Create a new vector in the v_U entry.

SmartPtr< Vector >	create_new_v_U_copy ()
	Create a new vector in the v_U entry and copy the current values into it.

void	Set_v_U (const Vector &vec)
	Set the v_U iterate (const).

void	Set_v_U_NonConst (Vector &vec)
	Set the v_U iterate (non-const).

void	Set_primal (const Vector &x, const Vector &s)
	Set the primal variables all in one shot.

void	Set_primal_NonConst (Vector &x, Vector &s)

void	Set_eq_mult (const Vector &y_c, const Vector &y_d)
	Set the eq multipliers all in one shot.

void	Set_eq_mult_NonConst (Vector &y_c, Vector &y_d)
	Set the eq multipliers all in one shot.

void	Set_bound_mult (const Vector &z_L, const Vector &z_U, const Vector &v_L, const Vector &v_U)
	Set the bound multipliers all in one shot.

void	Set_bound_mult_NonConst (Vector &z_L, Vector &z_U, Vector &v_L, Vector &v_U)
	Set the bound multipliers all in one shot.

TaggedObject::Tag	GetTagSum () const
	Get a sum of the tags of the contained items.

Public Member Functions inherited from Ipopt::CompoundVector
void	SetComp (Index icomp, const Vector &vec)
	Method for setting the pointer for a component that is a const Vector.

void	SetCompNonConst (Index icomp, Vector &vec)
	Method for setting the pointer for a component that is a non-const Vector.

Index	NComps () const
	Number of components of this compound vector.

bool	IsCompConst (Index i) const
	Check if a particular component is const or not.

bool	IsCompNull (Index i) const
	Check if a particular component is null or not.

SmartPtr< const Vector >	GetComp (Index i) const
	Return a particular component (const version)

SmartPtr< Vector >	GetCompNonConst (Index i)
	Return a particular component (non-const version).

	CompoundVector (const CompoundVectorSpace *owner_space, bool create_new)
	Constructor, given the corresponding CompoundVectorSpace.

virtual	~CompoundVector ()
	Default destructor.

Public Member Functions inherited from Ipopt::Vector
Vector *	MakeNew () const
	Create new Vector of the same type with uninitialized data.

Vector *	MakeNewCopy () const
	Create new Vector of the same type and copy the data over.

bool	HasValidNumbers () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

	Vector (const VectorSpace *owner_space)
	Constructor.

virtual	~Vector ()
	Destructor.

void	Copy (const Vector &x)
	Copy the data of the vector x into this vector (DCOPY).

void	Scal (Number alpha)
	Scales the vector by scalar alpha (DSCAL)

void	Axpy (Number alpha, const Vector &x)
	Add the multiple alpha of vector x to this vector (DAXPY)

Number	Dot (const Vector &x) const
	Computes inner product of vector x with this (DDOT)

Number	Nrm2 () const
	Computes the 2-norm of this vector (DNRM2)

Number	Asum () const
	Computes the 1-norm of this vector (DASUM)

Number	Amax () const
	Computes the max-norm of this vector (based on IDAMAX)

void	Set (Number alpha)
	Set each element in the vector to the scalar alpha.

void	ElementWiseDivide (const Vector &x)
	Element-wise division \(y_i \gets y_i/x_i\).

void	ElementWiseMultiply (const Vector &x)
	Element-wise multiplication \(y_i \gets y_i*x_i\).

void	ElementWiseSelect (const Vector &x)
	Element-wise selection \(y_i \gets sgn(y_i)x_i, if y_i != 0, else 0\).

void	ElementWiseMax (const Vector &x)
	Element-wise max against entries in x.

void	ElementWiseMin (const Vector &x)
	Element-wise min against entries in x.

void	ElementWiseReciprocal ()
	Reciprocates the entries in the vector.

void	ElementWiseAbs ()
	Absolute values of the entries in the vector.

void	ElementWiseSqrt ()
	Element-wise square root of the entries in the vector.

void	ElementWiseSgn ()
	Replaces the vector values with their sgn values ( -1 if x_i < 0, 0 if x_i == 0, and 1 if x_i > 0)

void	AddScalar (Number scalar)
	Add scalar to every vector component.

Number	Max () const
	Returns the maximum value in the vector.

Number	Min () const
	Returns the minimum value in the vector.

Number	Sum () const
	Returns the sum of the vector entries.

Number	SumLogs () const
	Returns the sum of the logs of each vector entry.

void	AddOneVector (Number a, const Vector &v1, Number c)
	Add one vector, y = a * v1 + c * y.

void	AddTwoVectors (Number a, const Vector &v1, Number b, const Vector &v2, Number c)
	Add two vectors, y = a * v1 + b * v2 + c * y.

Number	FracToBound (const Vector &delta, Number tau) const
	Fraction to the boundary parameter.

void	AddVectorQuotient (Number a, const Vector &z, const Vector &s, Number c)
	Add the quotient of two vectors, y = a * z/s + c * y.

Index	Dim () const
	Dimension of the Vector.

SmartPtr< const VectorSpace >	OwnerSpace () const
	Return the owner VectorSpace.

void	Print (SmartPtr< const Journalist > jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const
	Print the entire vector.

void	Print (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const

Public Member Functions inherited from Ipopt::TaggedObject
	TaggedObject ()
	Constructor.

virtual	~TaggedObject ()
	Destructor.

Tag	GetTag () const
	Users of TaggedObjects call this to update their own internal tags every time they perform the expensive operation.

bool	HasChanged (const Tag comparison_tag) const
	Users of TaggedObjects call this to check if the object HasChanged since they last updated their own internal tag.

Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()

virtual	~ReferencedObject ()

Index	ReferenceCount () const

void	AddRef (const Referencer *referencer) const

void	ReleaseRef (const Referencer *referencer) const

Public Member Functions inherited from Ipopt::Subject
	Subject ()
	Default Constructor.

virtual	~Subject ()
	Destructor.

void	AttachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Attach the specified observer (i.e., begin receiving notifications).

void	DetachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Detach the specified observer (i.e., no longer receive notifications).

Private Member Functions
SmartPtr< const Vector >	GetIterateFromComp (Index i) const
	private method to return the const element from the compound vector

SmartPtr< Vector >	GetNonConstIterateFromComp (Index i)
	private method to return the non-const element from the compound vector

Default Compiler Generated Methods (Hidden to avoid
implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	IteratesVector ()
	Default Constructor.

	IteratesVector (const IteratesVector &)
	Copy Constructor.

void	operator= (const IteratesVector &)
	Default Assignment Operator.

Private Attributes
const IteratesVectorSpace *	owner_space_

Additional Inherited Members
Public Types inherited from Ipopt::TaggedObject
typedef unsigned int	Tag
	Type for the Tag values.

Protected Member Functions inherited from Ipopt::CompoundVector
virtual bool	HasValidNumbersImpl () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

virtual void	CopyImpl (const Vector &x)
	Copy the data of the vector x into this vector (DCOPY).

virtual void	ScalImpl (Number alpha)
	Scales the vector by scalar alpha (DSCAL)

virtual void	AxpyImpl (Number alpha, const Vector &x)
	Add the multiple alpha of vector x to this vector (DAXPY)

virtual Number	DotImpl (const Vector &x) const
	Computes inner product of vector x with this (DDOT)

virtual Number	Nrm2Impl () const
	Computes the 2-norm of this vector (DNRM2)

virtual Number	AsumImpl () const
	Computes the 1-norm of this vector (DASUM)

virtual Number	AmaxImpl () const
	Computes the max-norm of this vector (based on IDAMAX)

virtual void	SetImpl (Number value)
	Set each element in the vector to the scalar alpha.

virtual void	ElementWiseDivideImpl (const Vector &x)
	Element-wise division \(y_i \gets y_i/x_i\).

virtual void	ElementWiseMultiplyImpl (const Vector &x)
	Element-wise multiplication \(y_i \gets y_i*x_i\).

virtual void	ElementWiseSelectImpl (const Vector &x)
	Element-wise selection \(y_i \gets sgn(y_i)x_i, if y_i != 0, else 0\).

virtual void	ElementWiseMaxImpl (const Vector &x)
	Element-wise max against entries in x.

virtual void	ElementWiseMinImpl (const Vector &x)
	Element-wise min against entries in x.

virtual void	ElementWiseReciprocalImpl ()
	Reciprocates the elements of the vector.

virtual void	ElementWiseAbsImpl ()
	Take elementwise absolute values of the elements of the vector.

virtual void	ElementWiseSqrtImpl ()
	Take elementwise square-root of the elements of the vector.

virtual void	ElementWiseSgnImpl ()
	Replaces entries with sgn of the entry.

virtual void	AddScalarImpl (Number scalar)
	Add scalar to every component of vector.

virtual Number	MaxImpl () const
	Max value in the vector.

virtual Number	MinImpl () const
	Min number in the vector.

virtual Number	SumImpl () const
	Sum of entries in the vector.

virtual Number	SumLogsImpl () const
	Sum of logs of entries in the vector.

void	AddTwoVectorsImpl (Number a, const Vector &v1, Number b, const Vector &v2, Number c)
	Add two vectors (a * v1 + b * v2).

Number	FracToBoundImpl (const Vector &delta, Number tau) const
	Fraction to boundary parameter.

void	AddVectorQuotientImpl (Number a, const Vector &z, const Vector &s, Number c)
	Add the quotient of two vectors.

virtual void	PrintImpl (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const
	Print the entire vector.

implementation methods (derived classes MUST
overload these pure virtual protected methods.)
Protected Member Functions inherited from Ipopt::TaggedObject
void	ObjectChanged ()
	Objects derived from TaggedObject MUST call this method every time their internal state changes to update the internal tag for comparison.

Protected Member Functions inherited from Ipopt::Subject
void	Notify (Observer::NotifyType notify_type) const

Detailed Description

Specialized CompoundVector class specifically for the algorithm iterates.

This class inherits from CompoundVector and is a specialized class for handling the iterates of the Ipopt Algorithm, that is, x, s, y_c, y_d, z_L, z_U, v_L, and v_U. It inherits from CompoundVector so it can behave like a CV in most calculations, but it has fixed dimensions and cannot be customized

Definition at line 25 of file IpIteratesVector.hpp.

Constructor & Destructor Documentation

◆ IteratesVector() [1/3]

Ipopt::IteratesVector::IteratesVector	(	const IteratesVectorSpace *	owner_space,
		bool	create_new
	)

Constructors / Destructors.

◆ ~IteratesVector()

virtual Ipopt::IteratesVector::~IteratesVector ( )

virtual

◆ IteratesVector() [2/3]

Ipopt::IteratesVector::IteratesVector ( )

private

Default Constructor.

◆ IteratesVector() [3/3]

Ipopt::IteratesVector::IteratesVector ( const IteratesVector & )

private

Copy Constructor.

Member Function Documentation

◆ MakeNewIteratesVector()

SmartPtr< IteratesVector > Ipopt::IteratesVector::MakeNewIteratesVector ( bool create_new = true ) const

Make New methods.

Use this method to create a new iterates vector.

The MakeNew method on the Vector class also works, but it does not give the create_new option.

◆ MakeNewIteratesVectorCopy()

SmartPtr< IteratesVector > Ipopt::IteratesVector::MakeNewIteratesVectorCopy ( ) const

inline

Use this method to create a new iterates vector with a copy of all the data.

Definition at line 52 of file IpIteratesVector.hpp.

◆ MakeNewContainer()

SmartPtr< IteratesVector > Ipopt::IteratesVector::MakeNewContainer ( ) const

Use this method to create a new iterates vector container.

This creates a new NonConst container, but the elements inside the iterates vector may be const. Therefore, the container can be modified to point to new entries, but the existing entries may or may not be modifiable.

◆ x()

SmartPtr< const Vector > Ipopt::IteratesVector::x ( ) const

inline

Iterates Set/Get Methods.

Get the x iterate (const)

Definition at line 73 of file IpIteratesVector.hpp.

◆ x_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::x_NonConst ( )

inline

Get the x iterate (non-const) - this can only be called if the vector was created internally, or the Set_x_NonConst method was used.

Definition at line 81 of file IpIteratesVector.hpp.

◆ create_new_x()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_x ( )

inline

Create a new vector in the x entry.

Definition at line 797 of file IpIteratesVector.hpp.

◆ create_new_x_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_x_copy ( )

inline

Create a new vector in the x entry and copy the current values into it.

Definition at line 92 of file IpIteratesVector.hpp.

◆ Set_x()

void Ipopt::IteratesVector::Set_x ( const Vector & vec )

inline

Set the x iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 104 of file IpIteratesVector.hpp.

◆ Set_x_NonConst()

void Ipopt::IteratesVector::Set_x_NonConst ( Vector & vec )

inline

Set the x iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 115 of file IpIteratesVector.hpp.

◆ s()

SmartPtr< const Vector > Ipopt::IteratesVector::s ( ) const

inline

Get the s iterate (const)

Definition at line 123 of file IpIteratesVector.hpp.

◆ s_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::s_NonConst ( )

inline

Get the s iterate (non-const) - this can only be called if the vector was created internally, or the Set_s_NonConst method was used.

Definition at line 132 of file IpIteratesVector.hpp.

◆ create_new_s()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_s ( )

inline

Create a new vector in the s entry.

Definition at line 802 of file IpIteratesVector.hpp.

◆ create_new_s_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_s_copy ( )

inline

Create a new vector in the s entry and copy the current values into it.

Definition at line 142 of file IpIteratesVector.hpp.

◆ Set_s()

void Ipopt::IteratesVector::Set_s ( const Vector & vec )

inline

Set the s iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 154 of file IpIteratesVector.hpp.

◆ Set_s_NonConst()

void Ipopt::IteratesVector::Set_s_NonConst ( Vector & vec )

inline

Set the s iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 165 of file IpIteratesVector.hpp.

◆ y_c()

SmartPtr< const Vector > Ipopt::IteratesVector::y_c ( ) const

inline

Get the y_c iterate (const)

Definition at line 173 of file IpIteratesVector.hpp.

◆ y_c_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::y_c_NonConst ( )

inline

Get the y_c iterate (non-const) - this can only be called if the vector was created internally, or the Set_y_c_NonConst method was used.

Definition at line 182 of file IpIteratesVector.hpp.

◆ create_new_y_c()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_y_c ( )

inline

Create a new vector in the y_c entry.

Definition at line 807 of file IpIteratesVector.hpp.

◆ create_new_y_c_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_y_c_copy ( )

inline

Create a new vector in the y_c entry and copy the current values into it.

Definition at line 193 of file IpIteratesVector.hpp.

◆ Set_y_c()

void Ipopt::IteratesVector::Set_y_c ( const Vector & vec )

inline

Set the y_c iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 205 of file IpIteratesVector.hpp.

◆ Set_y_c_NonConst()

void Ipopt::IteratesVector::Set_y_c_NonConst ( Vector & vec )

inline

Set the y_c iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 216 of file IpIteratesVector.hpp.

◆ y_d()

SmartPtr< const Vector > Ipopt::IteratesVector::y_d ( ) const

inline

Get the y_d iterate (const)

Definition at line 224 of file IpIteratesVector.hpp.

◆ y_d_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::y_d_NonConst ( )

inline

Get the y_d iterate (non-const) - this can only be called if the vector was created internally, or the Set_y_d_NonConst method was used.

Definition at line 232 of file IpIteratesVector.hpp.

◆ create_new_y_d()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_y_d ( )

inline

Create a new vector in the y_d entry.

Definition at line 812 of file IpIteratesVector.hpp.

◆ create_new_y_d_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_y_d_copy ( )

inline

Create a new vector in the y_d entry and copy the current values into it.

Definition at line 243 of file IpIteratesVector.hpp.

◆ Set_y_d()

void Ipopt::IteratesVector::Set_y_d ( const Vector & vec )

inline

Set the y_d iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 255 of file IpIteratesVector.hpp.

◆ Set_y_d_NonConst()

void Ipopt::IteratesVector::Set_y_d_NonConst ( Vector & vec )

inline

Set the y_d iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 266 of file IpIteratesVector.hpp.

◆ z_L()

SmartPtr< const Vector > Ipopt::IteratesVector::z_L ( ) const

inline

Get the z_L iterate (const)

Definition at line 274 of file IpIteratesVector.hpp.

◆ z_L_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::z_L_NonConst ( )

inline

Get the z_L iterate (non-const) - this can only be called if the vector was created internally, or the Set_z_L_NonConst method was used.

Definition at line 283 of file IpIteratesVector.hpp.

◆ create_new_z_L()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_z_L ( )

inline

Create a new vector in the z_L entry.

Definition at line 817 of file IpIteratesVector.hpp.

◆ create_new_z_L_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_z_L_copy ( )

inline

Create a new vector in the z_L entry and copy the current values into it.

Definition at line 293 of file IpIteratesVector.hpp.

◆ Set_z_L()

void Ipopt::IteratesVector::Set_z_L ( const Vector & vec )

inline

Set the z_L iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 305 of file IpIteratesVector.hpp.

◆ Set_z_L_NonConst()

void Ipopt::IteratesVector::Set_z_L_NonConst ( Vector & vec )

inline

Set the z_L iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 316 of file IpIteratesVector.hpp.

◆ z_U()

SmartPtr< const Vector > Ipopt::IteratesVector::z_U ( ) const

inline

Get the z_U iterate (const)

Definition at line 324 of file IpIteratesVector.hpp.

◆ z_U_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::z_U_NonConst ( )

inline

Get the z_U iterate (non-const) - this can only be called if the vector was created internally, or the Set_z_U_NonConst method was used.

Definition at line 332 of file IpIteratesVector.hpp.

◆ create_new_z_U()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_z_U ( )

inline

Create a new vector in the z_U entry.

Definition at line 822 of file IpIteratesVector.hpp.

◆ create_new_z_U_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_z_U_copy ( )

inline

Create a new vector in the z_U entry and copy the current values into it.

Definition at line 343 of file IpIteratesVector.hpp.

◆ Set_z_U()

void Ipopt::IteratesVector::Set_z_U ( const Vector & vec )

inline

Set the z_U iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 355 of file IpIteratesVector.hpp.

◆ Set_z_U_NonConst()

void Ipopt::IteratesVector::Set_z_U_NonConst ( Vector & vec )

inline

Set the z_U iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 366 of file IpIteratesVector.hpp.

◆ v_L()

SmartPtr< const Vector > Ipopt::IteratesVector::v_L ( ) const

inline

Get the v_L iterate (const)

Definition at line 374 of file IpIteratesVector.hpp.

◆ v_L_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::v_L_NonConst ( )

inline

Get the v_L iterate (non-const) - this can only be called if the vector was created internally, or the Set_v_L_NonConst method was used.

Definition at line 383 of file IpIteratesVector.hpp.

◆ create_new_v_L()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_v_L ( )

inline

Create a new vector in the v_L entry.

Definition at line 827 of file IpIteratesVector.hpp.

◆ create_new_v_L_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_v_L_copy ( )

inline

Create a new vector in the v_L entry and copy the current values into it.

Definition at line 394 of file IpIteratesVector.hpp.

◆ Set_v_L()

void Ipopt::IteratesVector::Set_v_L ( const Vector & vec )

inline

Set the v_L iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 406 of file IpIteratesVector.hpp.

◆ Set_v_L_NonConst()

void Ipopt::IteratesVector::Set_v_L_NonConst ( Vector & vec )

inline

Set the v_L iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 416 of file IpIteratesVector.hpp.

◆ v_U()

SmartPtr< const Vector > Ipopt::IteratesVector::v_U ( ) const

inline

Get the v_U iterate (const)

Definition at line 424 of file IpIteratesVector.hpp.

◆ v_U_NonConst()

SmartPtr< Vector > Ipopt::IteratesVector::v_U_NonConst ( )

inline

Get the v_U iterate (non-const) - this can only be called if the vector was created intenally, or the Set_v_U_NonConst method was used.

Definition at line 433 of file IpIteratesVector.hpp.

◆ create_new_v_U()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_v_U ( )

inline

Create a new vector in the v_U entry.

Definition at line 832 of file IpIteratesVector.hpp.

◆ create_new_v_U_copy()

SmartPtr< Vector > Ipopt::IteratesVector::create_new_v_U_copy ( )

inline

Create a new vector in the v_U entry and copy the current values into it.

Definition at line 444 of file IpIteratesVector.hpp.

◆ Set_v_U()

void Ipopt::IteratesVector::Set_v_U ( const Vector & vec )

inline

Set the v_U iterate (const).

Sets the pointer, does NOT copy data.

Definition at line 456 of file IpIteratesVector.hpp.

◆ Set_v_U_NonConst()

void Ipopt::IteratesVector::Set_v_U_NonConst ( Vector & vec )

inline

Set the v_U iterate (non-const).

Sets the pointer, does NOT copy data.

Definition at line 467 of file IpIteratesVector.hpp.

◆ Set_primal()

void Ipopt::IteratesVector::Set_primal	(	const Vector &	x,
		const Vector &	s
	)

inline

Set the primal variables all in one shot.

Sets the pointers, does NOT copy data.

Definition at line 478 of file IpIteratesVector.hpp.

◆ Set_primal_NonConst()

void Ipopt::IteratesVector::Set_primal_NonConst	(	Vector &	x,
		Vector &	s
	)

inline

Definition at line 486 of file IpIteratesVector.hpp.

◆ Set_eq_mult()

void Ipopt::IteratesVector::Set_eq_mult	(	const Vector &	y_c,
		const Vector &	y_d
	)

inline

Set the eq multipliers all in one shot.

Sets the pointers, does not copy data.

Definition at line 499 of file IpIteratesVector.hpp.

◆ Set_eq_mult_NonConst()

void Ipopt::IteratesVector::Set_eq_mult_NonConst	(	Vector &	y_c,
		Vector &	y_d
	)

inline

Set the eq multipliers all in one shot.

Sets the pointers, does not copy data.

Definition at line 512 of file IpIteratesVector.hpp.

◆ Set_bound_mult()

void Ipopt::IteratesVector::Set_bound_mult	(	const Vector &	z_L,
		const Vector &	z_U,
		const Vector &	v_L,
		const Vector &	v_U
	)

inline

Set the bound multipliers all in one shot.

Sets the pointers, does not copy data.

Definition at line 525 of file IpIteratesVector.hpp.

◆ Set_bound_mult_NonConst()

void Ipopt::IteratesVector::Set_bound_mult_NonConst	(	Vector &	z_L,
		Vector &	z_U,
		Vector &	v_L,
		Vector &	v_U
	)

inline

Set the bound multipliers all in one shot.

Sets the pointers, does not copy data.

Definition at line 542 of file IpIteratesVector.hpp.

◆ GetTagSum()

TaggedObject::Tag Ipopt::IteratesVector::GetTagSum ( ) const

inline

Get a sum of the tags of the contained items.

There is no guarantee that this is unique, but there is a high chance it is unique and it can be used for debug checks relatively reliably.

Definition at line 562 of file IpIteratesVector.hpp.

◆ operator=()

void Ipopt::IteratesVector::operator= ( const IteratesVector & )

private

Default Assignment Operator.

◆ GetIterateFromComp()

SmartPtr< const Vector > Ipopt::IteratesVector::GetIterateFromComp ( Index i ) const

inlineprivate

private method to return the const element from the compound vector

Returns: NULL, if none is currently set

Definition at line 633 of file IpIteratesVector.hpp.

◆ GetNonConstIterateFromComp()

SmartPtr< Vector > Ipopt::IteratesVector::GetNonConstIterateFromComp ( Index i )

inlineprivate

private method to return the non-const element from the compound vector

Returns: NULL, if none is currently set

Definition at line 648 of file IpIteratesVector.hpp.

Member Data Documentation

◆ owner_space_

const IteratesVectorSpace* Ipopt::IteratesVector::owner_space_

private

Definition at line 627 of file IpIteratesVector.hpp.

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

src/Algorithm/IpIteratesVector.hpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IteratesVector() [1/3]

◆ ~IteratesVector()

◆ IteratesVector() [2/3]

◆ IteratesVector() [3/3]

Member Function Documentation

◆ MakeNewIteratesVector()

◆ MakeNewIteratesVectorCopy()

◆ MakeNewContainer()

◆ x()

◆ x_NonConst()

◆ create_new_x()

◆ create_new_x_copy()

◆ Set_x()

◆ Set_x_NonConst()

◆ s()

◆ s_NonConst()

◆ create_new_s()

◆ create_new_s_copy()

◆ Set_s()

◆ Set_s_NonConst()

◆ y_c()

◆ y_c_NonConst()

◆ create_new_y_c()

◆ create_new_y_c_copy()

◆ Set_y_c()

◆ Set_y_c_NonConst()

◆ y_d()

◆ y_d_NonConst()

◆ create_new_y_d()

◆ create_new_y_d_copy()

◆ Set_y_d()

◆ Set_y_d_NonConst()

◆ z_L()

◆ z_L_NonConst()

◆ create_new_z_L()

◆ create_new_z_L_copy()

◆ Set_z_L()

◆ Set_z_L_NonConst()

◆ z_U()

◆ z_U_NonConst()

◆ create_new_z_U()

◆ create_new_z_U_copy()

◆ Set_z_U()

◆ Set_z_U_NonConst()

◆ v_L()

◆ v_L_NonConst()

◆ create_new_v_L()

◆ create_new_v_L_copy()

◆ Set_v_L()

◆ Set_v_L_NonConst()

◆ v_U()

◆ v_U_NonConst()

◆ create_new_v_U()

◆ create_new_v_U_copy()

◆ Set_v_U()

◆ Set_v_U_NonConst()

◆ Set_primal()

◆ Set_primal_NonConst()

◆ Set_eq_mult()

◆ Set_eq_mult_NonConst()

◆ Set_bound_mult()

◆ Set_bound_mult_NonConst()

◆ GetTagSum()

◆ operator=()

◆ GetIterateFromComp()

◆ GetNonConstIterateFromComp()

Member Data Documentation

◆ owner_space_