1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.util;
23
24 import java.util.EventListener;
25
26 /**
27 * The listener interface for receiving events occurring in an iterative
28 * algorithm.
29 */
30 public interface IterationListener extends EventListener {
31 /**
32 * Invoked after completion of the initial phase of the iterative algorithm
33 * (prior to the main iteration loop).
34 *
35 * @param e The {@link IterationEvent} object.
36 */
37 void initializationPerformed(IterationEvent e);
38
39 /**
40 * Invoked each time an iteration is completed (in the main iteration loop).
41 *
42 * @param e The {@link IterationEvent} object.
43 */
44 void iterationPerformed(IterationEvent e);
45
46 /**
47 * Invoked each time a new iteration is completed (in the main iteration
48 * loop).
49 *
50 * @param e The {@link IterationEvent} object.
51 */
52 void iterationStarted(IterationEvent e);
53
54 /**
55 * Invoked after completion of the operations which occur after breaking out
56 * of the main iteration loop.
57 *
58 * @param e The {@link IterationEvent} object.
59 */
60 void terminationPerformed(IterationEvent e);
61 }