com.opengamma.strata.pricer.capfloor.SabrIborCapletFloorletVolatilities Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of strata-pricer Show documentation
Pricing APIs
The newest version!
/*
 * Copyright (C) 2016 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.pricer.capfloor;

import com.opengamma.strata.basics.value.ValueDerivatives;
import com.opengamma.strata.market.param.ParameterPerturbation;

/**
 * Volatility for Ibor caplet/floorlet in SABR model.
 * 
 * The volatility is represented in terms of SABR model parameters.
 * 

 * The prices are calculated using the SABR implied volatility.
 */
public interface SabrIborCapletFloorletVolatilities
    extends IborCapletFloorletVolatilities {

  @Override
  public abstract SabrIborCapletFloorletVolatilities withParameter(int parameterIndex, double newValue);

  @Override
  public abstract SabrIborCapletFloorletVolatilities withPerturbation(ParameterPerturbation perturbation);

  //-------------------------------------------------------------------------
  /**
   * Calculates the alpha parameter for a pair of time to expiry.
   * 
   * @param expiry  the time to expiry as a year fraction
   * @return the alpha parameter
   */
  public abstract double alpha(double expiry);

  /**
   * Calculates the beta parameter for a pair of time to expiry.
   * 
   * @param expiry  the time to expiry as a year fraction
   * @return the beta parameter
   */
  public abstract double beta(double expiry);

  /**
   * Calculates the rho parameter for a pair of time to expiry.
   * 
   * @param expiry  the time to expiry as a year fraction
   * @return the rho parameter
   */
  public abstract double rho(double expiry);

  /**
   * Calculates the nu parameter for a pair of time to expiry.
   * 
   * @param expiry  the time to expiry as a year fraction
   * @return the nu parameter
   */
  public abstract double nu(double expiry);

  /**
   * Calculates the shift parameter for the specified time to expiry.
   * 
   * @param expiry  the time to expiry as a year fraction
   * @return the shift parameter
   */
  public abstract double shift(double expiry);

  /**
   * Calculates the volatility and associated sensitivities.
   * 

   * The derivatives are stored in an array with:
   * 

   * [0] derivative with respect to the forward
   * 
[1] derivative with respect to the forward strike
   * 
[2] derivative with respect to the alpha
   * 
[3] derivative with respect to the beta
   * 
[4] derivative with respect to the rho
   * 
[5] derivative with respect to the nu
   * 
   * 
   * @param expiry  the time to expiry as a year fraction
   * @param strike  the strike
   * @param forward  the forward
   * @return the volatility and associated sensitivities
   */
  public abstract ValueDerivatives volatilityAdjoint(double expiry, double strike, double forward);

}