From 412e59c28601689f093d1ab32774fa031c0815be Mon Sep 17 00:00:00 2001 From: Sebastien Brisard Date: Thu, 1 Dec 2011 07:43:03 +0000 Subject: [PATCH] Improved (?) javadoc (MATH-677). git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1208986 13f79535-47bb-0310-9956-ffa450edef68 --- .../transform/FastHadamardTransformer.java | 139 ++++++++++-------- 1 file changed, 78 insertions(+), 61 deletions(-) diff --git a/src/main/java/org/apache/commons/math/transform/FastHadamardTransformer.java b/src/main/java/org/apache/commons/math/transform/FastHadamardTransformer.java index b510de72e..9bf198695 100644 --- a/src/main/java/org/apache/commons/math/transform/FastHadamardTransformer.java +++ b/src/main/java/org/apache/commons/math/transform/FastHadamardTransformer.java @@ -75,18 +75,17 @@ public class FastHadamardTransformer implements RealTransformer { } /** - * The FHT (Fast Hadamard Transformation) which uses only subtraction and addition. - *
- * Requires Nlog2N = n2n additions. - *
- *
- * Short Table of manual calculation for N=8: + * The FHT (Fast Hadamard Transformation) which uses only subtraction and + * addition. Requires {@code N * log2(N) = n * 2^n} additions. + * + *

Short Table of manual calculation for N=8

*
    - *
  1. x is the input vector we want to transform
    2. - *
  2. y is the output vector which is our desired result
    3. - *
  3. a and b are just helper rows
    4. + *
  4. x is the input vector to be transformed,
    5. + *
  5. y is the output vector (Fast Hadamard transform of x),
    6. + *
  6. a and b are helper rows.
    7. *
- * + *
+ * * * * @@ -94,109 +93,127 @@ public class FastHadamardTransformer implements RealTransformer { * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * * + * *
xay
x0x0a0 = x0 + x1b0 = a0 + a1y0 = b0+ b1
x1x1a1 = x2 + x3b0 = a2 + a3y0 = b2 + b3
x2x2a2 = x4 + x5b0 = a4 + a5y0 = b4 + b5
x3x3a3 = x6 + x7b0 = a6 + a7y0 = b6 + b7
x4x4a0 = x0 - x1b0 = a0 - a1y0 = b0 - b1
x5x5a1 = x2 - x3b0 = a2 - a3y0 = b2 - b3
x6x6a2 = x4 - x5b0 = a4 - a5y0 = b4 - b5
x7x7a3 = x6 - x7b0 = a6 - a7y0 = b6 - b7
* - * How it works + *

How it works

*
    - *
  1. Construct a matrix with N rows and n+1 columns
    hadm[n+1][N] - *
    (If I use [x][y] it always means [row-offset][column-offset] of a Matrix with n rows and m columns. Its entries go from M[0][0] to M[n][m])
    2. - *
  2. Place the input vector x[N] in the first column of the matrix hadm
    3. - *
  3. The entries of the submatrix Dtop are calculated as follows. - *
    Dtop goes from entry [0][1] to [N/2-1][n+1]. - *
    The columns of Dtop are the pairwise mutually exclusive sums of the previous column + *
  4. Construct a matrix with {@code N} rows and {@code n + 1} columns, + * {@code hadm[n+1][N]}.
    + * (If I use [x][y] it always means [row-offset][column-offset] of a + * Matrix with n rows and m columns. Its entries go from M[0][0] + * to M[n][N])
    5. + *
  5. Place the input vector {@code x[N]} in the first column of the + * matrix {@code hadm}.
    6. + *
  6. The entries of the submatrix {@code D_top} are calculated as follows + *
      + *
    • {@code D_top} goes from entry {@code [0][1]} to + * {@code [N / 2 - 1][n + 1]},
      • + *
    • the columns of {@code D_top} are the pairwise mutually + * exclusive sums of the previous column.
      • + *
    *
    7. - *
  7. The entries of the submatrix Dbottom are calculated as follows. - *
    Dbottom goes from entry [N/2][1] to [N][n+1]. - *
    The columns of Dbottom are the pairwise differences of the previous column + *
  8. The entries of the submatrix {@code D_bottom} are calculated as + * follows + *
      + *
    • {@code D_bottom} goes from entry {@code [N / 2][1]} to + * {@code [N][n + 1]},
      • + *
    • the columns of {@code D_bottom} are the pairwise differences + * of the previous column.
      • + *
    *
    9. - *
  9. How Dtop and Dbottom you can understand best with the example for N=8 above. - *
  10. The output vector y is now in the last column of hadm
    11. - *
  11. Algorithm from: http://www.archive.chipcenter.com/dsp/DSP000517F1.html
    12. + *
  12. The consputation of {@code D_top} and {@code D_bottom} are best + * understood with the above example (for {@code N = 8}). + *
  13. The output vector {@code y} is now in the last column of + * {@code hadm}.
    14. + *
  14. Algorithm from chipcenter.
    15. *
- *
- * Visually - * + *

Visually

+ *
+ * * - * - * - * - * - * - * + * + * + * * * - * + * * - * + * * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
0123...n + 10123…n + 1
00x0↑ + * ↑
+ * ← Dtop →
+ * ↓ + *
1x1
2x2
……
N / 2 - 1xN/2-1
N / 2xN/2 + * ↑
+ * ← Dbottom →
+ * ↓ + *
N / 2 + 1xN/2+1
N / 2 + 2xN/2+2
……
NxN
- * 
-     *        +--------+---+---+---+-----+---+
-     *        |   0    | 1 | 2 | 3 | ... |n+1|
-     * +------+--------+---+---+---+-----+---+
-     * |0     | x0     |       /\            |
-     * |1     | x1     |       ||            |
-     * |2     | x2     |   <= Dtop  =>       |
-     * |...   | ...    |       ||            |
-     * |N/2-1 | xN/2-1  |       \/            |
-     * +------+--------+---+---+---+-----+---+
-     * |N/2   | xN/2   |       /\            |
-     * |N/2+1 | xN/2+1  |       ||            |
-     * |N/2+2 | xN/2+2  |  <= Dbottom  =>      | which is in the last column of the matrix
-     * |...   | ...    |       ||            |
-     * |N     | xN/2   |        \/           |
-     * +------+--------+---+---+---+-----+---+
-     *
* - * @param x input vector - * @return y output vector + * @param x the input vector + * @return the output vector, {@code y} * @exception IllegalArgumentException if input array is not a power of 2 */ protected double[] fht(double[] x) throws IllegalArgumentException {