Ipopt::CompoundVectorSpace Class Reference

This vectors space is the vector space for CompoundVector. More...

#include <IpCompoundVector.hpp>

Inheritance diagram for Ipopt::CompoundVectorSpace:

Public Member Functions
virtual void	SetCompSpace (Index icomp, const VectorSpace &vec_space)
	Method for setting the individual component VectorSpaces.
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.
virtual CompoundVector *	MakeNewCompoundVector (bool create_new=true) const
	Method for creating a new vector of this specific type.
virtual Vector *	MakeNew () const
	Pure virtual method for creating a new Vector of the corresponding type.
Constructors/Destructors.
	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.
	CompoundVectorSpace ()
	Default constructor.
	CompoundVectorSpace (const CompoundVectorSpace &)
	Copy Constructor.
CompoundVectorSpace &	operator= (const CompoundVectorSpace &)
	Default Assignment Operator.

Private Attributes
const Index	ncomp_spaces_
	Number of components.
std::vector< SmartPtr< const VectorSpace > >	comp_spaces_
	std::vector of vector spaces for the components

Detailed Description

This vectors space is the vector space for CompoundVector.

Before a CompoundVector can be created, all components of this CompoundVectorSpace have to be set. When calling the constructor, the number of component has to be specified. The individual VectorSpaces can be set with the SetComp method.

Definition at line 281 of file IpCompoundVector.hpp.

Constructor & Destructor Documentation

CompoundVectorSpace() [1/3]

Ipopt::CompoundVectorSpace::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()

Ipopt::CompoundVectorSpace::~CompoundVectorSpace ( )

inline

Destructor.

Definition at line 295 of file IpCompoundVector.hpp.

CompoundVectorSpace() [2/3]

Ipopt::CompoundVectorSpace::CompoundVectorSpace ( )

private

Default constructor.

CompoundVectorSpace() [3/3]

Ipopt::CompoundVectorSpace::CompoundVectorSpace ( const CompoundVectorSpace &  )

private

Copy Constructor.

Member Function Documentation

SetCompSpace()

virtual void Ipopt::CompoundVectorSpace::SetCompSpace ( Index  icomp, const VectorSpace &  vec_space  )

virtual

Method for setting the individual component VectorSpaces.

Parameters

icomp	Number of the component to be set
vec_space	VectorSpace for component icomp

Reimplemented in Ipopt::IteratesVectorSpace.

GetCompSpace()

SmartPtr< const VectorSpace > Ipopt::CompoundVectorSpace::GetCompSpace

(

Index

icomp

)

const

Method for obtaining an individual component VectorSpace.

NCompSpaces()

Index Ipopt::CompoundVectorSpace::NCompSpaces ( ) const

inline

Accessor method to obtain the number of components.

Definition at line 311 of file IpCompoundVector.hpp.

MakeNewCompoundVector()

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

inlinevirtual

Method for creating a new vector of this specific type.

Reimplemented in Ipopt::IteratesVectorSpace.

Definition at line 317 of file IpCompoundVector.hpp.

MakeNew()

virtual Vector * Ipopt::CompoundVectorSpace::MakeNew ( ) const

inlinevirtual

Pure virtual method for creating a new Vector of the corresponding type.

Implements Ipopt::VectorSpace.

Reimplemented in Ipopt::IteratesVectorSpace.

Definition at line 324 of file IpCompoundVector.hpp.

operator=()

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

private

Default Assignment Operator.

Member Data Documentation

ncomp_spaces_

const Index Ipopt::CompoundVectorSpace::ncomp_spaces_

private

Number of components.

Definition at line 353 of file IpCompoundVector.hpp.

comp_spaces_

std::vector<SmartPtr<const VectorSpace> > Ipopt::CompoundVectorSpace::comp_spaces_

private

std::vector of vector spaces for the components

Definition at line 356 of file IpCompoundVector.hpp.

---

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

• src/LinAlg/IpCompoundVector.hpp