ConvergenceChecker.java

package gdsc.smlm.search;

/*----------------------------------------------------------------------------- 
 * GDSC SMLM Software
 * 
 * Copyright (C) 2016 Alex Herbert
 * Genome Damage and Stability Centre
 * University of Sussex, UK
 * 
 * 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.
 *---------------------------------------------------------------------------*/

/**
 * Defines convergence of a point in space
 */
public interface ConvergenceChecker<T extends Comparable<T>>
{
	/**
	 * Check if the point has converged.
	 *
	 * @param previous
	 *            the previous
	 * @param current
	 *            the current
	 * @return true if the point has converged
	 */
	boolean converged(SearchResult<T> previous, SearchResult<T> current);
}