MinimiserMonitor.java

/*
 * MinimiserMonitor.java
 *
 * Copyright (c) 2002-2015 Alexei Drummond, Andrew Rambaut and Marc Suchard
 *
 * This file is part of BEAST.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership and licensing.
 *
 * BEAST is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 *  BEAST 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with BEAST; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package dr.math;

/**
 * interface for a classes that wish to monitor the progress of a Minimiser
 *
 * @author Matthew Goode
 */

public interface MinimiserMonitor {
	/**
	 * Inform monitor of current progress (as a number between 0 and 1), or -1 to reset
	 */
	public void updateProgress(double progress);

	/**
	 * Inform monitor of a new minimum, along with the current arguments. Monitors should NOT
	 * change the supplied array of parameterValues!
	 */
	public void newMinimum(double value, double[] parameterValues);
}