/**
* Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.measure.index;
import com.opengamma.strata.basics.currency.CurrencyAmount;
import com.opengamma.strata.basics.currency.MultiCurrencyAmount;
import com.opengamma.strata.data.scenario.CurrencyScenarioArray;
import com.opengamma.strata.data.scenario.DoubleScenarioArray;
import com.opengamma.strata.data.scenario.MultiCurrencyScenarioArray;
import com.opengamma.strata.data.scenario.ScenarioArray;
import com.opengamma.strata.data.scenario.ScenarioMarketData;
import com.opengamma.strata.market.param.CurrencyParameterSensitivities;
import com.opengamma.strata.measure.rate.RatesMarketDataLookup;
import com.opengamma.strata.pricer.index.DiscountingIborFutureTradePricer;
import com.opengamma.strata.pricer.rate.RatesProvider;
import com.opengamma.strata.product.index.IborFutureTrade;
import com.opengamma.strata.product.index.ResolvedIborFutureTrade;
/**
* Calculates pricing and risk measures for trades in a futures contract based on an Ibor index.
* <p>
* This provides a high-level entry point for future pricing and risk measures.
* <p>
* Each method takes a {@link ResolvedIborFutureTrade}, whereas application code will
* typically work with {@link IborFutureTrade}. Call
* {@link IborFutureTrade#resolve(com.opengamma.strata.basics.ReferenceData) IborFutureTrade::resolve(ReferenceData)}
* to convert {@code IborFutureTrade} to {@code ResolvedIborFutureTrade}.
*
* <h4>Price</h4>
* The price of an Ibor future is based on the interest rate of the underlying index.
* It is defined as {@code (100 - percentRate)}.
* <p>
* Strata uses <i>decimal prices</i> for Ibor futures in the trade model, pricers and market data.
* The decimal price is based on the decimal rate equivalent to the percentage.
* For example, a price of 99.32 implies an interest rate of 0.68% which is represented in Strata by 0.9932.
*/
public class IborFutureTradeCalculations {
/**
* Default implementation.
*/
public static final IborFutureTradeCalculations DEFAULT = new IborFutureTradeCalculations(
DiscountingIborFutureTradePricer.DEFAULT);
/**
* Pricer for {@link ResolvedIborFutureTrade}.
*/
private final IborFutureMeasureCalculations calc;
/**
* Creates an instance.
* <p>
* In most cases, applications should use the {@link #DEFAULT} instance.
*
* @param tradePricer the pricer for {@link ResolvedIborFutureTrade}
*/
public IborFutureTradeCalculations(
DiscountingIborFutureTradePricer tradePricer) {
this.calc = new IborFutureMeasureCalculations(tradePricer);
}
//-------------------------------------------------------------------------
/**
* Calculates present value across one or more scenarios.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the present value, one entry per scenario
*/
public CurrencyScenarioArray presentValue(
ResolvedIborFutureTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.presentValue(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value for a single set of market data.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the present value
*/
public CurrencyAmount presentValue(
ResolvedIborFutureTrade trade,
RatesProvider ratesProvider) {
return calc.presentValue(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the calibrated curves.
* The result is the sum of the sensitivities of all affected curves.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the present value sensitivity, one entry per scenario
*/
public MultiCurrencyScenarioArray pv01CalibratedSum(
ResolvedIborFutureTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01CalibratedSum(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the calibrated curves.
* The result is the sum of the sensitivities of all affected curves.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the present value sensitivity
*/
public MultiCurrencyAmount pv01CalibratedSum(
ResolvedIborFutureTrade trade,
RatesProvider ratesProvider) {
return calc.pv01CalibratedSum(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the calibrated curves.
* The result is provided for each affected curve and currency, bucketed by curve node.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the present value sensitivity, one entry per scenario
*/
public ScenarioArray<CurrencyParameterSensitivities> pv01CalibratedBucketed(
ResolvedIborFutureTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01CalibratedBucketed(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the calibrated curves.
* The result is provided for each affected curve and currency, bucketed by curve node.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the present value sensitivity
*/
public CurrencyParameterSensitivities pv01CalibratedBucketed(
ResolvedIborFutureTrade trade,
RatesProvider ratesProvider) {
return calc.pv01CalibratedBucketed(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the market quotes used to calibrate the curves.
* The result is the sum of the sensitivities of all affected curves.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the present value sensitivity, one entry per scenario
*/
public MultiCurrencyScenarioArray pv01MarketQuoteSum(
ResolvedIborFutureTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01MarketQuoteSum(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the market quotes used to calibrate the curves.
* The result is the sum of the sensitivities of all affected curves.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the present value sensitivity
*/
public MultiCurrencyAmount pv01MarketQuoteSum(
ResolvedIborFutureTrade trade,
RatesProvider ratesProvider) {
return calc.pv01MarketQuoteSum(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the market quotes used to calibrate the curves.
* The result is provided for each affected curve and currency, bucketed by curve node.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the present value sensitivity, one entry per scenario
*/
public ScenarioArray<CurrencyParameterSensitivities> pv01MarketQuoteBucketed(
ResolvedIborFutureTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01MarketQuoteBucketed(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
* <p>
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedIborFutureTrade, RatesMarketDataLookup, ScenarioMarketData) present value}
* to a one basis point shift in the market quotes used to calibrate the curves.
* The result is provided for each affected curve and currency, bucketed by curve node.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the present value sensitivity
*/
public CurrencyParameterSensitivities pv01MarketQuoteBucketed(
ResolvedIborFutureTrade trade,
RatesProvider ratesProvider) {
return calc.pv01MarketQuoteBucketed(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates par spread across one or more scenarios.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the par spread, one entry per scenario
*/
public DoubleScenarioArray parSpread(
ResolvedIborFutureTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.parSpread(trade, lookup.marketDataView(marketData));
}
/**
* Calculates par spread for a single set of market data.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the par spread
*/
public double parSpread(
ResolvedIborFutureTrade trade,
RatesProvider ratesProvider) {
return calc.parSpread(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates unit price across one or more scenarios.
* <p>
* This is the price of a single unit of the security.
* <p>
* Strata uses <i>decimal prices</i> for Ibor futures in the trade model, pricers and market data.
* The decimal price is based on the decimal rate equivalent to the percentage.
* For example, a price of 99.32 implies an interest rate of 0.68% which is represented in Strata by 0.9932.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the present value, one entry per scenario
*/
public DoubleScenarioArray unitPrice(
ResolvedIborFutureTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.unitPrice(trade, lookup.marketDataView(marketData));
}
/**
* Calculates unit price for a single set of market data.
* <p>
* This is the price of a single unit of the security.
* <p>
* Strata uses <i>decimal prices</i> for Ibor futures in the trade model, pricers and market data.
* The decimal price is based on the decimal rate equivalent to the percentage.
* For example, a price of 99.32 implies an interest rate of 0.68% which is represented in Strata by 0.9932.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the present value
*/
public double unitPrice(
ResolvedIborFutureTrade trade,
RatesProvider ratesProvider) {
return calc.unitPrice(trade, ratesProvider);
}
}