CompoundVectorSpace Class Reference

#include <IpCompoundVector.hpp>

Inheritance diagram for CompoundVectorSpace:

VectorSpace ReferencedObject IteratesVectorSpace

List of all members.


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.

Public Member Functions

virtual void SetCompSpace (Index icomp, const VectorSpace &vec_space)
 Method for setting the individual component VectorSpaces.
SmartPtr< const VectorSpaceGetCompSpace (Index icomp) const
 Method for obtaining an individual component VectorSpace.
Index NCompSpaces () const
 Accessor method to obtain the number of components.
virtual CompoundVectorMakeNewCompoundVector (bool create_new=true) const
 Method for creating a new vector of this specific type.
virtual VectorMakeNew () const
 Overloaded MakeNew method for the VectorSpace base class.
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.


Constructor & Destructor Documentation

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

Destructor.


Member Function Documentation

void 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 IteratesVectorSpace.

References DBG_ASSERT, and Ipopt::IsNull().

Referenced by IteratesVectorSpace::IteratesVectorSpace().

SmartPtr< const VectorSpace > GetCompSpace ( Index  icomp  )  const

Index NCompSpaces (  )  const [inline]

Accessor method to obtain the number of components.

Referenced by CompoundVector::NComps().

virtual CompoundVector* MakeNewCompoundVector ( bool  create_new = true  )  const [inline, virtual]

Method for creating a new vector of this specific type.

Reimplemented in IteratesVectorSpace.

Referenced by CompoundVectorSpace::MakeNew().

virtual Vector* MakeNew (  )  const [inline, virtual]

Overloaded MakeNew method for the VectorSpace base class.

Implements VectorSpace.

Reimplemented in IteratesVectorSpace.

References CompoundVectorSpace::MakeNewCompoundVector().


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

Generated on Fri Sep 26 07:44:25 2008 for SimTKcore by  doxygen 1.5.6