IteratesVectorSpace Class Reference

#include <IpIteratesVector.hpp>

Inheritance diagram for IteratesVectorSpace:

List of all members.

---

Detailed Description

Vector Space for the IteratesVector class.

This is a specialized vector space for the IteratesVector class.

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.
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 ()
	Constructor that takes the spaces for each of the iterates.
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
	This method overloads ComooundVectorSpace::MakeNewCompoundVector to make sure that we get a vector of the correct type.
virtual Vector *	MakeNew () const
	This method creates a new vector (and allocates space in all the contained vectors.

---

Constructor & Destructor Documentation

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 !

References CompoundVectorSpace::SetCompSpace().

~IteratesVectorSpace

(

)

[virtual]

Constructor that takes the spaces for each of the iterates.

Warning! None of these can be NULL !

---

Member Function Documentation

virtual IteratesVector* MakeNewIteratesVector

(

bool

create_new = true

)

const [inline, virtual]

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.

Referenced by IteratesVectorSpace::MakeNew(), IteratesVectorSpace::MakeNewCompoundVector(), IteratesVectorSpace::MakeNewIteratesVector(), and IteratesVector::MakeNewIteratesVector().

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
	)			[inline]

Use this method to create a new const IteratesVector.

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

References Ipopt::ConstPtr(), and IteratesVectorSpace::MakeNewIteratesVector().

virtual CompoundVector* MakeNewCompoundVector

(

bool

create_new = true

)

const [inline, virtual]

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

Reimplemented from CompoundVectorSpace.

References IteratesVectorSpace::MakeNewIteratesVector().

virtual Vector* MakeNew

(

)

const [inline, virtual]

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 CompoundVectorSpace.

References IteratesVectorSpace::MakeNewIteratesVector().

virtual void SetCompSpace	(	Index	icomp,
		const VectorSpace &	vec_space
	)			[inline, virtual]

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

Reimplemented from CompoundVectorSpace.

References DBG_ASSERT.

---

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

• IpIteratesVector.hpp
• IpIteratesVector.cpp