RMOL Logo Get Revenue Management Optimisation Library at SourceForge.net. Fast, secure and Free Open Source software downloads

RMOL::PartialSumHolder Class Reference

#include <rmol/bom/PartialSumHolder.hpp>

Inheritance diagram for RMOL::PartialSumHolder:
RMOL::BomAbstract

List of all members.

Public Member Functions

const double getPartialSum (const int k) const
const int getLowerBound (const double &value) const
void initSize (const int K)
void addPartialSum (const double iPartialSum)
void sort ()
void toStream (std::ostream &) const
void fromStream (std::istream &)
std::string toString () const
const std::string describeKey () const
const std::string describeShortKey () const
const std::string display () const
const std::string shortDisplay () const

Friends

class FacPartialSumHolder

Detailed Description

Holder of a PartialSumList object (for memory allocation and recollection purposes).

Definition at line 17 of file PartialSumHolder.hpp.


Member Function Documentation

const double RMOL::PartialSumHolder::getPartialSum ( const int  k  )  const

Get the k-th element (partial sum).

Definition at line 83 of file PartialSumHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

const int RMOL::PartialSumHolder::getLowerBound ( const double &  value  )  const

Get the position of the first element that is equal or greater than the given value.

Definition at line 98 of file PartialSumHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

void RMOL::PartialSumHolder::initSize ( const int  K  ) 

Reserve the space for K elements (partial sums).

Definition at line 78 of file PartialSumHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

void RMOL::PartialSumHolder::addPartialSum ( const double  iPartialSum  ) 

Add an element (partial sum).

Definition at line 88 of file PartialSumHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

void RMOL::PartialSumHolder::sort (  ) 

Sort the elements (partial sums). The STL implements the introsort algorithm, which has a worst case complexity of O (N log N): http://www.sgi.com/tech/stl/sort.html .

Definition at line 93 of file PartialSumHolder.cpp.

Referenced by RMOL::MCOptimiser::optimalOptimisationByMCIntegration().

void RMOL::PartialSumHolder::toStream ( std::ostream &  ioOut  )  const [virtual]

Dump a Business Object into an output stream.

Parameters:
ostream& the output stream.

Implements RMOL::BomAbstract.

Definition at line 47 of file PartialSumHolder.cpp.

References toString().

void RMOL::PartialSumHolder::fromStream ( std::istream &  ioIn  )  [virtual]

Read a Business Object from an input stream.

Parameters:
istream& the input stream.

Implements RMOL::BomAbstract.

Definition at line 52 of file PartialSumHolder.cpp.

std::string RMOL::PartialSumHolder::toString (  )  const [virtual]

Get the serialised version of the Place object.

Implements RMOL::BomAbstract.

Definition at line 40 of file PartialSumHolder.cpp.

Referenced by toStream().

const std::string RMOL::PartialSumHolder::describeKey (  )  const [virtual]

Get a string describing the whole key (differentiating two objects at any level).

Implements RMOL::BomAbstract.

Definition at line 35 of file PartialSumHolder.cpp.

References describeShortKey().

Referenced by shortDisplay().

const std::string RMOL::PartialSumHolder::describeShortKey (  )  const [virtual]

Get a string describing the short key (differentiating two objects at the same level).

Implements RMOL::BomAbstract.

Definition at line 29 of file PartialSumHolder.cpp.

Referenced by describeKey().

const std::string RMOL::PartialSumHolder::display (  )  const

Display the full Place context.

Definition at line 65 of file PartialSumHolder.cpp.

References shortDisplay().

Referenced by RMOL::PartialSumHolderHolder::display().

const std::string RMOL::PartialSumHolder::shortDisplay (  )  const

Display a short Place context.

Definition at line 56 of file PartialSumHolder.cpp.

References describeKey().

Referenced by display().


Friends And Related Function Documentation

friend class FacPartialSumHolder [friend]

Friend Classes
Those classes need to access the internal attributes of this object in order to construct and initialise it.

Definition at line 21 of file PartialSumHolder.hpp.


The documentation for this class was generated from the following files:
SourceForge Logo

Generated on Fri Jul 30 22:23:19 2010 for RMOL by Doxygen 1.6.1