Period Class Reference
[Date and time calculations]

#include <ql/time/period.hpp>

List of all members.


Detailed Description

This class provides a Period (length + TimeUnit) class and implements a limited algebra.

Tests:
self-consistency of algebra is checked.
Examples:

BermudanSwaption.cpp, ConvertibleBonds.cpp, FittedBondCurve.cpp, Repo.cpp, and swapvaluation.cpp.


Public Member Functions

 Period (Integer n, TimeUnit units)
 Period (Frequency f)
Integer length () const
TimeUnit units () const
Frequency frequency () const
Periodoperator+= (const Period &)
Periodoperator-= (const Period &)
Periodoperator/= (Integer)
void normalize ()

Related Functions

(Note that these are not member functions.)

template<typename T>
Period operator * (T n, TimeUnit units)
template<typename T>
Period operator * (TimeUnit units, T n)
Period operator- (const Period &)
Period operator * (Integer n, const Period &)
Period operator * (const Period &, Integer n)
Period operator/ (const Period &, Integer n)
Period operator+ (const Period &, const Period &)
Period operator- (const Period &, const Period &)
bool operator< (const Period &, const Period &)
bool operator== (const Period &, const Period &)
bool operator!= (const Period &, const Period &)
bool operator> (const Period &, const Period &)
bool operator<= (const Period &, const Period &)
bool operator>= (const Period &, const Period &)
std::ostream & operator<< (std::ostream &, const Period &)

Friends And Related Function Documentation

Period operator * ( n,
TimeUnit  units 
) [related]

Period operator * ( TimeUnit  units,
n 
) [related]

Period operator- ( const Period  )  [related]

Period operator * ( Integer  n,
const Period  
) [related]

Period operator * ( const Period ,
Integer  n 
) [related]

Period operator/ ( const Period ,
Integer  n 
) [related]

Period operator+ ( const Period ,
const Period  
) [related]

Period operator- ( const Period ,
const Period  
) [related]

bool operator< ( const Period ,
const Period  
) [related]

bool operator== ( const Period ,
const Period  
) [related]

bool operator!= ( const Period ,
const Period  
) [related]

bool operator> ( const Period ,
const Period  
) [related]

bool operator<= ( const Period ,
const Period  
) [related]

bool operator>= ( const Period ,
const Period  
) [related]

std::ostream & operator<< ( std::ostream &  ,
const Period  
) [related]