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

/**
 * Class for evaluating the integral (sum) of a function.
 */
public class IntegralValueProcedure implements ValueProcedure {
  /**
   * The integral (sum) or the values from the last call to
   * {@link #getIntegral(ValueFunction, double[])}.
   */
  public double integral;

  /**
   * Gets the integral.
   *
   * @param function the function
   * @param parameters the function coefficients
   * @return the integral
   */
  public double getIntegral(ValueFunction function, double[] parameters) {
    integral = 0;
    function.initialise0(parameters);
    function.forEach(this);
    return integral;
  }

  @Override
  public void execute(double value) {
    integral += value;
  }
}