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, const VectorSpace &)
	This method hides the CompoundVectorSpace::SetCompSpace method since the components of the Iterates are fixed at construction.
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.
virtual	~IteratesVectorSpace ()
virtual IteratesVector *	MakeNewIteratesVector (bool create_new=true) const
	Method for creating vectors .
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.
virtual CompoundVector *	MakeNewCompoundVector (bool create_new=true) const
	Method for creating a new vector of this specific type.
virtual Vector *	MakeNew () const
	This method creates a new vector (and allocates space in all the contained vectors.
Public Member Functions inherited from Ipopt::CompoundVectorSpace
SmartPtr< const VectorSpace >	GetCompSpace (Index icomp) const
	Method for obtaining an individual component VectorSpace.
Index	NCompSpaces () const
	Accessor method to obtain the number of components.
	CompoundVectorSpace (Index ncomp_spaces, Index total_dim)
	Constructor, has to be given the number of components and the total dimension of all components combined.
	~CompoundVectorSpace ()
	Destructor.
Public Member Functions inherited from Ipopt::VectorSpace
Index	Dim () const
	Accessor function for the dimension of the vectors of this type.
	VectorSpace (Index dim)
	Constructor, given the dimension of all vectors generated by this VectorSpace.
virtual	~VectorSpace ()
	Destructor.
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.
	IteratesVectorSpace (const IteratesVectorSpace &)
	Copy Constructor.
IteratesVectorSpace &	operator= (const IteratesVectorSpace &)
	Default Assignment Operator.

Private Attributes
SmartPtr< const VectorSpace >	x_space_
	Contained Spaces.
SmartPtr< const VectorSpace >	s_space_
SmartPtr< const VectorSpace >	y_c_space_
SmartPtr< const VectorSpace >	y_d_space_
SmartPtr< const VectorSpace >	z_L_space_
SmartPtr< const VectorSpace >	z_U_space_
SmartPtr< const VectorSpace >	v_L_space_
SmartPtr< const VectorSpace >	v_U_space_

Detailed Description

Vector Space for the IteratesVector class.

This is a specialized vector space for the IteratesVector class.

Definition at line 665 of file IpIteratesVector.hpp.

Constructor & Destructor Documentation

IteratesVectorSpace() [1/3]

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.

Attention

None of these can be NULL !

~IteratesVectorSpace()

virtual Ipopt::IteratesVectorSpace::~IteratesVectorSpace ( )

virtual

IteratesVectorSpace() [2/3]

Ipopt::IteratesVectorSpace::IteratesVectorSpace ( )

private

Default constructor.

IteratesVectorSpace() [3/3]

Ipopt::IteratesVectorSpace::IteratesVectorSpace ( const IteratesVectorSpace &  )

private

Copy Constructor.

Member Function Documentation

MakeNewIteratesVector() [1/2]

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 696 of file IpIteratesVector.hpp.

MakeNewIteratesVector() [2/2]

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 707 of file IpIteratesVector.hpp.

MakeNewCompoundVector()

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

inlinevirtual

Method for creating a new vector of this specific type.

Reimplemented from Ipopt::CompoundVectorSpace.

Definition at line 730 of file IpIteratesVector.hpp.

MakeNew()

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 744 of file IpIteratesVector.hpp.

SetCompSpace()

virtual void Ipopt::IteratesVectorSpace::SetCompSpace ( Index  , const VectorSpace &    )

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 754 of file IpIteratesVector.hpp.

operator=()

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

private

Default Assignment Operator.

Member Data Documentation

x_space_

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

private

Contained Spaces.

Definition at line 787 of file IpIteratesVector.hpp.

s_space_

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

private

Definition at line 788 of file IpIteratesVector.hpp.

y_c_space_

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

private

Definition at line 789 of file IpIteratesVector.hpp.

y_d_space_

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

private

Definition at line 790 of file IpIteratesVector.hpp.

z_L_space_

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

private

Definition at line 791 of file IpIteratesVector.hpp.

z_U_space_

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

private

Definition at line 792 of file IpIteratesVector.hpp.

v_L_space_

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

private

Definition at line 793 of file IpIteratesVector.hpp.

v_U_space_

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

private

Definition at line 794 of file IpIteratesVector.hpp.

---

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

• src/Algorithm/IpIteratesVector.hpp