uk.ac.sussex.gdsc.smlm.function.Gradient1Function 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;

/**
 * Defines function that can produce first order gradients.
 */
public interface Gradient1Function extends ValueFunction, GradientFunction {
  /**
   * Set the predictor coefficients (a) that will be used to predict each value. Allows the function
   * to perform initialisation for computing the first order gradients.
   *
   * @param a An array of coefficients
   */
  void initialise1(double[] a);

  /**
   * Applies the procedure for the valid range of the function.
   *
   * @param procedure the procedure
   */
  void forEach(Gradient1Procedure procedure);
}