com.opengamma.strata.math.impl.minimization.MinimizerWithGradient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of strata-math Show documentation

Mathematic support for Strata

There is a newer version: 2.12.46

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

import java.util.function.Function;

/**
 * Interface for classes that extends the functionality of {@link Minimizer} by providing a method that takes a gradient function.
 * @param  The type of the function to minimize
 * @param  The type of the gradient function
 * @param  The type of the start position of the minimization
 */
public interface MinimizerWithGradient, G extends Function, S> extends Minimizer {

  /**
   * @param function The function to minimize, not null
   * @param gradient The gradient function, not null
   * @param startPosition The start position, not null
   * @return The minimum
   */
  public abstract S minimize(F function, G gradient, S startPosition);

}