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

#include <IpDenseVector.hpp>

Inheritance diagram for Ipopt::DenseVectorSpace:

Public Member Functions
DenseVector *	MakeNewDenseVector () 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.
	DenseVectorSpace (Index dim)
	Constructor, requires dimension of all vector for this VectorSpace.

	~DenseVectorSpace ()
	Destructor.

Methods called by DenseVector for memory management.
This could allow to have sophisticated memory management in the VectorSpace.
Number *	AllocateInternalStorage () const
	Allocate internal storage for the DenseVector.

void	FreeInternalStorage (Number *values) const
	Deallocate internal storage for the DenseVector.

Methods for dealing with meta data on the vector
bool	HasStringMetaData (const std::string &tag) const
	Check if string meta exists for tag.

bool	HasIntegerMetaData (const std::string &tag) const
	Check if Integer meta exists for tag.

bool	HasNumericMetaData (const std::string &tag) const
	Check if Numeric meta exists for tag.

const std::vector< std::string > &	GetStringMetaData (const std::string &tag) const
	Get meta data of type std::string by tag.

const std::vector< Index > &	GetIntegerMetaData (const std::string &tag) const
	Get meta data of type Index by tag.

const std::vector< Number > &	GetNumericMetaData (const std::string &tag) const
	Get meta data of type Number by tag.

void	SetStringMetaData (const std::string &tag, const std::vector< std::string > &meta_data)
	Set meta data of type std::string by tag.

void	SetIntegerMetaData (const std::string &tag, const std::vector< Index > &meta_data)
	Set meta data of type Index by tag.

void	SetNumericMetaData (const std::string &tag, const std::vector< Number > &meta_data)
	Set meta data of type Number by tag.

const StringMetaDataMapType &	GetStringMetaData () const
	Get map of meta data of type Number.

const IntegerMetaDataMapType &	GetIntegerMetaData () const
	Get map of meta data of type Number.

const NumericMetaDataMapType &	GetNumericMetaData () const
	Get map of meta data of type Number.

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 Attributes
StringMetaDataMapType	string_meta_data_

IntegerMetaDataMapType	integer_meta_data_

NumericMetaDataMapType	numeric_meta_data_

Detailed Description

This vectors space is the vector space for DenseVector.

Definition at line 333 of file IpDenseVector.hpp.

Constructor & Destructor Documentation

◆ DenseVectorSpace()

Ipopt::DenseVectorSpace::DenseVectorSpace ( Index dim )

inline

Constructor, requires dimension of all vector for this VectorSpace.

Definition at line 339 of file IpDenseVector.hpp.

◆ ~DenseVectorSpace()

Ipopt::DenseVectorSpace::~DenseVectorSpace ( )

inline

Destructor.

Definition at line 346 of file IpDenseVector.hpp.

Member Function Documentation

◆ MakeNewDenseVector()

DenseVector * Ipopt::DenseVectorSpace::MakeNewDenseVector ( ) const

inline

Method for creating a new vector of this specific type.

Definition at line 351 of file IpDenseVector.hpp.

◆ MakeNew()

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

inlinevirtual

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

Implements Ipopt::VectorSpace.

Definition at line 356 of file IpDenseVector.hpp.

◆ AllocateInternalStorage()

Number * Ipopt::DenseVectorSpace::AllocateInternalStorage ( ) const

inline

Allocate internal storage for the DenseVector.

Definition at line 483 of file IpDenseVector.hpp.

◆ FreeInternalStorage()

void Ipopt::DenseVectorSpace::FreeInternalStorage ( Number * values ) const

inline

Deallocate internal storage for the DenseVector.

Definition at line 496 of file IpDenseVector.hpp.

◆ HasStringMetaData()

bool Ipopt::DenseVectorSpace::HasStringMetaData ( const std::string & tag ) const

inline

Check if string meta exists for tag.

Definition at line 509 of file IpDenseVector.hpp.

◆ HasIntegerMetaData()

bool Ipopt::DenseVectorSpace::HasIntegerMetaData ( const std::string & tag ) const

inline

Check if Integer meta exists for tag.

Definition at line 525 of file IpDenseVector.hpp.

◆ HasNumericMetaData()

bool Ipopt::DenseVectorSpace::HasNumericMetaData ( const std::string & tag ) const

inline

Check if Numeric meta exists for tag.

Definition at line 541 of file IpDenseVector.hpp.

◆ GetStringMetaData() [1/2]

const std::vector< std::string > & Ipopt::DenseVectorSpace::GetStringMetaData ( const std::string & tag ) const

inline

Get meta data of type std::string by tag.

Definition at line 556 of file IpDenseVector.hpp.

◆ GetIntegerMetaData() [1/2]

const std::vector< Index > & Ipopt::DenseVectorSpace::GetIntegerMetaData ( const std::string & tag ) const

inline

Get meta data of type Index by tag.

Definition at line 566 of file IpDenseVector.hpp.

◆ GetNumericMetaData() [1/2]

const std::vector< Number > & Ipopt::DenseVectorSpace::GetNumericMetaData ( const std::string & tag ) const

inline

Get meta data of type Number by tag.

Definition at line 576 of file IpDenseVector.hpp.

◆ SetStringMetaData()

void Ipopt::DenseVectorSpace::SetStringMetaData	(	const std::string &	tag,
		const std::vector< std::string > &	meta_data
	)

inline

Set meta data of type std::string by tag.

Definition at line 586 of file IpDenseVector.hpp.

◆ SetIntegerMetaData()

void Ipopt::DenseVectorSpace::SetIntegerMetaData	(	const std::string &	tag,
		const std::vector< Index > &	meta_data
	)

inline

Set meta data of type Index by tag.

Definition at line 594 of file IpDenseVector.hpp.

◆ SetNumericMetaData()

void Ipopt::DenseVectorSpace::SetNumericMetaData	(	const std::string &	tag,
		const std::vector< Number > &	meta_data
	)

inline

Set meta data of type Number by tag.

Definition at line 602 of file IpDenseVector.hpp.

◆ GetStringMetaData() [2/2]

const StringMetaDataMapType & Ipopt::DenseVectorSpace::GetStringMetaData ( ) const

inline

Get map of meta data of type Number.

Definition at line 610 of file IpDenseVector.hpp.

◆ GetIntegerMetaData() [2/2]

const IntegerMetaDataMapType & Ipopt::DenseVectorSpace::GetIntegerMetaData ( ) const

inline

Get map of meta data of type Number.

Definition at line 615 of file IpDenseVector.hpp.

◆ GetNumericMetaData() [2/2]

const NumericMetaDataMapType & Ipopt::DenseVectorSpace::GetNumericMetaData ( ) const

inline

Get map of meta data of type Number.

Definition at line 620 of file IpDenseVector.hpp.

Member Data Documentation

◆ string_meta_data_

StringMetaDataMapType Ipopt::DenseVectorSpace::string_meta_data_

private

Definition at line 442 of file IpDenseVector.hpp.

◆ integer_meta_data_

IntegerMetaDataMapType Ipopt::DenseVectorSpace::integer_meta_data_

private

Definition at line 443 of file IpDenseVector.hpp.

◆ numeric_meta_data_

NumericMetaDataMapType Ipopt::DenseVectorSpace::numeric_meta_data_

private

Definition at line 444 of file IpDenseVector.hpp.

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

src/LinAlg/IpDenseVector.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DenseVectorSpace()

◆ ~DenseVectorSpace()

Member Function Documentation

◆ MakeNewDenseVector()

◆ MakeNew()

◆ AllocateInternalStorage()

◆ FreeInternalStorage()

◆ HasStringMetaData()

◆ HasIntegerMetaData()

◆ HasNumericMetaData()

◆ GetStringMetaData() [1/2]

◆ GetIntegerMetaData() [1/2]

◆ GetNumericMetaData() [1/2]

◆ SetStringMetaData()

◆ SetIntegerMetaData()

◆ SetNumericMetaData()

◆ GetStringMetaData() [2/2]

◆ GetIntegerMetaData() [2/2]

◆ GetNumericMetaData() [2/2]

Member Data Documentation

◆ string_meta_data_

◆ integer_meta_data_

◆ numeric_meta_data_