Public Member Functions | Private Attributes

Ipopt::DenseVectorSpace Class Reference

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

#include <IpDenseVector.hpp>

Inheritance diagram for Ipopt::DenseVectorSpace:
Ipopt::VectorSpace Ipopt::ReferencedObject

List of all members.

Public Member Functions

DenseVector * MakeNewDenseVector () const
 Method for creating a new vector of this specific type.
virtual Vector * MakeNew () const
 Instantiation of the generate MakeNew method for the VectorSpace base class.
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 (std::string tag, std::vector< std::string > meta_data)
 Set meta data of type std::string by tag.
void SetIntegerMetaData (std::string tag, std::vector< Index > meta_data)
 Set meta data of type Index by tag.
void SetNumericMetaData (std::string tag, std::vector< Number > meta_data)
 Set meta data of type Number by tag.

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 284 of file IpDenseVector.hpp.


Constructor & Destructor Documentation

Ipopt::DenseVectorSpace::DenseVectorSpace ( Index  dim  )  [inline]

Constructor, requires dimension of all vector for this VectorSpace.

Definition at line 292 of file IpDenseVector.hpp.

Ipopt::DenseVectorSpace::~DenseVectorSpace (  )  [inline]

Destructor.

Definition at line 298 of file IpDenseVector.hpp.


Member Function Documentation

DenseVector* Ipopt::DenseVectorSpace::MakeNewDenseVector (  )  const [inline]

Method for creating a new vector of this specific type.

Definition at line 303 of file IpDenseVector.hpp.

virtual Vector* Ipopt::DenseVectorSpace::MakeNew (  )  const [inline, virtual]

Instantiation of the generate MakeNew method for the VectorSpace base class.

Implements Ipopt::VectorSpace.

Definition at line 311 of file IpDenseVector.hpp.

Number * Ipopt::DenseVectorSpace::AllocateInternalStorage (  )  const [inline]

Allocate internal storage for the DenseVector.

Definition at line 400 of file IpDenseVector.hpp.

void Ipopt::DenseVectorSpace::FreeInternalStorage ( Number *  values  )  const [inline]

Deallocate internal storage for the DenseVector.

Definition at line 411 of file IpDenseVector.hpp.

bool Ipopt::DenseVectorSpace::HasStringMetaData ( const std::string  tag  )  const [inline]

Check if string meta exists for tag.

Definition at line 423 of file IpDenseVector.hpp.

bool Ipopt::DenseVectorSpace::HasIntegerMetaData ( const std::string  tag  )  const [inline]

Check if Integer meta exists for tag.

Definition at line 436 of file IpDenseVector.hpp.

bool Ipopt::DenseVectorSpace::HasNumericMetaData ( const std::string  tag  )  const [inline]

Check if Numeric meta exists for tag.

Definition at line 449 of file IpDenseVector.hpp.

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 462 of file IpDenseVector.hpp.

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

Get meta data of type Index by tag.

Definition at line 471 of file IpDenseVector.hpp.

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

Get meta data of type Number by tag.

Definition at line 480 of file IpDenseVector.hpp.

void Ipopt::DenseVectorSpace::SetStringMetaData ( std::string  tag,
std::vector< std::string >  meta_data 
) [inline]

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

Definition at line 489 of file IpDenseVector.hpp.

void Ipopt::DenseVectorSpace::SetIntegerMetaData ( std::string  tag,
std::vector< Index >  meta_data 
) [inline]

Set meta data of type Index by tag.

Definition at line 495 of file IpDenseVector.hpp.

void Ipopt::DenseVectorSpace::SetNumericMetaData ( std::string  tag,
std::vector< Number >  meta_data 
) [inline]

Set meta data of type Number by tag.

Definition at line 501 of file IpDenseVector.hpp.


Member Data Documentation


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