001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022
023package org.biojava.bio.dp;
024
025/**
026 * A callback that is invoked during the training of an HMM.
027 *
028 * @author Matthew Pocock
029 */
030public interface StoppingCriteria {
031  /**
032   * Decide if the training has completed.
033   *
034   * This can be on the basis of the scores published by ta. Or, it could be
035   * set to expire at a given cycle, or due to user intervention. It is
036   * perfectly acceptable for this method to have side effects such as logging.
037   *
038   * @param ta  the TrainingAlgorithm instance to check
039   * @return true if the training is complete, false if it should be continued
040   */
041  boolean isTrainingComplete(TrainingAlgorithm ta);
042}