Ipopt::VectorSpace Class Reference

VectorSpace base class, corresponding to the Vector base class. More...

#include <IpVector.hpp>

Inheritance diagram for Ipopt::VectorSpace:

Public Member Functions
virtual Vector *	MakeNew () const =0
	Pure virtual method for creating a new Vector of the corresponding type.
Index	Dim () const
	Accessor function for the dimension of the vectors of this type.
Constructors/Destructors
	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.
	VectorSpace ()
	Default constructor.
	VectorSpace (const VectorSpace &)
	Copy constructor.
VectorSpace &	operator= (const VectorSpace &)
	Default Assignment Operator.

Private Attributes
const Index	dim_
	Dimension of the vectors in this vector space.

Detailed Description

VectorSpace base class, corresponding to the Vector base class.

For each Vector implementation, a corresponding VectorSpace has to be implemented. A VectorSpace is able to create new Vectors of a specific type. The VectorSpace should also store information that is common to all Vectors of that type. For example, the dimension of a Vector is stored in the VectorSpace base class.

Definition at line 472 of file IpVector.hpp.

Constructor & Destructor Documentation

VectorSpace() [1/3]

Ipopt::VectorSpace::VectorSpace ( Index  dim )

inline

Constructor, given the dimension of all vectors generated by this VectorSpace.

Definition at line 868 of file IpVector.hpp.

~VectorSpace()

virtual Ipopt::VectorSpace::~VectorSpace ( )

inlinevirtual

Destructor.

Definition at line 485 of file IpVector.hpp.

VectorSpace() [2/3]

Ipopt::VectorSpace::VectorSpace ( )

private

Default constructor.

VectorSpace() [3/3]

Ipopt::VectorSpace::VectorSpace ( const VectorSpace &  )

private

Copy constructor.

Member Function Documentation

MakeNew()

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

pure virtual

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

Implemented in Ipopt::IteratesVectorSpace, Ipopt::CompoundVectorSpace, and Ipopt::DenseVectorSpace.

Dim()

Index Ipopt::VectorSpace::Dim ( ) const

inline

Accessor function for the dimension of the vectors of this type.

Definition at line 495 of file IpVector.hpp.

operator=()

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

private

Default Assignment Operator.

Member Data Documentation

dim_

const Index Ipopt::VectorSpace::dim_

private

Dimension of the vectors in this vector space.

Definition at line 525 of file IpVector.hpp.

---

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

• src/LinAlg/IpVector.hpp