Specialized CompoundVector class specifically for the algorithm iterates. More...
#include <IpIteratesVector.hpp>
Public Member Functions | |
IteratesVector (const IteratesVectorSpace *owner_space, bool create_new) | |
Constructors / Destructors. | |
virtual | ~IteratesVector () |
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 intenally, 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 intenally, 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 intenally, 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 intenally, 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 intenally, 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 intenally, 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 intenally, 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) |
Iterates Set/Get Methods. | |
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) |
Iterates Set/Get Methods. | |
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) |
Iterates Set/Get Methods. | |
TaggedObject::Tag | GetTagSum () const |
Get a sum of the tags of the contained items. | |
![]() | |
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. | |
![]() | |
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 ![]() | |
void | ElementWiseMultiply (const Vector &x) |
Element-wise multiplication ![]() | |
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 | |
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 |
Print the entire vector. | |
![]() | |
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. | |
![]() | |
ReferencedObject () | |
virtual | ~ReferencedObject () |
Index | ReferenceCount () const |
void | AddRef (const Referencer *referencer) const |
void | ReleaseRef (const Referencer *referencer) const |
![]() | |
Subject () | |
Default Constructor. | |
virtual | ~Subject () |
Default destructor. | |
void | AttachObserver (Observer::NotifyType notify_type, Observer *observer) const |
Attach the specified observer (i.e., begin recieving notifications). | |
void | DetachObserver (Observer::NotifyType notify_type, Observer *observer) const |
Detach the specified observer (i.e., no longer recieve 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 &) |
Overloaded Equals Operator. |
Private Attributes | |
const IteratesVectorSpace * | owner_space_ |
Vector Space. |
Additional Inherited Members | |
![]() | |
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 ![]() | |
virtual void | ElementWiseMultiplyImpl (const Vector &x) |
Element-wise multiplication ![]() | |
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 () |
Element-wise reciprocal. | |
virtual void | ElementWiseAbsImpl () |
Element-wise absolute values. | |
virtual void | ElementWiseSqrtImpl () |
Element-wise square-root. | |
virtual void | ElementWiseSgnImpl () |
Replaces entries with sgn of the entry. | |
virtual void | AddScalarImpl (Number scalar) |
Add scalar to every component of the vector. | |
virtual Number | MaxImpl () const |
Max value in the vector. | |
virtual Number | MinImpl () const |
Min value in the vector. | |
virtual Number | SumImpl () const |
Computes the sum of the lements of vector. | |
virtual Number | SumLogsImpl () const |
Computes the sum of the logs of the elements of 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 the boundary parameter. | |
void | AddVectorQuotientImpl (Number a, const Vector &z, const Vector &s, Number c) |
Add the quotient of two vectors, y = a * z/s + c * y. | |
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.) | |
![]() | |
void | ObjectChanged () |
Objects derived from TaggedObject MUST call this method every time their internal state changes to update the internal tag for comparison. | |
![]() | |
void | Notify (Observer::NotifyType notify_type) const |
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 27 of file IpIteratesVector.hpp.
Ipopt::IteratesVector::IteratesVector | ( | const IteratesVectorSpace * | owner_space, |
bool | create_new | ||
) |
Constructors / Destructors.
|
virtual |
Constructors / Destructors.
|
private |
Default Constructor.
|
private |
Copy Constructor.
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.
|
inline |
Use this method to create a new iterates vector with a copy of all the data.
Definition at line 48 of file IpIteratesVector.hpp.
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.
Iterates Set/Get Methods.
Get the x iterate (const)
Definition at line 67 of file IpIteratesVector.hpp.
Get the x iterate (non-const) - this can only be called if the vector was created intenally, or the Set_x_NonConst method was used.
Definition at line 75 of file IpIteratesVector.hpp.
Create a new vector in the x entry.
Definition at line 632 of file IpIteratesVector.hpp.
Create a new vector in the x entry and copy the current values into it.
Definition at line 85 of file IpIteratesVector.hpp.
|
inline |
Set the x iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 95 of file IpIteratesVector.hpp.
|
inline |
Set the x iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 102 of file IpIteratesVector.hpp.
Get the s iterate (const)
Definition at line 108 of file IpIteratesVector.hpp.
Get the s iterate (non-const) - this can only be called if the vector was created intenally, or the Set_s_NonConst method was used.
Definition at line 116 of file IpIteratesVector.hpp.
Create a new vector in the s entry.
Definition at line 638 of file IpIteratesVector.hpp.
Create a new vector in the s entry and copy the current values into it.
Definition at line 126 of file IpIteratesVector.hpp.
|
inline |
Set the s iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 136 of file IpIteratesVector.hpp.
|
inline |
Set the s iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 143 of file IpIteratesVector.hpp.
Get the y_c iterate (const)
Definition at line 149 of file IpIteratesVector.hpp.
Get the y_c iterate (non-const) - this can only be called if the vector was created intenally, or the Set_y_c_NonConst method was used.
Definition at line 157 of file IpIteratesVector.hpp.
Create a new vector in the y_c entry.
Definition at line 644 of file IpIteratesVector.hpp.
Create a new vector in the y_c entry and copy the current values into it.
Definition at line 167 of file IpIteratesVector.hpp.
|
inline |
Set the y_c iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 177 of file IpIteratesVector.hpp.
|
inline |
Set the y_c iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 184 of file IpIteratesVector.hpp.
Get the y_d iterate (const)
Definition at line 190 of file IpIteratesVector.hpp.
Get the y_d iterate (non-const) - this can only be called if the vector was created intenally, or the Set_y_d_NonConst method was used.
Definition at line 198 of file IpIteratesVector.hpp.
Create a new vector in the y_d entry.
Definition at line 650 of file IpIteratesVector.hpp.
Create a new vector in the y_d entry and copy the current values into it.
Definition at line 208 of file IpIteratesVector.hpp.
|
inline |
Set the y_d iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 218 of file IpIteratesVector.hpp.
|
inline |
Set the y_d iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 225 of file IpIteratesVector.hpp.
Get the z_L iterate (const)
Definition at line 231 of file IpIteratesVector.hpp.
Get the z_L iterate (non-const) - this can only be called if the vector was created intenally, or the Set_z_L_NonConst method was used.
Definition at line 239 of file IpIteratesVector.hpp.
Create a new vector in the z_L entry.
Definition at line 656 of file IpIteratesVector.hpp.
Create a new vector in the z_L entry and copy the current values into it.
Definition at line 249 of file IpIteratesVector.hpp.
|
inline |
Set the z_L iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 259 of file IpIteratesVector.hpp.
|
inline |
Set the z_L iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 266 of file IpIteratesVector.hpp.
Get the z_U iterate (const)
Definition at line 272 of file IpIteratesVector.hpp.
Get the z_U iterate (non-const) - this can only be called if the vector was created intenally, or the Set_z_U_NonConst method was used.
Definition at line 280 of file IpIteratesVector.hpp.
Create a new vector in the z_U entry.
Definition at line 662 of file IpIteratesVector.hpp.
Create a new vector in the z_U entry and copy the current values into it.
Definition at line 290 of file IpIteratesVector.hpp.
|
inline |
Set the z_U iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 300 of file IpIteratesVector.hpp.
|
inline |
Set the z_U iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 307 of file IpIteratesVector.hpp.
Get the v_L iterate (const)
Definition at line 313 of file IpIteratesVector.hpp.
Get the v_L iterate (non-const) - this can only be called if the vector was created intenally, or the Set_v_L_NonConst method was used.
Definition at line 321 of file IpIteratesVector.hpp.
Create a new vector in the v_L entry.
Definition at line 668 of file IpIteratesVector.hpp.
Create a new vector in the v_L entry and copy the current values into it.
Definition at line 331 of file IpIteratesVector.hpp.
|
inline |
Set the v_L iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 341 of file IpIteratesVector.hpp.
|
inline |
Set the v_L iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 348 of file IpIteratesVector.hpp.
Get the v_U iterate (const)
Definition at line 354 of file IpIteratesVector.hpp.
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 362 of file IpIteratesVector.hpp.
Create a new vector in the v_U entry.
Definition at line 674 of file IpIteratesVector.hpp.
Create a new vector in the v_U entry and copy the current values into it.
Definition at line 372 of file IpIteratesVector.hpp.
|
inline |
Set the v_U iterate (const).
Sets the pointer, does NOT copy data.
Definition at line 382 of file IpIteratesVector.hpp.
|
inline |
Set the v_U iterate (non-const).
Sets the pointer, does NOT copy data.
Definition at line 389 of file IpIteratesVector.hpp.
Set the primal variables all in one shot.
Sets the pointers, does NOT copy data
Definition at line 396 of file IpIteratesVector.hpp.
Iterates Set/Get Methods.
Get the x iterate (const)
Definition at line 401 of file IpIteratesVector.hpp.
Set the eq multipliers all in one shot.
Sets the pointers, does not copy data.
Definition at line 409 of file IpIteratesVector.hpp.
Iterates Set/Get Methods.
Get the x iterate (const)
Definition at line 414 of file IpIteratesVector.hpp.
|
inline |
Set the bound multipliers all in one shot.
Sets the pointers, does not copy data.
Definition at line 422 of file IpIteratesVector.hpp.
|
inline |
Iterates Set/Get Methods.
Get the x iterate (const)
Definition at line 429 of file IpIteratesVector.hpp.
|
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 442 of file IpIteratesVector.hpp.
|
private |
Overloaded Equals Operator.
private method to return the const element from the compound vector.
This method will return NULL if none is currently set.
Definition at line 499 of file IpIteratesVector.hpp.
private method to return the non-const element from the compound vector.
This method will return NULL if none is currently set.
Definition at line 511 of file IpIteratesVector.hpp.
|
private |
Vector Space.
Reimplemented from Ipopt::CompoundVector.
Definition at line 493 of file IpIteratesVector.hpp.