/**
* Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.measure.bond;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.opengamma.strata.basics.ReferenceData;
import com.opengamma.strata.basics.StandardId;
import com.opengamma.strata.basics.currency.Currency;
import com.opengamma.strata.calc.Measure;
import com.opengamma.strata.calc.runner.CalculationFunction;
import com.opengamma.strata.calc.runner.CalculationParameters;
import com.opengamma.strata.calc.runner.FunctionRequirements;
import com.opengamma.strata.collect.result.FailureReason;
import com.opengamma.strata.collect.result.Result;
import com.opengamma.strata.data.scenario.ScenarioMarketData;
import com.opengamma.strata.measure.Measures;
import com.opengamma.strata.measure.rate.RatesMarketDataLookup;
import com.opengamma.strata.measure.rate.RatesScenarioMarketData;
import com.opengamma.strata.product.SecurityId;
import com.opengamma.strata.product.bond.CapitalIndexedBond;
import com.opengamma.strata.product.bond.CapitalIndexedBondTrade;
import com.opengamma.strata.product.bond.ResolvedCapitalIndexedBondTrade;
/**
* Perform calculations on a single {@code CapitalIndexedBondTrade} for each of a set of scenarios.
* <p>
* This uses the standard discounting calculation method.
* An instance of {@link LegalEntityDiscountingMarketDataLookup} must be specified.
* The supported built-in measures are:
* <ul>
* <li>{@linkplain Measures#PRESENT_VALUE Present value}
* <li>{@linkplain Measures#PV01_CALIBRATED_SUM PV01 calibrated sum}
* <li>{@linkplain Measures#PV01_CALIBRATED_BUCKETED PV01 calibrated bucketed}
* <li>{@linkplain Measures#CURRENCY_EXPOSURE Currency exposure}
* <li>{@linkplain Measures#CURRENT_CASH Current cash}
* <li>{@linkplain Measures#RESOLVED_TARGET Resolved trade}
* </ul>
*
* <h4>Price</h4>
* Strata uses <i>decimal prices</i> for bonds in the trade model, pricers and market data.
* For example, a price of 99.32% is represented in Strata by 0.9932.
*/
public class CapitalIndexedBondTradeCalculationFunction
implements CalculationFunction<CapitalIndexedBondTrade> {
/**
* The calculations by measure.
*/
private static final ImmutableMap<Measure, SingleMeasureCalculation> CALCULATORS =
ImmutableMap.<Measure, SingleMeasureCalculation>builder()
.put(Measures.PRESENT_VALUE, CapitalIndexedBondMeasureCalculations.DEFAULT::presentValue)
.put(Measures.PV01_CALIBRATED_SUM, CapitalIndexedBondMeasureCalculations.DEFAULT::pv01CalibratedSum)
.put(Measures.PV01_CALIBRATED_BUCKETED, CapitalIndexedBondMeasureCalculations.DEFAULT::pv01CalibratedBucketed)
.put(Measures.CURRENCY_EXPOSURE, CapitalIndexedBondMeasureCalculations.DEFAULT::currencyExposure)
.put(Measures.CURRENT_CASH, CapitalIndexedBondMeasureCalculations.DEFAULT::currentCash)
.put(Measures.RESOLVED_TARGET, (rt, smd1, smd2) -> rt)
.build();
private static final ImmutableSet<Measure> MEASURES = CALCULATORS.keySet();
/**
* Creates an instance.
*/
public CapitalIndexedBondTradeCalculationFunction() {
}
//-------------------------------------------------------------------------
@Override
public Class<CapitalIndexedBondTrade> targetType() {
return CapitalIndexedBondTrade.class;
}
@Override
public Set<Measure> supportedMeasures() {
return MEASURES;
}
@Override
public Optional<String> identifier(CapitalIndexedBondTrade target) {
return target.getInfo().getId().map(id -> id.toString());
}
@Override
public Currency naturalCurrency(CapitalIndexedBondTrade trade, ReferenceData refData) {
return trade.getProduct().getCurrency();
}
//-------------------------------------------------------------------------
@Override
public FunctionRequirements requirements(
CapitalIndexedBondTrade trade,
Set<Measure> measures,
CalculationParameters parameters,
ReferenceData refData) {
// extract data from product
CapitalIndexedBond product = trade.getProduct();
Currency currency = product.getCurrency();
SecurityId securityId = product.getSecurityId();
StandardId legalEntityId = product.getLegalEntityId();
// use lookup to build requirements
RatesMarketDataLookup ratesLookup = parameters.getParameter(RatesMarketDataLookup.class);
FunctionRequirements ratesReqs = ratesLookup.requirements(
ImmutableSet.of(), ImmutableSet.of(product.getRateCalculation().getIndex()));
LegalEntityDiscountingMarketDataLookup ledLookup = parameters.getParameter(LegalEntityDiscountingMarketDataLookup.class);
FunctionRequirements ledReqs = ledLookup.requirements(securityId, legalEntityId, currency);
return ratesReqs.combinedWith(ledReqs);
}
//-------------------------------------------------------------------------
@Override
public Map<Measure, Result<?>> calculate(
CapitalIndexedBondTrade trade,
Set<Measure> measures,
CalculationParameters parameters,
ScenarioMarketData scenarioMarketData,
ReferenceData refData) {
// resolve the trade once for all measures and all scenarios
ResolvedCapitalIndexedBondTrade resolved = trade.resolve(refData);
// use lookup to query market data
RatesMarketDataLookup ratesLookup = parameters.getParameter(RatesMarketDataLookup.class);
RatesScenarioMarketData ratesMarketData = ratesLookup.marketDataView(scenarioMarketData);
LegalEntityDiscountingMarketDataLookup ledLookup = parameters.getParameter(LegalEntityDiscountingMarketDataLookup.class);
LegalEntityDiscountingScenarioMarketData legalEntityMarketData = ledLookup.marketDataView(scenarioMarketData);
// loop around measures, calculating all scenarios for one measure
Map<Measure, Result<?>> results = new HashMap<>();
for (Measure measure : measures) {
results.put(measure, calculate(measure, resolved, ratesMarketData, legalEntityMarketData));
}
return results;
}
// calculate one measure
private Result<?> calculate(
Measure measure,
ResolvedCapitalIndexedBondTrade trade,
RatesScenarioMarketData ratesMarketData,
LegalEntityDiscountingScenarioMarketData legalEntityMarketData) {
SingleMeasureCalculation calculator = CALCULATORS.get(measure);
if (calculator == null) {
return Result.failure(FailureReason.UNSUPPORTED, "Unsupported measure for CapitalIndexedBondTrade: {}", measure);
}
return Result.of(() -> calculator.calculate(trade, ratesMarketData, legalEntityMarketData));
}
//-------------------------------------------------------------------------
@FunctionalInterface
interface SingleMeasureCalculation {
public abstract Object calculate(
ResolvedCapitalIndexedBondTrade trade,
RatesScenarioMarketData ratesMarketData,
LegalEntityDiscountingScenarioMarketData legalEntityMarketData);
}
}