com.opengamma.strata.pricer.index.NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities Maven / Gradle / Ivy
/*
* Copyright (C) 2022 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.pricer.index;
import java.io.Serializable;
import java.time.LocalDate;
import java.time.ZonedDateTime;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Optional;
import java.util.OptionalInt;
import org.joda.beans.Bean;
import org.joda.beans.ImmutableBean;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaBean;
import org.joda.beans.MetaProperty;
import org.joda.beans.gen.BeanDefinition;
import org.joda.beans.gen.ImmutableConstructor;
import org.joda.beans.gen.PropertyDefinition;
import org.joda.beans.impl.direct.DirectFieldsBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaBean;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import com.opengamma.strata.basics.date.DayCount;
import com.opengamma.strata.basics.index.OvernightIndex;
import com.opengamma.strata.collect.ArgChecker;
import com.opengamma.strata.data.MarketDataName;
import com.opengamma.strata.market.ValueType;
import com.opengamma.strata.market.model.MoneynessType;
import com.opengamma.strata.market.param.CurrencyParameterSensitivities;
import com.opengamma.strata.market.param.CurrencyParameterSensitivity;
import com.opengamma.strata.market.param.ParameterMetadata;
import com.opengamma.strata.market.param.ParameterPerturbation;
import com.opengamma.strata.market.param.UnitParameterSensitivity;
import com.opengamma.strata.market.sensitivity.PointSensitivities;
import com.opengamma.strata.market.sensitivity.PointSensitivity;
import com.opengamma.strata.market.surface.InterpolatedNodalSurface;
import com.opengamma.strata.market.surface.Surface;
import com.opengamma.strata.market.surface.SurfaceInfoType;
import com.opengamma.strata.market.surface.Surfaces;
/**
* Data provider of volatility for Overnight future options in the normal or Bachelier model.
*
* The volatility is represented by a surface on the expiry and simple moneyness.
* The expiry is measured in number of days (not time) according to a day-count convention.
* The simple moneyness can be on the price or on the rate (1-price).
*/
@BeanDefinition
public final class NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities
implements NormalOvernightFutureOptionVolatilities, ImmutableBean, Serializable {
/**
* The index of the underlying future.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final OvernightIndex index;
/**
* The valuation date-time.
*
* The volatilities are calibrated for this date-time.
*/
@PropertyDefinition(validate = "notNull", overrideGet = true)
private final ZonedDateTime valuationDateTime;
/**
* The normal volatility surface.
*
* The x-value of the surface is the expiry, as a year fraction.
* The y-value of the surface is the simple moneyness.
*/
@PropertyDefinition(validate = "notNull")
private final Surface surface;
/**
* Whether the moneyness is on the price (true) or on the rate (false).
*/
private final transient boolean moneynessOnPrice; // cached, not a property
/**
* The day count convention of the surface.
*/
private final transient DayCount dayCount; // cached, not a property
//-------------------------------------------------------------------------
/**
* Obtains an instance from the volatility surface and the date-time for which it is valid.
*
* The surface is specified by an instance of {@link Surface}, such as {@link InterpolatedNodalSurface}.
* The surface must contain the correct metadata:
*
* - The x-value type must be {@link ValueType#YEAR_FRACTION}
*
- The y-value type must be {@link ValueType#SIMPLE_MONEYNESS}
*
- The z-value type must be {@link ValueType#NORMAL_VOLATILITY}
*
- The day count must be set in the additional information using {@link SurfaceInfoType#DAY_COUNT}
*
* Suitable surface metadata can be created using
* {@link Surfaces#normalVolatilityByExpirySimpleMoneyness(String, DayCount, MoneynessType)}.
*
* @param index the Overnight index
* @param surface the implied volatility surface
* @param valuationDateTime the valuation date-time
* @return the volatilities
*/
public static NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities of(
OvernightIndex index,
ZonedDateTime valuationDateTime,
Surface surface) {
return new NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities(index, valuationDateTime, surface);
}
@ImmutableConstructor
private NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities(
OvernightIndex index,
ZonedDateTime valuationDateTime,
Surface surface) {
ArgChecker.notNull(index, "index");
ArgChecker.notNull(valuationDateTime, "valuationDateTime");
ArgChecker.notNull(surface, "surface");
surface.getMetadata().getXValueType().checkEquals(
ValueType.YEAR_FRACTION, "Incorrect x-value type for Normal volatilities");
surface.getMetadata().getYValueType().checkEquals(
ValueType.SIMPLE_MONEYNESS, "Incorrect y-value type for Normal volatilities");
surface.getMetadata().getZValueType().checkEquals(
ValueType.NORMAL_VOLATILITY, "Incorrect z-value type for Normal volatilities");
DayCount dayCount = surface.getMetadata().findInfo(SurfaceInfoType.DAY_COUNT)
.orElseThrow(() -> new IllegalArgumentException("Incorrect surface metadata, missing DayCount"));
MoneynessType moneynessType = surface.getMetadata().findInfo(SurfaceInfoType.MONEYNESS_TYPE)
.orElseThrow(() -> new IllegalArgumentException("Incorrect surface metadata, missing MoneynessType"));
this.index = index;
this.valuationDateTime = valuationDateTime;
this.surface = surface;
this.moneynessOnPrice = moneynessType == MoneynessType.PRICE;
this.dayCount = dayCount;
}
// ensure standard constructor is invoked
private Object readResolve() {
return new NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities(index, valuationDateTime, surface);
}
//-------------------------------------------------------------------------
@Override
public OvernightFutureOptionVolatilitiesName getName() {
return OvernightFutureOptionVolatilitiesName.of(surface.getName().getName());
}
@Override
public Optional findData(MarketDataName name) {
if (surface.getName().equals(name)) {
return Optional.of(name.getMarketDataType().cast(surface));
}
return Optional.empty();
}
@Override
public int getParameterCount() {
return surface.getParameterCount();
}
@Override
public double getParameter(int parameterIndex) {
return surface.getParameter(parameterIndex);
}
@Override
public ParameterMetadata getParameterMetadata(int parameterIndex) {
return surface.getParameterMetadata(parameterIndex);
}
@Override
public OptionalInt findParameterIndex(ParameterMetadata metadata) {
return surface.findParameterIndex(metadata);
}
@Override
public NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities withParameter(int parameterIndex, double newValue) {
return new NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities(
index, valuationDateTime, surface.withParameter(parameterIndex, newValue));
}
@Override
public NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities withPerturbation(ParameterPerturbation perturbation) {
return new NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities(
index, valuationDateTime, surface.withPerturbation(perturbation));
}
//-------------------------------------------------------------------------
@Override
public double volatility(double expiry, LocalDate fixingDate, double strikePrice, double futurePrice) {
double simpleMoneyness = moneynessOnPrice ? strikePrice - futurePrice : futurePrice - strikePrice;
return surface.zValue(expiry, simpleMoneyness);
}
@Override
public CurrencyParameterSensitivities parameterSensitivity(PointSensitivities pointSensitivities) {
CurrencyParameterSensitivities sens = CurrencyParameterSensitivities.empty();
for (PointSensitivity point : pointSensitivities.getSensitivities()) {
if (point instanceof OvernightFutureOptionSensitivity) {
OvernightFutureOptionSensitivity pt = (OvernightFutureOptionSensitivity) point;
if (pt.getVolatilitiesName().equals(getName())) {
sens = sens.combinedWith(parameterSensitivity(pt));
}
}
}
return sens;
}
private CurrencyParameterSensitivity parameterSensitivity(OvernightFutureOptionSensitivity point) {
double simpleMoneyness = moneynessOnPrice ?
point.getStrikePrice() - point.getFuturePrice() :
point.getFuturePrice() - point.getStrikePrice();
UnitParameterSensitivity unitSens = surface.zValueParameterSensitivity(point.getExpiry(), simpleMoneyness);
return unitSens.multipliedBy(point.getCurrency(), point.getSensitivity());
}
//-------------------------------------------------------------------------
@Override
public double relativeTime(ZonedDateTime zonedDateTime) {
ArgChecker.notNull(zonedDateTime, "date");
return dayCount.relativeYearFraction(valuationDateTime.toLocalDate(), zonedDateTime.toLocalDate());
}
//------------------------- AUTOGENERATED START -------------------------
/**
* The meta-bean for {@code NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities}.
* @return the meta-bean, not null
*/
public static NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Meta meta() {
return NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Meta.INSTANCE;
}
static {
MetaBean.register(NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Meta.INSTANCE);
}
/**
* The serialization version id.
*/
private static final long serialVersionUID = 1L;
/**
* Returns a builder used to create an instance of the bean.
* @return the builder, not null
*/
public static NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Builder builder() {
return new NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Builder();
}
@Override
public NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Meta metaBean() {
return NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Meta.INSTANCE;
}
//-----------------------------------------------------------------------
/**
* Gets the index of the underlying future.
* @return the value of the property, not null
*/
@Override
public OvernightIndex getIndex() {
return index;
}
//-----------------------------------------------------------------------
/**
* Gets the valuation date-time.
*
* The volatilities are calibrated for this date-time.
* @return the value of the property, not null
*/
@Override
public ZonedDateTime getValuationDateTime() {
return valuationDateTime;
}
//-----------------------------------------------------------------------
/**
* Gets the normal volatility surface.
*
* The x-value of the surface is the expiry, as a year fraction.
* The y-value of the surface is the simple moneyness.
* @return the value of the property, not null
*/
public Surface getSurface() {
return surface;
}
//-----------------------------------------------------------------------
/**
* Returns a builder that allows this bean to be mutated.
* @return the mutable builder, not null
*/
public Builder toBuilder() {
return new Builder(this);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities other = (NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities) obj;
return JodaBeanUtils.equal(index, other.index) &&
JodaBeanUtils.equal(valuationDateTime, other.valuationDateTime) &&
JodaBeanUtils.equal(surface, other.surface);
}
return false;
}
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + JodaBeanUtils.hashCode(index);
hash = hash * 31 + JodaBeanUtils.hashCode(valuationDateTime);
hash = hash * 31 + JodaBeanUtils.hashCode(surface);
return hash;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(128);
buf.append("NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities{");
buf.append("index").append('=').append(JodaBeanUtils.toString(index)).append(',').append(' ');
buf.append("valuationDateTime").append('=').append(JodaBeanUtils.toString(valuationDateTime)).append(',').append(' ');
buf.append("surface").append('=').append(JodaBeanUtils.toString(surface));
buf.append('}');
return buf.toString();
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities}.
*/
public static final class Meta extends DirectMetaBean {
/**
* The singleton instance of the meta-bean.
*/
static final Meta INSTANCE = new Meta();
/**
* The meta-property for the {@code index} property.
*/
private final MetaProperty index = DirectMetaProperty.ofImmutable(
this, "index", NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.class, OvernightIndex.class);
/**
* The meta-property for the {@code valuationDateTime} property.
*/
private final MetaProperty valuationDateTime = DirectMetaProperty.ofImmutable(
this, "valuationDateTime", NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.class, ZonedDateTime.class);
/**
* The meta-property for the {@code surface} property.
*/
private final MetaProperty surface = DirectMetaProperty.ofImmutable(
this, "surface", NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.class, Surface.class);
/**
* The meta-properties.
*/
private final Map> metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"index",
"valuationDateTime",
"surface");
/**
* Restricted constructor.
*/
private Meta() {
}
@Override
protected MetaProperty metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case 100346066: // index
return index;
case -949589828: // valuationDateTime
return valuationDateTime;
case -1853231955: // surface
return surface;
}
return super.metaPropertyGet(propertyName);
}
@Override
public NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Builder builder() {
return new NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Builder();
}
@Override
public Class beanType() {
return NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.class;
}
@Override
public Map> metaPropertyMap() {
return metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code index} property.
* @return the meta-property, not null
*/
public MetaProperty index() {
return index;
}
/**
* The meta-property for the {@code valuationDateTime} property.
* @return the meta-property, not null
*/
public MetaProperty valuationDateTime() {
return valuationDateTime;
}
/**
* The meta-property for the {@code surface} property.
* @return the meta-property, not null
*/
public MetaProperty surface() {
return surface;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case 100346066: // index
return ((NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities) bean).getIndex();
case -949589828: // valuationDateTime
return ((NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities) bean).getValuationDateTime();
case -1853231955: // surface
return ((NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities) bean).getSurface();
}
return super.propertyGet(bean, propertyName, quiet);
}
@Override
protected void propertySet(Bean bean, String propertyName, Object newValue, boolean quiet) {
metaProperty(propertyName);
if (quiet) {
return;
}
throw new UnsupportedOperationException("Property cannot be written: " + propertyName);
}
}
//-----------------------------------------------------------------------
/**
* The bean-builder for {@code NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities}.
*/
public static final class Builder extends DirectFieldsBeanBuilder {
private OvernightIndex index;
private ZonedDateTime valuationDateTime;
private Surface surface;
/**
* Restricted constructor.
*/
private Builder() {
}
/**
* Restricted copy constructor.
* @param beanToCopy the bean to copy from, not null
*/
private Builder(NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities beanToCopy) {
this.index = beanToCopy.getIndex();
this.valuationDateTime = beanToCopy.getValuationDateTime();
this.surface = beanToCopy.getSurface();
}
//-----------------------------------------------------------------------
@Override
public Object get(String propertyName) {
switch (propertyName.hashCode()) {
case 100346066: // index
return index;
case -949589828: // valuationDateTime
return valuationDateTime;
case -1853231955: // surface
return surface;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
}
@Override
public Builder set(String propertyName, Object newValue) {
switch (propertyName.hashCode()) {
case 100346066: // index
this.index = (OvernightIndex) newValue;
break;
case -949589828: // valuationDateTime
this.valuationDateTime = (ZonedDateTime) newValue;
break;
case -1853231955: // surface
this.surface = (Surface) newValue;
break;
default:
throw new NoSuchElementException("Unknown property: " + propertyName);
}
return this;
}
@Override
public Builder set(MetaProperty property, Object value) {
super.set(property, value);
return this;
}
@Override
public NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities build() {
return new NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities(
index,
valuationDateTime,
surface);
}
//-----------------------------------------------------------------------
/**
* Sets the index of the underlying future.
* @param index the new value, not null
* @return this, for chaining, not null
*/
public Builder index(OvernightIndex index) {
JodaBeanUtils.notNull(index, "index");
this.index = index;
return this;
}
/**
* Sets the valuation date-time.
*
* The volatilities are calibrated for this date-time.
* @param valuationDateTime the new value, not null
* @return this, for chaining, not null
*/
public Builder valuationDateTime(ZonedDateTime valuationDateTime) {
JodaBeanUtils.notNull(valuationDateTime, "valuationDateTime");
this.valuationDateTime = valuationDateTime;
return this;
}
/**
* Sets the normal volatility surface.
*
* The x-value of the surface is the expiry, as a year fraction.
* The y-value of the surface is the simple moneyness.
* @param surface the new value, not null
* @return this, for chaining, not null
*/
public Builder surface(Surface surface) {
JodaBeanUtils.notNull(surface, "surface");
this.surface = surface;
return this;
}
//-----------------------------------------------------------------------
@Override
public String toString() {
StringBuilder buf = new StringBuilder(128);
buf.append("NormalOvernightFutureOptionExpirySimpleMoneynessVolatilities.Builder{");
buf.append("index").append('=').append(JodaBeanUtils.toString(index)).append(',').append(' ');
buf.append("valuationDateTime").append('=').append(JodaBeanUtils.toString(valuationDateTime)).append(',').append(' ');
buf.append("surface").append('=').append(JodaBeanUtils.toString(surface));
buf.append('}');
return buf.toString();
}
}
//-------------------------- AUTOGENERATED END --------------------------
}