/*
* Checkpointer.java
*
* Copyright (c) 2002-2017 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.inference.state;
import dr.inference.markovchain.MarkovChain;
/**
* Checkpointer
*
* @author Andrew Rambaut
*/
public interface StateLoader {
/**
* Attempts to load the current state from a state dump. This should be a state
* dump created using the same XML file (some rudimentary checking of this is done).
* If it fails then it will throw a RuntimeException. If successful it will return the
* current state number.
* @param markovChain the MarkovChain object
* @return the state number
*/
long loadState(MarkovChain markovChain, double savedLnL[]);
void checkLoadState(double savedLnL, double lnL);
}