CapFloor Class Reference
[Financial instruments]

#include <ql/Instruments/capfloor.hpp>

Inheritance diagram for CapFloor:

Inheritance graph
[legend]
List of all members.

Detailed Description

Base class for cap-like instruments.

Tests:
  • the correctness of the returned value is tested by checking that the price of a cap (resp. floor) decreases (resp. increases) with the strike rate.
  • the relationship between the values of caps, floors and the resulting collars is checked.
  • the put-call parity between the values of caps, floors and swaps is checked.
  • the correctness of the returned implied volatility is tested by using it for reproducing the target value.
  • the correctness of the returned value is tested by checking it against a known good value.


Public Types

enum  Type { Cap, Floor, Collar }

Public Member Functions

 CapFloor (Type type, const std::vector< boost::shared_ptr< CashFlow > > &floatingLeg, const std::vector< Rate > &capRates, const std::vector< Rate > &floorRates, const Handle< YieldTermStructure > &termStructure, const boost::shared_ptr< PricingEngine > &engine)
void setupArguments (Arguments *) const
Volatility impliedVolatility (Real price, Real accuracy=1.0e-4, Size maxEvaluations=100, Volatility minVol=QL_MIN_VOLATILITY, Volatility maxVol=QL_MAX_VOLATILITY) const
 implied term volatility
Instrument interface
bool isExpired () const
 returns whether the instrument is still tradable.
Inspectors
Type type () const
const std::vector< boost::shared_ptr<
CashFlow > > & 
leg () const
const std::vector< Rate > & capRates () const
const std::vector< Rate > & floorRates () const
const std::vector< boost::shared_ptr<
CashFlow > > & 
floatingLeg () const

Classes

class  arguments
 Arguments for cap/floor calculation More...
class  engine
 base class for cap/floor engines More...
class  results
 Results from cap/floor calculation More...


Member Function Documentation

void setupArguments ( Arguments  )  const [virtual]

When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used.

Reimplemented from Instrument.