com.opengamma.strata.math.impl.differentiation.Differentiator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2009 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.math.impl.differentiation;

import java.util.function.Function;

/**
 * Given a one-dimensional function (see {@link Function}), returns a function that calculates the gradient.
 * 
 * @param  the domain type of the function
 * @param  the range type of the function
 * @param  the range type of the differential
 */
public interface Differentiator {

  /**
   * Provides a function that performs the differentiation.
   * 
   * @param function  a function for which to get the differential function
   * @return a function that calculates the differential
   */
  public abstract Function differentiate(Function function);

  /**
   * Provides a function that performs the differentiation.
   * 
   * @param function  a function for which to get the differential function
   * @param domain  a function that returns false if the requested value is not in  the domain, true otherwise
   * @return a function that calculates the differential
   */
  public abstract Function differentiate(Function function, Function domain);

}