com.meliorbis.numerics.convergence.Convergable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Numerics Show documentation
Show all versions of Numerics Show documentation
A library for working with large multi-dimensional arrays and the functions they represent
/**
*
*/
package com.meliorbis.numerics.convergence;
import com.meliorbis.utils.Pair;
/**
* Interface for numerical methods which are expected to converge and can
* hence be solver by the converger
*
* @param The state used as both input and output
*
* @author Tobias Grasl
*/
public interface Convergable
{
/**
* Performs an interation of the process and returns the latest value
* of the metric
*
* @param input_ The input of the iteration
*
* @return A pair containing the new state and also the convergence metric
*
* @throws E If an error occurs
*/
Pair performIteration(S input_) throws E;
}