org.apache.commons.math.linear
Class IterativeLinearSolverEvent

java.lang.Object
  java.util.EventObject
      org.apache.commons.math.util.IterationEvent
          org.apache.commons.math.linear.IterativeLinearSolverEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ConjugateGradient.ConjugateGradientEvent

public abstract class IterativeLinearSolverEvent
extends IterationEvent

This is the base class for all events occuring during the iterations of a IterativeLinearSolver.

Since:

3.0

Version:

$Id: IterativeLinearSolverEvent.java 1175404 2011-09-25 14:48:18Z celestin $

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

IterativeLinearSolverEvent(java.lang.Object source)
Creates a new instance of this class.

Method Summary

abstract RealVector	getRightHandSideVector() Returns the current right-hand side of the linear system to be solved.
abstract RealVector	getSolution() Returns the current estimate of the solution to the linear system to be solved.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IterativeLinearSolverEvent

public IterativeLinearSolverEvent(java.lang.Object source)

Creates a new instance of this class.

Parameters:

source - The iterative algorithm on which the event initially occurred.

Method Detail

getRightHandSideVector

public abstract RealVector 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, in order not to compromise subsequent iterations of the source IterativeLinearSolver.

Returns:

The right-hand side vector, b.

getSolution

public abstract RealVector 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 source IterativeLinearSolver.

Returns:

The solution, x.