mirror of
https://github.com/apache/commons-math.git
synced 2025-02-06 01:59:13 +00:00
MATH-854: populated throws clause of FieldMatrix.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1392742 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
d685138370
commit
9f663a15e6
@ -27,7 +27,6 @@ import org.apache.commons.math3.exception.NotStrictlyPositiveException;
|
|||||||
import org.apache.commons.math3.exception.NullArgumentException;
|
import org.apache.commons.math3.exception.NullArgumentException;
|
||||||
import org.apache.commons.math3.exception.NumberIsTooSmallException;
|
import org.apache.commons.math3.exception.NumberIsTooSmallException;
|
||||||
import org.apache.commons.math3.exception.OutOfRangeException;
|
import org.apache.commons.math3.exception.OutOfRangeException;
|
||||||
import org.apache.commons.math3.exception.ZeroException;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Interface defining field-valued matrix with basic algebraic operations.
|
* Interface defining field-valued matrix with basic algebraic operations.
|
||||||
@ -220,40 +219,43 @@ public interface FieldMatrix<T extends FieldElement<T>> extends AnyMatrix {
|
|||||||
OutOfRangeException;
|
OutOfRangeException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Replace the submatrix starting at {@code (row, column)} using data in
|
* Replace the submatrix starting at {@code (row, column)} using data in the
|
||||||
* the input {@code subMatrix} array. Indexes are 0-based.
|
* input {@code subMatrix} array. Indexes are 0-based.
|
||||||
* <p>
|
* <p>
|
||||||
* Example:<br>
|
* Example:<br>
|
||||||
* Starting with <pre>
|
* Starting with
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
* 1 2 3 4
|
* 1 2 3 4
|
||||||
* 5 6 7 8
|
* 5 6 7 8
|
||||||
* 9 0 1 2
|
* 9 0 1 2
|
||||||
* </pre>
|
* </pre>
|
||||||
|
*
|
||||||
* and <code>subMatrix = {{3, 4} {5,6}}</code>, invoking
|
* and <code>subMatrix = {{3, 4} {5,6}}</code>, invoking
|
||||||
* <code>setSubMatrix(subMatrix,1,1))</code> will result in <pre>
|
* <code>setSubMatrix(subMatrix,1,1))</code> will result in
|
||||||
|
*
|
||||||
|
* <pre>
|
||||||
* 1 2 3 4
|
* 1 2 3 4
|
||||||
* 5 3 4 8
|
* 5 3 4 8
|
||||||
* 9 5 6 2
|
* 9 5 6 2
|
||||||
* </pre></p>
|
* </pre>
|
||||||
|
*
|
||||||
|
* </p>
|
||||||
*
|
*
|
||||||
* @param subMatrix Array containing the submatrix replacement data.
|
* @param subMatrix Array containing the submatrix replacement data.
|
||||||
* @param row Row coordinate of the top-left element to be replaced.
|
* @param row Row coordinate of the top-left element to be replaced.
|
||||||
* @param column Column coordinate of the top-left element to be replaced.
|
* @param column Column coordinate of the top-left element to be replaced.
|
||||||
* @throws MatrixDimensionMismatchException
|
* @throws OutOfRangeException if {@code subMatrix} does not fit into this
|
||||||
* if {@code subMatrix} does not fit into this matrix from element in
|
* matrix from element in {@code (row, column)}.
|
||||||
* {@code (row, column)}.
|
* @throws NoDataException if a row or column of {@code subMatrix} is empty.
|
||||||
* @throws org.apache.commons.math3.exception.ZeroException if a row or column
|
* @throws DimensionMismatchException if {@code subMatrix} is not
|
||||||
* of {@code subMatrix} is empty.
|
* rectangular (not all rows have the same length).
|
||||||
* @throws org.apache.commons.math3.exception.DimensionMismatchException
|
* @throws NullArgumentException if {@code subMatrix} is {@code null}.
|
||||||
* if {@code subMatrix} is not rectangular (not all rows have the same
|
|
||||||
* length).
|
|
||||||
* @throws org.apache.commons.math3.exception.NullArgumentException
|
|
||||||
* if {@code subMatrix} is {@code null}.
|
|
||||||
* @since 2.0
|
* @since 2.0
|
||||||
*/
|
*/
|
||||||
void setSubMatrix(T[][] subMatrix, int row, int column)
|
void setSubMatrix(T[][] subMatrix, int row, int column)
|
||||||
throws DimensionMismatchException, MatrixDimensionMismatchException,
|
throws DimensionMismatchException, OutOfRangeException,
|
||||||
NullArgumentException, ZeroException;
|
NullArgumentException, NoDataException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the entries in row number {@code row}
|
* Get the entries in row number {@code row}
|
||||||
@ -554,6 +556,8 @@ public interface FieldMatrix<T extends FieldElement<T>> extends AnyMatrix {
|
|||||||
* @param startColumn Initial column index
|
* @param startColumn Initial column index
|
||||||
* @param endColumn Final column index
|
* @param endColumn Final column index
|
||||||
* @throws OutOfRangeException if the indices are not valid.
|
* @throws OutOfRangeException if the indices are not valid.
|
||||||
|
* @throws NumberIsTooSmallException if {@code endRow < startRow} or
|
||||||
|
* {@code endColumn < startColumn}.
|
||||||
* @see #walkInRowOrder(FieldMatrixChangingVisitor)
|
* @see #walkInRowOrder(FieldMatrixChangingVisitor)
|
||||||
* @see #walkInRowOrder(FieldMatrixPreservingVisitor)
|
* @see #walkInRowOrder(FieldMatrixPreservingVisitor)
|
||||||
* @see #walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
|
* @see #walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
|
||||||
@ -570,7 +574,7 @@ public interface FieldMatrix<T extends FieldElement<T>> extends AnyMatrix {
|
|||||||
*/
|
*/
|
||||||
T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor,
|
T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor,
|
||||||
int startRow, int endRow, int startColumn, int endColumn)
|
int startRow, int endRow, int startColumn, int endColumn)
|
||||||
throws OutOfRangeException;
|
throws OutOfRangeException, NumberIsTooSmallException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Visit (but don't change) some matrix entries in row order.
|
* Visit (but don't change) some matrix entries in row order.
|
||||||
@ -583,6 +587,8 @@ public interface FieldMatrix<T extends FieldElement<T>> extends AnyMatrix {
|
|||||||
* @param startColumn Initial column index
|
* @param startColumn Initial column index
|
||||||
* @param endColumn Final column index
|
* @param endColumn Final column index
|
||||||
* @throws OutOfRangeException if the indices are not valid.
|
* @throws OutOfRangeException if the indices are not valid.
|
||||||
|
* @throws NumberIsTooSmallException if {@code endRow < startRow} or
|
||||||
|
* {@code endColumn < startColumn}.
|
||||||
* @see #walkInRowOrder(FieldMatrixChangingVisitor)
|
* @see #walkInRowOrder(FieldMatrixChangingVisitor)
|
||||||
* @see #walkInRowOrder(FieldMatrixPreservingVisitor)
|
* @see #walkInRowOrder(FieldMatrixPreservingVisitor)
|
||||||
* @see #walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
|
* @see #walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
|
||||||
@ -599,7 +605,7 @@ public interface FieldMatrix<T extends FieldElement<T>> extends AnyMatrix {
|
|||||||
*/
|
*/
|
||||||
T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor,
|
T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor,
|
||||||
int startRow, int endRow, int startColumn, int endColumn)
|
int startRow, int endRow, int startColumn, int endColumn)
|
||||||
throws OutOfRangeException;
|
throws OutOfRangeException, NumberIsTooSmallException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Visit (and possibly change) all matrix entries in column order.
|
* Visit (and possibly change) all matrix entries in column order.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user