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 * http://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 package org.apache.commons.math4.legacy.linear;
18
19 import java.util.EventListener;
20
21 /**
22 * The listener interface for receiving events occurring in an iterative
23 * algorithm.
24 *
25 */
26 public interface IterationListener extends EventListener {
27 /**
28 * Invoked after completion of the initial phase of the iterative algorithm
29 * (prior to the main iteration loop).
30 *
31 * @param e The {@link IterationEvent} object.
32 */
33 void initializationPerformed(IterationEvent e);
34
35 /**
36 * Invoked each time an iteration is completed (in the main iteration loop).
37 *
38 * @param e The {@link IterationEvent} object.
39 */
40 void iterationPerformed(IterationEvent e);
41
42 /**
43 * Invoked each time a new iteration is completed (in the main iteration
44 * loop).
45 *
46 * @param e The {@link IterationEvent} object.
47 */
48 void iterationStarted(IterationEvent e);
49
50 /**
51 * Invoked after completion of the operations which occur after breaking out
52 * of the main iteration loop.
53 *
54 * @param e The {@link IterationEvent} object.
55 */
56 void terminationPerformed(IterationEvent e);
57 }