Ipopt::DenseVectorSpace Class Reference

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

#include <IpDenseVector.hpp>

Inheritance diagram for Ipopt::DenseVectorSpace:

Inheritance graph
[legend]
Collaboration diagram for Ipopt::DenseVectorSpace:

Collaboration graph
[legend]
List of all members.

Public Member Functions

DenseVectorMakeNewDenseVector () const
 Method for creating a new vector of this specific type.
virtual VectorMakeNew () 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.

NumberAllocateInternalStorage () 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.
const StringMetaDataMapTypeGetStringMetaData () const
 Get map of meta data of type Number.
const IntegerMetaDataMapTypeGetIntegerMetaData () const
 Get map of meta data of type Number.
const NumericMetaDataMapTypeGetNumericMetaData () const
 Get map of meta data of type Number.

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.

Referenced by MakeNew(), and Ipopt::DenseVector::MakeNewDenseVector().

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.

References MakeNewDenseVector().

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

Allocate internal storage for the DenseVector.

Definition at line 409 of file IpDenseVector.hpp.

References Ipopt::VectorSpace::Dim().

Referenced by Ipopt::DenseVector::values_allocated().

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

Deallocate internal storage for the DenseVector.

Definition at line 420 of file IpDenseVector.hpp.

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

Check if string meta exists for tag.

Definition at line 432 of file IpDenseVector.hpp.

References string_meta_data_.

Referenced by GetStringMetaData().

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

Check if Integer meta exists for tag.

Definition at line 445 of file IpDenseVector.hpp.

References integer_meta_data_.

Referenced by GetIntegerMetaData().

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

Check if Numeric meta exists for tag.

Definition at line 458 of file IpDenseVector.hpp.

References numeric_meta_data_.

Referenced by GetNumericMetaData().

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

References DBG_ASSERT, HasStringMetaData(), and string_meta_data_.

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

Get meta data of type Index by tag.

Definition at line 480 of file IpDenseVector.hpp.

References DBG_ASSERT, HasIntegerMetaData(), and integer_meta_data_.

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

Get meta data of type Number by tag.

Definition at line 489 of file IpDenseVector.hpp.

References DBG_ASSERT, HasNumericMetaData(), and numeric_meta_data_.

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

References string_meta_data_.

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

Set meta data of type Index by tag.

Definition at line 504 of file IpDenseVector.hpp.

References integer_meta_data_.

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

Set meta data of type Number by tag.

Definition at line 510 of file IpDenseVector.hpp.

References numeric_meta_data_.

const StringMetaDataMapType & Ipopt::DenseVectorSpace::GetStringMetaData (  )  const [inline]

Get map of meta data of type Number.

Definition at line 516 of file IpDenseVector.hpp.

References string_meta_data_.

const IntegerMetaDataMapType & Ipopt::DenseVectorSpace::GetIntegerMetaData (  )  const [inline]

Get map of meta data of type Number.

Definition at line 522 of file IpDenseVector.hpp.

References integer_meta_data_.

const NumericMetaDataMapType & Ipopt::DenseVectorSpace::GetNumericMetaData (  )  const [inline]

Get map of meta data of type Number.

Definition at line 528 of file IpDenseVector.hpp.

References numeric_meta_data_.


Member Data Documentation

StringMetaDataMapType Ipopt::DenseVectorSpace::string_meta_data_ [private]

Definition at line 370 of file IpDenseVector.hpp.

Referenced by GetStringMetaData(), HasStringMetaData(), and SetStringMetaData().

IntegerMetaDataMapType Ipopt::DenseVectorSpace::integer_meta_data_ [private]

Definition at line 371 of file IpDenseVector.hpp.

Referenced by GetIntegerMetaData(), HasIntegerMetaData(), and SetIntegerMetaData().

NumericMetaDataMapType Ipopt::DenseVectorSpace::numeric_meta_data_ [private]

Definition at line 372 of file IpDenseVector.hpp.

Referenced by GetNumericMetaData(), HasNumericMetaData(), and SetNumericMetaData().


The documentation for this class was generated from the following file:
Generated on Sat Nov 6 03:13:41 2010 by  doxygen 1.4.7