Ipopt  3.12.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | List of all members
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. More...
 
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...
 
virtual CompoundVectorMakeNewCompoundVector (bool create_new=true) const
 Method for creating a new vector of this specific type. More...
 
virtual VectorMakeNew () const
 Overloaded MakeNew method for the VectorSpace base class. More...
 
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. 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.

 CompoundVectorSpace ()
 Default constructor. More...
 
 CompoundVectorSpace (const CompoundVectorSpace &)
 Copy Constructor. More...
 
CompoundVectorSpaceoperator= (const CompoundVectorSpace &)
 Overloaded Equals Operator. More...
 

Private Attributes

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

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 239 of file IpCompoundVector.hpp.

Constructor & Destructor Documentation

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.

Ipopt::CompoundVectorSpace::~CompoundVectorSpace ( )
inline

Destructor.

Definition at line 249 of file IpCompoundVector.hpp.

Ipopt::CompoundVectorSpace::CompoundVectorSpace ( )
private

Default constructor.

Ipopt::CompoundVectorSpace::CompoundVectorSpace ( const CompoundVectorSpace )
private

Copy Constructor.

Member Function Documentation

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

Method for setting the individual component VectorSpaces.

Parameters
icompNumber of the component to be set
vec_spaceVectorSpace for component icomp

Reimplemented in Ipopt::IteratesVectorSpace.

SmartPtr<const VectorSpace> Ipopt::CompoundVectorSpace::GetCompSpace ( Index  icomp) const

Method for obtaining an individual component VectorSpace.

Index Ipopt::CompoundVectorSpace::NCompSpaces ( ) const
inline

Accessor method to obtain the number of components.

Definition at line 262 of file IpCompoundVector.hpp.

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 268 of file IpCompoundVector.hpp.

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

Overloaded MakeNew method for the VectorSpace base class.

Implements Ipopt::VectorSpace.

Reimplemented in Ipopt::IteratesVectorSpace.

Definition at line 275 of file IpCompoundVector.hpp.

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

Overloaded Equals Operator.

Member Data Documentation

const Index Ipopt::CompoundVectorSpace::ncomp_spaces_
private

Number of components.

Definition at line 300 of file IpCompoundVector.hpp.

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

std::vector of vector spaces for the components

Definition at line 303 of file IpCompoundVector.hpp.


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