Package com.opengamma.strata.pricer.impl.rate

Class DispatchingRateComputationFn

java.lang.Object

com.opengamma.strata.pricer.impl.rate.DispatchingRateComputationFn

All Implemented Interfaces:

RateComputationFn<RateComputation>

public class DispatchingRateComputationFn
extends Object
implements RateComputationFn<RateComputation>

Rate computation implementation using multiple dispatch.

Dispatches the request to the correct implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static DispatchingRateComputationFn	DEFAULT	Default implementation.

Constructor Summary

Constructors

Constructor

Description

DispatchingRateComputationFn(RateComputationFn<IborRateComputation> iborRateComputationFn, RateComputationFn<IborInterpolatedRateComputation> iborInterpolatedRateComputationFn, RateComputationFn<IborAveragedRateComputation> iborAveragedRateComputationFn, RateComputationFn<OvernightCompoundedRateComputation> overnightCompoundedRateComputationFn, RateComputationFn<OvernightCompoundedAnnualRateComputation> overnightCompundedAnnualRateComputationFn, RateComputationFn<OvernightAveragedRateComputation> overnightAveragedRateComputationFn, RateComputationFn<OvernightAveragedDailyRateComputation> overnightAveragedDailyRateComputationFn, RateComputationFn<InflationMonthlyRateComputation> inflationMonthlyRateComputationFn, RateComputationFn<InflationInterpolatedRateComputation> inflationInterpolatedRateComputationFn, RateComputationFn<InflationEndMonthRateComputation> inflationEndMonthRateComputationFn, RateComputationFn<InflationEndInterpolatedRateComputation> inflationEndInterpolatedRateComputationFn)

Creates an instance.

Method Summary

Modifier and Type	Method	Description
double	explainRate(RateComputation computation, LocalDate startDate, LocalDate endDate, RatesProvider provider, ExplainMapBuilder builder)	Explains the calculation of the applicable rate.
double	rate(RateComputation computation, LocalDate startDate, LocalDate endDate, RatesProvider provider)	Determines the applicable rate for the computation.
PointSensitivityBuilder	rateSensitivity(RateComputation computation, LocalDate startDate, LocalDate endDate, RatesProvider provider)	Determines the point sensitivity for the rate computation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final DispatchingRateComputationFn DEFAULT

Default implementation.

Constructor Detail

DispatchingRateComputationFn

public DispatchingRateComputationFn(RateComputationFn<IborRateComputation> iborRateComputationFn,
                                    RateComputationFn<IborInterpolatedRateComputation> iborInterpolatedRateComputationFn,
                                    RateComputationFn<IborAveragedRateComputation> iborAveragedRateComputationFn,
                                    RateComputationFn<OvernightCompoundedRateComputation> overnightCompoundedRateComputationFn,
                                    RateComputationFn<OvernightCompoundedAnnualRateComputation> overnightCompundedAnnualRateComputationFn,
                                    RateComputationFn<OvernightAveragedRateComputation> overnightAveragedRateComputationFn,
                                    RateComputationFn<OvernightAveragedDailyRateComputation> overnightAveragedDailyRateComputationFn,
                                    RateComputationFn<InflationMonthlyRateComputation> inflationMonthlyRateComputationFn,
                                    RateComputationFn<InflationInterpolatedRateComputation> inflationInterpolatedRateComputationFn,
                                    RateComputationFn<InflationEndMonthRateComputation> inflationEndMonthRateComputationFn,
                                    RateComputationFn<InflationEndInterpolatedRateComputation> inflationEndInterpolatedRateComputationFn)

Creates an instance.

Parameters:

iborRateComputationFn - the rate provider for IborRateComputation

iborInterpolatedRateComputationFn - the rate computation for IborInterpolatedRateComputation

iborAveragedRateComputationFn - the rate computation for IborAveragedRateComputation

overnightCompoundedRateComputationFn - the rate computation for OvernightCompoundedRateComputation

overnightCompundedAnnualRateComputationFn - the rate computation for OvernightCompoundedAnnualRateComputation

overnightAveragedRateComputationFn - the rate computation for OvernightAveragedRateComputation

overnightAveragedDailyRateComputationFn - the rate computation for OvernightAveragedDailyRateComputation

inflationMonthlyRateComputationFn - the rate computation for InflationMonthlyRateComputation

inflationInterpolatedRateComputationFn - the rate computation for InflationInterpolatedRateComputation

inflationEndMonthRateComputationFn - the rate computation for InflationEndMonthRateComputation

inflationEndInterpolatedRateComputationFn - the rate computation for InflationEndInterpolatedRateComputation

Method Detail

rate

public double rate(RateComputation computation,
                   LocalDate startDate,
                   LocalDate endDate,
                   RatesProvider provider)

Description copied from interface: RateComputationFn

Determines the applicable rate for the computation.

Each type of rate has specific rules, encapsulated in RateComputation.

The start date and end date refer to the accrual period. In many cases, this information is not necessary, however it does enable some implementations that would not otherwise be possible.

Specified by:

rate in interface RateComputationFn<RateComputation>

Parameters:

computation - the computation definition

startDate - the start date of the accrual period

endDate - the end date of the accrual period

provider - the rates provider

Returns:

the applicable rate

rateSensitivity

public PointSensitivityBuilder rateSensitivity(RateComputation computation,
                                               LocalDate startDate,
                                               LocalDate endDate,
                                               RatesProvider provider)

Description copied from interface: RateComputationFn

Determines the point sensitivity for the rate computation.

This returns a sensitivity instance referring to the curves used to determine each forward rate.

Specified by:

rateSensitivity in interface RateComputationFn<RateComputation>

Parameters:

computation - the computation definition

startDate - the start date of the accrual period

endDate - the end date of the accrual period

provider - the rates provider

Returns:

the point sensitivity

explainRate

public double explainRate(RateComputation computation,
                          LocalDate startDate,
                          LocalDate endDate,
                          RatesProvider provider,
                          ExplainMapBuilder builder)

Description copied from interface: RateComputationFn

Explains the calculation of the applicable rate.

This adds information to the ExplainMapBuilder to aid understanding of the computation. The actual rate is also returned.

Specified by:

explainRate in interface RateComputationFn<RateComputation>

Parameters:

computation - the computation definition

startDate - the start date of the accrual period

endDate - the end date of the accrual period

provider - the rates provider

builder - the builder to populate

Returns:

the applicable rate