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

import org.apache.commons.lang3.tuple.Pair;

/**
 * Defines the non-linear fitting function.
 */
public interface ExtendedNonLinearFunction extends NonLinearFunction {
  /**
   * Compute the values of all the data points.
   *
   * @param variables the variables
   * @return The values
   */
  double[] computeValues(double[] variables);

  /**
   * Compute the Jacobian of the gradients of all the data points.
   *
   * @param variables the variables
   * @return The Jacobian
   */
  double[][] computeJacobian(double[] variables);

  /**
   * Return true if the function can compute the values and the Jacobian.
   *
   * @return true, if the function can compute the values and the Jacobian.
   */
  boolean canComputeValuesAndJacobian();

  /**
   * Compute the values and the Jacobian of the gradients of all the data points.
   *
   * @param variables the variables
   * @return The values and the Jacobian
   */
  Pair computeValuesAndJacobian(double[] variables);
}