Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MATH-854: in interface FieldVector, some more exceptions are *documented* (as recommendations), but not *specified*. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1384211 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastien Brisard 2012-09-13 06:10:06 +00:00
parent 443f412728
commit 10af7e2b2f
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/main/java/org/apache/commons/math3/linear/FieldVector.java
View File

@ -78,45 +78,63 @@ public interface FieldVector<T extends FieldElement<T>> {
FieldVector<T> subtract(FieldVector<T> v);
/**
* Map an addition operation to each entry.
* Map an addition operation to each entry. Implementations should throw
* {@link org.apache.commons.math3.exception.NullArgumentException} if
* {@code d} is {@code null}.
*
* @param d value to be added to each entry
* @return {@code this + d}
*/
FieldVector<T> mapAdd(T d);
/**
* Map an addition operation to each entry.
* <p>The instance <strong>is</strong> changed by this method.</p>
* Map an addition operation to each entry. The instance <strong>is</strong>
* changed by this method. Implementations should throw
* {@link org.apache.commons.math3.exception.NullArgumentException} if
* {@code d} is {@code null}.
*
* @param d value to be added to each entry
* @return for convenience, return {@code this}
*/
FieldVector<T> mapAddToSelf(T d);
/**
* Map a subtraction operation to each entry.
* Map a subtraction operation to each entry. Implementations should throw
* {@link org.apache.commons.math3.exception.NullArgumentException} if
* {@code d} is {@code null}.
*
* @param d value to be subtracted to each entry
* @return {@code this - d}
*/
FieldVector<T> mapSubtract(T d);
/**
* Map a subtraction operation to each entry.
* <p>The instance <strong>is</strong> changed by this method.</p>
* Map a subtraction operation to each entry. The instance
* <strong>is</strong> changed by this method. Implementations should throw
* {@link org.apache.commons.math3.exception.NullArgumentException} if
* {@code d} is {@code null}.
*
* @param d value to be subtracted to each entry
* @return for convenience, return {@code this}
*/
FieldVector<T> mapSubtractToSelf(T d);
/**
* Map a multiplication operation to each entry.
* Map a multiplication operation to each entry. Implementations should throw
* {@link org.apache.commons.math3.exception.NullArgumentException} if
* {@code d} is {@code null}.
*
* @param d value to multiply all entries by
* @return {@code this * d}
*/
FieldVector<T> mapMultiply(T d);
/**
* Map a multiplication operation to each entry.
* <p>The instance <strong>is</strong> changed by this method.</p>
* Map a multiplication operation to each entry. The instance
* <strong>is</strong> changed by this method. Implementations should throw
* {@link org.apache.commons.math3.exception.NullArgumentException} if
* {@code d} is {@code null}.
*
* @param d value to multiply all entries by
* @return for convenience, return {@code this}
*/