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.EventObject;
20
21 /**
22 * The root class from which all events occurring while running an
23 * {@link IterationManager} should be derived.
24 *
25 */
26 public class IterationEvent extends EventObject {
27 /** */
28 private static final long serialVersionUID = 20120128L;
29
30 /** The number of iterations performed so far. */
31 private final int iterations;
32
33 /**
34 * Creates a new instance of this class.
35 *
36 * @param source the iterative algorithm on which the event initially
37 * occurred
38 * @param iterations the number of iterations performed at the time
39 * {@code this} event is created
40 */
41 public IterationEvent(final Object source, final int iterations) {
42 super(source);
43 this.iterations = iterations;
44 }
45
46 /**
47 * Returns the number of iterations performed at the time {@code this} event
48 * is created.
49 *
50 * @return the number of iterations performed
51 */
52 public int getIterations() {
53 return iterations;
54 }
55 }