com.opengamma.strata.measure.fx.FxSingleTradeCalculations Maven / Gradle / Ivy
/*
* Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.measure.fx;
import com.opengamma.strata.basics.currency.FxRate;
import com.opengamma.strata.basics.currency.MultiCurrencyAmount;
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.fx.DiscountingFxSingleTradePricer;
import com.opengamma.strata.pricer.rate.RatesProvider;
import com.opengamma.strata.product.fx.FxSingleTrade;
import com.opengamma.strata.product.fx.ResolvedFxSingleTrade;
/**
* Calculates pricing and risk measures for single FX trades.
*
* This provides a high-level entry point for FX pricing and risk measures.
*
* Each method takes a {@link ResolvedFxSingleTrade}, whereas application code will
* typically work with {@link FxSingleTrade}. Call
* {@link FxSingleTrade#resolve(com.opengamma.strata.basics.ReferenceData) FxSingleTrade::resolve(ReferenceData)}
* to convert {@code FxSingleTrade} to {@code ResolvedFxSingleTrade}.
*/
public class FxSingleTradeCalculations {
/**
* Default implementation.
*/
public static final FxSingleTradeCalculations DEFAULT = new FxSingleTradeCalculations(
DiscountingFxSingleTradePricer.DEFAULT);
/**
* Pricer for {@link ResolvedFxSingleTrade}.
*/
private final FxSingleMeasureCalculations calc;
/**
* Creates an instance.
*
* In most cases, applications should use the {@link #DEFAULT} instance.
*
* @param tradePricer the pricer for {@link ResolvedFxSingleTrade}
*/
public FxSingleTradeCalculations(
DiscountingFxSingleTradePricer tradePricer) {
this.calc = new FxSingleMeasureCalculations(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 MultiCurrencyScenarioArray presentValue(
ResolvedFxSingleTrade 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 MultiCurrencyAmount presentValue(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.presentValue(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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(
ResolvedFxSingleTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01CalibratedSum(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.pv01CalibratedSum(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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 pv01CalibratedBucketed(
ResolvedFxSingleTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01CalibratedBucketed(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.pv01CalibratedBucketed(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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(
ResolvedFxSingleTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01MarketQuoteSum(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.pv01MarketQuoteSum(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates present value sensitivity across one or more scenarios.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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 pv01MarketQuoteBucketed(
ResolvedFxSingleTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.pv01MarketQuoteBucketed(trade, lookup.marketDataView(marketData));
}
/**
* Calculates present value sensitivity for a single set of market data.
*
* This is the sensitivity of
* {@linkplain #presentValue(ResolvedFxSingleTrade, 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(
ResolvedFxSingleTrade 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(
ResolvedFxSingleTrade 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(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.parSpread(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates currency exposure across one or more scenarios.
*
* The currency risk, expressed as the equivalent amount in each currency.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the currency exposure, one entry per scenario
*/
public MultiCurrencyScenarioArray currencyExposure(
ResolvedFxSingleTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.currencyExposure(trade, lookup.marketDataView(marketData));
}
/**
* Calculates currency exposure for a single set of market data.
*
* The currency risk, expressed as the equivalent amount in each currency.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the currency exposure
*/
public MultiCurrencyAmount currencyExposure(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.currencyExposure(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates current cash across one or more scenarios.
*
* The sum of all cash flows paid on the valuation date.
*
* @param trade the trade
* @param lookup the lookup used to query the market data
* @param marketData the market data
* @return the current cash, one entry per scenario
*/
public MultiCurrencyScenarioArray currentCash(
ResolvedFxSingleTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.currentCash(trade, lookup.marketDataView(marketData));
}
/**
* Calculates current cash for a single set of market data.
*
* The sum of all cash flows paid on the valuation date.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the current cash
*/
public MultiCurrencyAmount currentCash(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.currentCash(trade, ratesProvider);
}
//-------------------------------------------------------------------------
/**
* Calculates the forward FX rate 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 current cash, one entry per scenario
*/
public ScenarioArray forwardFxRate(
ResolvedFxSingleTrade trade,
RatesMarketDataLookup lookup,
ScenarioMarketData marketData) {
return calc.forwardFxRate(trade, lookup.marketDataView(marketData));
}
/**
* Calculates the forward FX rate for a single set of market data.
*
* @param trade the trade
* @param ratesProvider the market data
* @return the current cash
*/
public FxRate forwardFxRate(
ResolvedFxSingleTrade trade,
RatesProvider ratesProvider) {
return calc.forwardFxRate(trade, ratesProvider);
}
}