QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Private Attributes | List of all members
EvolutionDescription Class Reference

Market-model evolution description. More...

#include <evolutiondescription.hpp>

+ Collaboration diagram for EvolutionDescription:

Public Member Functions

 EvolutionDescription ()=default
 
 EvolutionDescription (const std::vector< Time > &rateTimes, const std::vector< Time > &evolutionTimes=std::vector< Time >(), const std::vector< std::pair< Size, Size > > &relevanceRates=std::vector< range >())
 
const std::vector< Time > & rateTimes () const
 
const std::vector< Time > & rateTaus () const
 
const std::vector< Time > & evolutionTimes () const
 
const std::vector< Size > & firstAliveRate () const
 
const std::vector< std::pair< Size, Size > > & relevanceRates () const
 
Size numberOfRates () const
 
Size numberOfSteps () const
 

Private Types

typedef std::pair< Size, Sizerange
 

Private Attributes

Size numberOfRates_
 
std::vector< TimerateTimes_
 
std::vector< TimeevolutionTimes_
 
std::vector< std::pair< Size, Size > > relevanceRates_
 
std::vector< TimerateTaus_
 
std::vector< SizefirstAliveRate_
 

Detailed Description

Market-model evolution description.

This class stores:

  1. evolutionTimes = the times at which the rates need to be known,
  2. rateTimes = the times defining the rates that are to be evolved,
  3. relevanceRates = which rates need to be known at each time.

This class is really just a tuple of evolution and rate times;

Examples
MarketModels.cpp.

Definition at line 54 of file evolutiondescription.hpp.

Member Typedef Documentation

◆ range

typedef std::pair<Size,Size> range
private

Definition at line 58 of file evolutiondescription.hpp.

Constructor & Destructor Documentation

◆ EvolutionDescription() [1/2]

EvolutionDescription ( )
default

◆ EvolutionDescription() [2/2]

EvolutionDescription ( const std::vector< Time > &  rateTimes,
const std::vector< Time > &  evolutionTimes = std::vector<Time>(),
const std::vector< std::pair< Size, Size > > &  relevanceRates = std::vector<range>() 
)
explicit

Definition at line 31 of file evolutiondescription.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ rateTimes()

const std::vector< Time > & rateTimes ( ) const

Definition at line 79 of file evolutiondescription.cpp.

+ Here is the caller graph for this function:

◆ rateTaus()

const std::vector< Time > & rateTaus ( ) const

Definition at line 83 of file evolutiondescription.cpp.

+ Here is the caller graph for this function:

◆ evolutionTimes()

const std::vector< Time > & evolutionTimes ( ) const
Examples
MarketModels.cpp.

Definition at line 87 of file evolutiondescription.cpp.

+ Here is the caller graph for this function:

◆ firstAliveRate()

const std::vector< Size > & firstAliveRate ( ) const

Definition at line 95 of file evolutiondescription.cpp.

+ Here is the caller graph for this function:

◆ relevanceRates()

const std::vector< std::pair< Size, Size > > & relevanceRates ( ) const

Definition at line 99 of file evolutiondescription.cpp.

+ Here is the caller graph for this function:

◆ numberOfRates()

Size numberOfRates ( ) const

Definition at line 103 of file evolutiondescription.cpp.

+ Here is the caller graph for this function:

◆ numberOfSteps()

Size numberOfSteps ( ) const

Definition at line 107 of file evolutiondescription.cpp.

+ Here is the caller graph for this function:

Member Data Documentation

◆ numberOfRates_

Size numberOfRates_
private

Definition at line 75 of file evolutiondescription.hpp.

◆ rateTimes_

std::vector<Time> rateTimes_
private

Definition at line 76 of file evolutiondescription.hpp.

◆ evolutionTimes_

std::vector<Time> evolutionTimes_
private

Definition at line 76 of file evolutiondescription.hpp.

◆ relevanceRates_

std::vector<std::pair<Size,Size> > relevanceRates_
private

Definition at line 77 of file evolutiondescription.hpp.

◆ rateTaus_

std::vector<Time> rateTaus_
private

Definition at line 79 of file evolutiondescription.hpp.

◆ firstAliveRate_

std::vector<Size> firstAliveRate_
private

Definition at line 80 of file evolutiondescription.hpp.