Top Description Methods
org.apache.commons.math3.linear

public Interface FieldMatrixChangingVisitor<T extends FieldElement<?>>

Known Direct Implementers
org.apache.commons.math3.linear.DefaultFieldMatrixChangingVisitor
Type Parameters
<T>
the type of the field elements
Imports
org.apache.commons.math3.FieldElement

Interface defining a visitor for matrix entries.
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public T

Returns:

the value that the walkInXxxOrder must return
end
()

End visiting a matrix.

public void
start(int
number of rows of the matrix
rows
,
int
number of columns of the matrix
columns
,
int
Initial row index
startRow
,
int
Final row index (inclusive)
endRow
,
int
Initial column index
startColumn
,
int
Final column index (inclusive)
endColumn
)

Start visiting a matrix.

public T

Returns:

the new value to be set for the entry
visit
(int
row index of the entry
row
,
int
column index of the entry
column
,
T
current value of the entry
value
)

Visit one matrix entry.

Method Detail

endback to summary
public T end()

End visiting a matrix.

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

Returns:T

the value that the walkInXxxOrder must return

startback to summary
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.

Parameters
rows:int

number of rows of the matrix

columns:int

number of columns of the matrix

startRow:int

Initial row index

endRow:int

Final row index (inclusive)

startColumn:int

Initial column index

endColumn:int

Final column index (inclusive)

visitback to summary
public T visit(int row, int column, T value)

Visit one matrix entry.

Parameters
row:int

row index of the entry

column:int

column index of the entry

value:T

current value of the entry

Returns:T

the new value to be set for the entry