uk.ac.sussex.gdsc.smlm.function.ExtendedGradient2Procedure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdsc-smlm Show documentation

Genome Damage and Stability Centre SMLM Package Software for single molecule localisation microscopy (SMLM)

The newest version!

/*-
 * #%L
 * Genome Damage and Stability Centre SMLM Package
 *
 * Software for single molecule localisation microscopy (SMLM)
 * %%
 * Copyright (C) 2011 - 2023 Alex Herbert
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

package uk.ac.sussex.gdsc.smlm.function;

/**
 * Interface for functions to produce a value, first and second partial derivatives.
 */
public interface ExtendedGradient2Procedure {
  /**
   * Executes this procedure.
   *
   * @param value the value of the function
   * @param dyDa Partial first derivative of function with respect to each coefficient (a)
   * @param d2yDaDb Partial second derivative of function with respect to each coefficient pair
   *        (a,b). Packed linearly with size n*n with n the number of coefficients.
   */
  void executeExtended(double value, double[] dyDa, double[] d2yDaDb);
}