Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | List of all members
Ipopt::IteratesVectorSpace Class Reference

Vector Space for the IteratesVector class. More...

#include <IpIteratesVector.hpp>

+ Inheritance diagram for Ipopt::IteratesVectorSpace:

Public Member Functions

virtual void SetCompSpace (Index icomp, const VectorSpace &vec_space)
 This method hides the CompoundVectorSpace::SetCompSpace method since the components of the Iterates are fixed at construction. More...
 
Constructors/Destructors.
 IteratesVectorSpace (const VectorSpace &x_space, const VectorSpace &s_space, const VectorSpace &y_c_space, const VectorSpace &y_d_space, const VectorSpace &z_L_space, const VectorSpace &z_U_space, const VectorSpace &v_L_space, const VectorSpace &v_U_space)
 Constructor that takes the spaces for each of the iterates. More...
 
virtual ~IteratesVectorSpace ()
 
virtual IteratesVectorMakeNewIteratesVector (bool create_new=true) const
 Method for creating vectors . More...
 
const SmartPtr< const
IteratesVector
MakeNewIteratesVector (const Vector &x, const Vector &s, const Vector &y_c, const Vector &y_d, const Vector &z_L, const Vector &z_U, const Vector &v_L, const Vector &v_U)
 Use this method to create a new const IteratesVector. More...
 
virtual CompoundVectorMakeNewCompoundVector (bool create_new=true) const
 This method overloads ComooundVectorSpace::MakeNewCompoundVector to make sure that we get a vector of the correct type. More...
 
virtual VectorMakeNew () const
 This method creates a new vector (and allocates space in all the contained vectors. More...
 
- Public Member Functions inherited from Ipopt::CompoundVectorSpace
SmartPtr< const VectorSpaceGetCompSpace (Index icomp) const
 Method for obtaining an individual component VectorSpace. More...
 
Index NCompSpaces () const
 Accessor method to obtain the number of components. More...
 
 CompoundVectorSpace (Index ncomp_spaces, Index total_dim)
 Constructor, has to be given the number of components and the total dimension of all components combined. More...
 
 ~CompoundVectorSpace ()
 Destructor. More...
 
- Public Member Functions inherited from Ipopt::VectorSpace
Index Dim () const
 Accessor function for the dimension of the vectors of this type. More...
 
 VectorSpace (Index dim)
 Constructor, given the dimension of all vectors generated by this VectorSpace. More...
 
virtual ~VectorSpace ()
 Destructor. More...
 
- 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
 

Private Member Functions

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.

 IteratesVectorSpace ()
 Default constructor. More...
 
 IteratesVectorSpace (const IteratesVectorSpace &)
 Copy Constructor. More...
 
IteratesVectorSpaceoperator= (const IteratesVectorSpace &)
 Overloaded Equals Operator. More...
 

Private Attributes

SmartPtr< const VectorSpacex_space_
 Contained Spaces. More...
 
SmartPtr< const VectorSpaces_space_
 
SmartPtr< const VectorSpacey_c_space_
 
SmartPtr< const VectorSpacey_d_space_
 
SmartPtr< const VectorSpacez_L_space_
 
SmartPtr< const VectorSpacez_U_space_
 
SmartPtr< const VectorSpacev_L_space_
 
SmartPtr< const VectorSpacev_U_space_
 

Detailed Description

Vector Space for the IteratesVector class.

This is a specialized vector space for the IteratesVector class.

Definition at line 532 of file IpIteratesVector.hpp.

Constructor & Destructor Documentation

Ipopt::IteratesVectorSpace::IteratesVectorSpace ( const VectorSpace x_space,
const VectorSpace s_space,
const VectorSpace y_c_space,
const VectorSpace y_d_space,
const VectorSpace z_L_space,
const VectorSpace z_U_space,
const VectorSpace v_L_space,
const VectorSpace v_U_space 
)

Constructor that takes the spaces for each of the iterates.

Warning! None of these can be NULL !

virtual Ipopt::IteratesVectorSpace::~IteratesVectorSpace ( )
virtual
Ipopt::IteratesVectorSpace::IteratesVectorSpace ( )
private

Default constructor.

Ipopt::IteratesVectorSpace::IteratesVectorSpace ( const IteratesVectorSpace )
private

Copy Constructor.

Member Function Documentation

virtual IteratesVector* Ipopt::IteratesVectorSpace::MakeNewIteratesVector ( bool  create_new = true) const
inlinevirtual

Method for creating vectors .

Use this to create a new IteratesVector. You can pass-in create_new = false if you only want a container and do not want vectors allocated.

Definition at line 555 of file IpIteratesVector.hpp.

const SmartPtr<const IteratesVector> Ipopt::IteratesVectorSpace::MakeNewIteratesVector ( const Vector x,
const Vector s,
const Vector y_c,
const Vector y_d,
const Vector z_L,
const Vector z_U,
const Vector v_L,
const Vector v_U 
)
inline

Use this method to create a new const IteratesVector.

You must pass in valid pointers for all of the entries.

Definition at line 563 of file IpIteratesVector.hpp.

virtual CompoundVector* Ipopt::IteratesVectorSpace::MakeNewCompoundVector ( bool  create_new = true) const
inlinevirtual

This method overloads ComooundVectorSpace::MakeNewCompoundVector to make sure that we get a vector of the correct type.

Reimplemented from Ipopt::CompoundVectorSpace.

Definition at line 585 of file IpIteratesVector.hpp.

virtual Vector* Ipopt::IteratesVectorSpace::MakeNew ( ) const
inlinevirtual

This method creates a new vector (and allocates space in all the contained vectors.

This is really only used for code that does not know what type of vector it is dealing with - for example, this method is called from Vector::MakeNew()

Reimplemented from Ipopt::CompoundVectorSpace.

Definition at line 595 of file IpIteratesVector.hpp.

virtual void Ipopt::IteratesVectorSpace::SetCompSpace ( Index  icomp,
const VectorSpace vec_space 
)
inlinevirtual

This method hides the CompoundVectorSpace::SetCompSpace method since the components of the Iterates are fixed at construction.

Reimplemented from Ipopt::CompoundVectorSpace.

Definition at line 605 of file IpIteratesVector.hpp.

IteratesVectorSpace& Ipopt::IteratesVectorSpace::operator= ( const IteratesVectorSpace )
private

Overloaded Equals Operator.

Member Data Documentation

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::x_space_
private

Contained Spaces.

Definition at line 628 of file IpIteratesVector.hpp.

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::s_space_
private

Definition at line 629 of file IpIteratesVector.hpp.

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::y_c_space_
private

Definition at line 630 of file IpIteratesVector.hpp.

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::y_d_space_
private

Definition at line 631 of file IpIteratesVector.hpp.

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::z_L_space_
private

Definition at line 632 of file IpIteratesVector.hpp.

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::z_U_space_
private

Definition at line 633 of file IpIteratesVector.hpp.

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::v_L_space_
private

Definition at line 634 of file IpIteratesVector.hpp.

SmartPtr<const VectorSpace> Ipopt::IteratesVectorSpace::v_U_space_
private

Definition at line 635 of file IpIteratesVector.hpp.


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