1 files changed, 142 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/linear/DefaultIterativeLinearSolverEvent.java b/src/main/java/org/apache/commons/math3/linear/DefaultIterativeLinearSolverEvent.java
new file mode 100644
index 0000000..fee346e
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/linear/DefaultIterativeLinearSolverEvent.java
@@ -0,0 +1,142 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.math3.linear;
+
+import org.apache.commons.math3.exception.MathUnsupportedOperationException;
+
+/** A default concrete implementation of the abstract class {@link IterativeLinearSolverEvent}. */
+public class DefaultIterativeLinearSolverEvent extends IterativeLinearSolverEvent {
+
+    /** */
+    private static final long serialVersionUID = 20120129L;
+
+    /** The right-hand side vector. */
+    private final RealVector b;
+
+    /** The current estimate of the residual. */
+    private final RealVector r;
+
+    /** The current estimate of the norm of the residual. */
+    private final double rnorm;
+
+    /** The current estimate of the solution. */
+    private final RealVector x;
+
+    /**
+     * Creates a new instance of this class. This implementation does <em>not</em> deep copy the
+     * specified vectors {@code x}, {@code b}, {@code r}. Therefore the user must make sure that
+     * these vectors are either unmodifiable views or deep copies of the same vectors actually used
+     * by the {@code source}. Failure to do so may compromise subsequent iterations of the {@code
+     * source}. If the residual vector {@code r} is {@code null}, then {@link #getResidual()} throws
+     * a {@link MathUnsupportedOperationException}, and {@link #providesResidual()} returns {@code
+     * false}.
+     *
+     * @param source the iterative solver which fired this event
+     * @param iterations the number of iterations performed at the time {@code this} event is
+     *     created
+     * @param x the current estimate of the solution
+     * @param b the right-hand side vector
+     * @param r the current estimate of the residual (can be {@code null})
+     * @param rnorm the norm of the current estimate of the residual
+     */
+    public DefaultIterativeLinearSolverEvent(
+            final Object source,
+            final int iterations,
+            final RealVector x,
+            final RealVector b,
+            final RealVector r,
+            final double rnorm) {
+        super(source, iterations);
+        this.x = x;
+        this.b = b;
+        this.r = r;
+        this.rnorm = rnorm;
+    }
+
+    /**
+     * Creates a new instance of this class. This implementation does <em>not</em> deep copy the
+     * specified vectors {@code x}, {@code b}. Therefore the user must make sure that these vectors
+     * are either unmodifiable views or deep copies of the same vectors actually used by the {@code
+     * source}. Failure to do so may compromise subsequent iterations of the {@code source}.
+     * Callling {@link #getResidual()} on instances returned by this constructor throws a {@link
+     * MathUnsupportedOperationException}, while {@link #providesResidual()} returns {@code false}.
+     *
+     * @param source the iterative solver which fired this event
+     * @param iterations the number of iterations performed at the time {@code this} event is
+     *     created
+     * @param x the current estimate of the solution
+     * @param b the right-hand side vector
+     * @param rnorm the norm of the current estimate of the residual
+     */
+    public DefaultIterativeLinearSolverEvent(
+            final Object source,
+            final int iterations,
+            final RealVector x,
+            final RealVector b,
+            final double rnorm) {
+        super(source, iterations);
+        this.x = x;
+        this.b = b;
+        this.r = null;
+        this.rnorm = rnorm;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public double getNormOfResidual() {
+        return rnorm;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * <p>This implementation throws an {@link MathUnsupportedOperationException} if no residual
+     * vector {@code r} was provided at construction time.
+     */
+    @Override
+    public RealVector getResidual() {
+        if (r != null) {
+            return r;
+        }
+        throw new MathUnsupportedOperationException();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public RealVector getRightHandSideVector() {
+        return b;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public RealVector getSolution() {
+        return x;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * <p>This implementation returns {@code true} if a non-{@code null} value was specified for the
+     * residual vector {@code r} at construction time.
+     *
+     * @return {@code true} if {@code r != null}
+     */
+    @Override
+    public boolean providesResidual() {
+        return r != null;
+    }
+}