org.apache.commons.math.linear

Class DefaultRealMatrixChangingVisitor

java.lang.Object

org.apache.commons.math.linear.DefaultRealMatrixChangingVisitor

All Implemented Interfaces:

RealMatrixChangingVisitor

public class DefaultRealMatrixChangingVisitor
extends java.lang.Object
implements RealMatrixChangingVisitor

Default implementation of the RealMatrixChangingVisitor interface.

This class is a convenience to create custom visitors without defining all methods. This class provides default implementations that do nothing.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
DefaultRealMatrixChangingVisitor()

Method Summary

Modifier and Type	Method and Description
double	end() End visiting a matrix.
void	start(int rows, int columns, int startRow, int endRow, int startColumn, int endColumn) Start visiting a matrix.
double	visit(int row, int column, double value) Visit one matrix entry.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultRealMatrixChangingVisitor

public DefaultRealMatrixChangingVisitor()

Method Detail

start

public void start(int rows,
                  int columns,
                  int startRow,
                  int endRow,
                  int startColumn,
                  int endColumn)

Start visiting a matrix.

This method is called once before any entry of the matrix is visited.

Specified by:

start in interface RealMatrixChangingVisitor

Parameters:

rows - number of rows of the matrix

columns - number of columns of the matrix

startRow - Initial row index

endRow - Final row index (inclusive)

startColumn - Initial column index

endColumn - Final column index (inclusive)

visit

public double visit(int row,
                    int column,
                    double value)
             throws MatrixVisitorException

Visit one matrix entry.

Specified by:

visit in interface RealMatrixChangingVisitor

Parameters:

row - row index of the entry

column - column index of the entry

value - current value of the entry

Returns:

the new value to be set for the entry

Throws:

MatrixVisitorException - if something wrong occurs

end

public double end()

End visiting a matrix.

This method is called once after all entries of the matrix have been visited.

Specified by:

end in interface RealMatrixChangingVisitor

Returns:

the value that the walkInXxxOrder must return