Package org.hipparchus.linear
Class IterativeLinearSolverEvent
java.lang.Object
java.util.EventObject
org.hipparchus.util.IterationEvent
org.hipparchus.linear.IterativeLinearSolverEvent
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
DefaultIterativeLinearSolverEvent
This is the base class for all events occurring during the iterations of a
IterativeLinearSolver
.- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionIterativeLinearSolverEvent
(Object source, int iterations) Creates a new instance of this class. -
Method Summary
Modifier and TypeMethodDescriptionabstract double
Returns the norm of the residual.Returns the residual.abstract RealVector
Returns the current right-hand side of the linear system to be solved.abstract RealVector
Returns the current estimate of the solution to the linear system to be solved.boolean
Returnstrue
ifgetResidual()
is supported.Methods inherited from class org.hipparchus.util.IterationEvent
getIterations
Methods inherited from class java.util.EventObject
getSource, toString
-
Constructor Details
-
IterativeLinearSolverEvent
Creates a new instance of this class.- Parameters:
source
- the iterative algorithm on which the event initially occurrediterations
- the number of iterations performed at the timethis
event is created
-
-
Method Details
-
getRightHandSideVector
Returns the current right-hand side of the linear system to be solved. This method should return an unmodifiable view, or a deep copy of the actual right-hand side vector, in order not to compromise subsequent iterations of the sourceIterativeLinearSolver
.- Returns:
- the right-hand side vector, b
-
getNormOfResidual
public abstract double getNormOfResidual()Returns the norm of the residual. The returned value is not required to be exact. Instead, the norm of the so-called updated residual (if available) should be returned. For example, theconjugate gradient
method computes a sequence of residuals, the norm of which is cheap to compute. However, due to accumulation of round-off errors, this residual might differ from the true residual after some iterations. See e.g. A. Greenbaum and Z. Strakos, Predicting the Behavior of Finite Precision Lanzos and Conjugate Gradient Computations, Technical Report 538, Department of Computer Science, New York University, 1991 (available here).- Returns:
- the norm of the residual, ||r||
-
getResidual
Returns the residual. This is an optional operation, as all iterative linear solvers do not provide cheap estimate of the updated residual vector, in which case
- this method should throw a
MathRuntimeException
, providesResidual()
returnsfalse
.
The default implementation throws a
MathRuntimeException
. If this method is overriden, thenprovidesResidual()
should be overriden as well.- Returns:
- the updated residual, r
- this method should throw a
-
getSolution
Returns the current estimate of the solution to the linear system to be solved. This method should return an unmodifiable view, or a deep copy of the actual current solution, in order not to compromise subsequent iterations of the sourceIterativeLinearSolver
.- Returns:
- the solution, x
-
providesResidual
public boolean providesResidual()- Returns:
false
ifgetResidual()
throws aMathRuntimeException
-