Apache/commons-math
1
0
Fork 0
mirror of https://github.com/apache/commons-math.git synced 2025-02-08 02:59:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Formatting and javadoc.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1522083 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2013-09-11 22:42:15 +00:00
parent 9a50472883
commit 4c7b801625
1 changed files with 143 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/main/java/org/apache/commons/math3/util/MathArrays.java
View File

@ -1274,17 +1274,18 @@ public class MathArrays {
/** /**
* Normalizes an array to make it sum to a specified value. * Normalizes an array to make it sum to a specified value.
* Returns the result of the transformation <pre> * Returns the result of the transformation
* <pre>
* x |-> x * normalizedSum / sum * x |-> x * normalizedSum / sum
* </pre> * </pre>
* applied to each non-NaN element x of the input array, where sum is the * applied to each non-NaN element x of the input array, where sum is the
* sum of the non-NaN entries in the input array.</p> * sum of the non-NaN entries in the input array.
* * <p>
* <p>Throws IllegalArgumentException if {@code normalizedSum} is infinite * Throws IllegalArgumentException if {@code normalizedSum} is infinite
* or NaN and ArithmeticException if the input array contains any infinite elements * or NaN and ArithmeticException if the input array contains any infinite elements
* or sums to 0.</p> * or sums to 0.
* * <p>
* <p>Ignores (i.e., copies unchanged to the output array) NaNs in the input array.</p> * Ignores (i.e., copies unchanged to the output array) NaNs in the input array.
* *
* @param values Input array to be normalized * @param values Input array to be normalized
* @param normalizedSum Target sum for the normalized array * @param normalizedSum Target sum for the normalized array
@ -1329,7 +1330,7 @@ public class MathArrays {
/** Build an array of elements. /** Build an array of elements.
* <p> * <p>
* Arrays are filled with field.getZero() * Arrays are filled with field.getZero()
* </p> *
* @param <T> the type of the field elements * @param <T> the type of the field elements
* @param field field to which array elements belong * @param field field to which array elements belong
* @param length of the array * @param length of the array
@ -1346,7 +1347,7 @@ public class MathArrays {
/** Build a double dimension array of elements. /** Build a double dimension array of elements.
* <p> * <p>
* Arrays are filled with field.getZero() * Arrays are filled with field.getZero()
* </p> *
* @param <T> the type of the field elements * @param <T> the type of the field elements
* @param field field to which array elements belong * @param field field to which array elements belong
* @param rows number of rows in the array * @param rows number of rows in the array
@ -1376,21 +1377,19 @@ public class MathArrays {
/** /**
* Calculates the <a href="http://en.wikipedia.org/wiki/Convolution"> * Calculates the <a href="http://en.wikipedia.org/wiki/Convolution">
* convolution</a> between two sequences. * convolution</a> between two sequences.
* <p>
* The solution is obtained via straightforward computation of the * The solution is obtained via straightforward computation of the
* convolution sum (and not via FFT). * convolution sum (and not via FFT). Whenever the computation needs
* Whenever the computation needs an element that would be located * an element that would be located at an index outside the input arrays,
* at an index outside the input arrays, the value is assumed to be * the value is assumed to be zero.
* zero.
* *
* @param x First sequence. * @param x First sequence.
* Typically, this sequence will represent an input signal to a system. * Typically, this sequence will represent an input signal to a system.
* @param h Second sequence. * @param h Second sequence.
* Typically, this sequence will represent the impulse response of the * Typically, this sequence will represent the impulse response of the system.
* system.
* @return the convolution of {@code x} and {@code h}. * @return the convolution of {@code x} and {@code h}.
* This array's length will be {@code x.length + h.length - 1}. * This array's length will be {@code x.length + h.length - 1}.
* @throws NullArgumentException if either {@code x} or {@code h} is * @throws NullArgumentException if either {@code x} or {@code h} is {@code null}.
* {@code null}.
* @throws NoDataException if either {@code x} or {@code h} is empty. * @throws NoDataException if either {@code x} or {@code h} is empty.
* *
* @since 3.3 * @since 3.3