001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.commons.math3.util;
018
019 import java.util.EventListener;
020
021 /**
022 * The listener interface for receiving events occurring in an iterative
023 * algorithm.
024 *
025 * @version $Id: IterationListener.java 1416643 2012-12-03 19:37:14Z tn $
026 */
027 public interface IterationListener extends EventListener {
028 /**
029 * Invoked after completion of the initial phase of the iterative algorithm
030 * (prior to the main iteration loop).
031 *
032 * @param e The {@link IterationEvent} object.
033 */
034 void initializationPerformed(IterationEvent e);
035
036 /**
037 * Invoked each time an iteration is completed (in the main iteration loop).
038 *
039 * @param e The {@link IterationEvent} object.
040 */
041 void iterationPerformed(IterationEvent e);
042
043 /**
044 * Invoked each time a new iteration is completed (in the main iteration
045 * loop).
046 *
047 * @param e The {@link IterationEvent} object.
048 */
049 void iterationStarted(IterationEvent e);
050
051 /**
052 * Invoked after completion of the operations which occur after breaking out
053 * of the main iteration loop.
054 *
055 * @param e The {@link IterationEvent} object.
056 */
057 void terminationPerformed(IterationEvent e);
058 }