Package com.opengamma.strata.pricer.fxopt

Interface BlackFxOptionVolatilities

All Superinterfaces:

FxOptionVolatilities, MarketDataView, ParameterizedData

All Known Implementing Classes:

BlackFxOptionFlatVolatilities, BlackFxOptionSmileVolatilities, BlackFxOptionSurfaceVolatilities

public interface BlackFxOptionVolatilities
extends FxOptionVolatilities

Volatility for FX option in the log-normal or Black model.

Method Summary

Modifier and Type	Method	Description
default ValueType	getVolatilityType()	Gets the type of volatility returned by the FxOptionVolatilities.volatility(com.opengamma.strata.basics.currency.CurrencyPair, java.time.ZonedDateTime, double, double) method.
BlackFxOptionVolatilities	withParameter(int parameterIndex, double newValue)	Returns a copy of the data with the value at the specified index altered.
BlackFxOptionVolatilities	withPerturbation(ParameterPerturbation perturbation)	Returns a perturbed copy of the data.

Methods inherited from interface com.opengamma.strata.pricer.fxopt.FxOptionVolatilities

firstPartialDerivatives, getCurrencyPair, getName, getValuationDate, getValuationDateTime, parameterSensitivity, parameterSensitivity, price, relativeTime, volatility, volatility

Methods inherited from interface com.opengamma.strata.market.MarketDataView

findData

Methods inherited from interface com.opengamma.strata.market.param.ParameterizedData

findParameterIndex, getParameter, getParameterCount, getParameterMetadata

Method Detail

getVolatilityType

default ValueType getVolatilityType()

Description copied from interface: FxOptionVolatilities

Gets the type of volatility returned by the FxOptionVolatilities.volatility(com.opengamma.strata.basics.currency.CurrencyPair, java.time.ZonedDateTime, double, double) method.

Specified by:

getVolatilityType in interface FxOptionVolatilities

Returns:

the type

withParameter

BlackFxOptionVolatilities withParameter(int parameterIndex,
                                        double newValue)

Description copied from interface: ParameterizedData

Returns a copy of the data with the value at the specified index altered.

This instance is immutable and unaffected by this method call.

Specified by:

withParameter in interface FxOptionVolatilities

Specified by:

withParameter in interface ParameterizedData

Parameters:

parameterIndex - the zero-based index of the parameter to get

newValue - the new value for the specified parameter

Returns:

a parameterized data instance based on this with the specified parameter altered

withPerturbation

BlackFxOptionVolatilities withPerturbation(ParameterPerturbation perturbation)

Description copied from interface: ParameterizedData

Returns a perturbed copy of the data.

The perturbation instance will be invoked once for each parameter in this instance, returning the perturbed value for that parameter. The result of this method is a new instance that is based on those perturbed values.

This instance is immutable and unaffected by this method call.

Specified by:

withPerturbation in interface FxOptionVolatilities

Specified by:

withPerturbation in interface ParameterizedData

Parameters:

perturbation - the perturbation to apply

Returns:

a parameterized data instance based on this with the specified perturbation applied