/* A library for mathematical operations on arrays of complex numbers.

 Copyright (c) 1998-2013 The Regents of the University of California.
 All rights reserved.

 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the above
 copyright notice and the following two paragraphs appear in all copies
 of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION_2
 COPYRIGHTENDKEY

 */
package ptolemy.math;

///////////////////////////////////////////////////////////////////
//// ComplexArrayMath

/**
 This class a provides a library for mathematical operations on arrays of
 complex numbers, in particular arrays of instances of class
 ptolemy.math.Complex.
 Unless explicitly noted otherwise, all array arguments are assumed to be
 non-null. If a null array is passed to a method, a NullPointerException
 will be thrown in the method or called methods.

 @author Albert Chen, William Wu, Edward A. Lee, Jeff Tsay
 @version $Id: ComplexArrayMath.java 65768 2013-03-07 03:33:00Z cxh $
 @since Ptolemy II 0.3
 @Pt.ProposedRating Yellow (ctsay)
 @Pt.AcceptedRating Yellow (ctsay)
 */
public class ComplexArrayMath {
    // Protected constructor prevents construction of this class.
    protected ComplexArrayMath() {
    }

    /** Return a new array that is constructed from <i>array</i> by
     *  adding the complex number <i>z</i> to every element of <i>array</i>.
     *
     *  @param array An array of complex numbers.
     *  @param z The complex number to be added to each element of <i>array</i>.
     *  @return A new array of complex numbers equal to <i>array</i> with
     *  <i>z</i> added to each element.
     */
    public static final Complex[] add(Complex[] array, Complex z) {
        Complex[] result = new Complex[array.length];

        for (int i = 0; i < array.length; i++) {
            result[i] = array[i].add(z);
        }

        return result;
    }

    /** Return a new array that is the element-by-element sum of the two
     *  input arrays.
     *  If the sizes of both arrays are 0, return a new array of size 0.
     *
     *  @param array1 The first array.
     *  @param array2 The second array.
     *  @return A new array that is the element-by-element sum of the two
     *  input arrays.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final Complex[] add(Complex[] array1, Complex[] array2) {
        int length = _commonLength(array1, array2, "ComplexArrayMath.add");
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = array1[i].add(array2[i]);
        }

        return returnValue;
    }

    /** Return a new array that is the result of appending <i>array2</i>
     *  to the end of <i>array1</i>. This method simply calls
     *  append(array1, 0, array1.length, array2, 0, array2.length)
     *
     *  @param array1 The first array of complex numbers.
     *  @param array2 The second array of complex numbers.
     *  @return A new array formed by appending <i>array2</i>
     *  to the end of <i>array1</i>.
     */
    public static final Complex[] append(Complex[] array1, Complex[] array2) {
        return append(array1, 0, array1.length, array2, 0, array2.length);
    }

    /** Return a new array that is the result of appending
     *  <i>length2</i> elements of <i>array2</i>, starting from the
     *  <i>idx2</i>th element, to <i>length1</i> elements of
     *  <i>array1</i>, starting from the <i>idx1</i>th element.
     *
     *  Appending empty arrays is supported. In that case, the corresponding
     *  idx may be any number. Allow System.arraycopy() to throw array access
     *  exceptions if idx .. idx + length - 1 are not all valid array indices,
     *  for both of the arrays.
     *
     *  @param array1 The first array of complex numbers.
     *  @param idx1 The starting index for array1.
     *  @param length1 The number of elements of array1 to use.
     *  @param array2 The second array of complex numbers, which is appended.
     *  @param idx2 The starting index for array2.
     *  @param length2 The number of elements of array2 to append.
     *  @return A new array of Complex.
     */
    public static final Complex[] append(Complex[] array1, int idx1,
            int length1, Complex[] array2, int idx2, int length2) {
        Complex[] returnValue = new Complex[length1 + length2];

        if (length1 > 0) {
            System.arraycopy(array1, idx1, returnValue, 0, length1);
        }

        if (length2 > 0) {
            System.arraycopy(array2, idx2, returnValue, length1, length2);
        }

        return returnValue;
    }

    /** Return a new array that is formed by applying an instance of a
     *  ComplexBinaryOperation to each element in the input array,
     *  using <i>z</i> as the left argument to <i>op</i> in all cases and
     *  the array elements as the right arguments (op.operate(z, array[i])).
     *  If the length of the array is 0, return a new array of length 0.
     *
     *  @param op The complex binary operation to be applied to the given
     *  complex number and complex array.
     *  @param z The complex number that is the first argument to <i>op</i>.
     *  @param array The array of complex numbers that is the second argument
     *  to <i>op</i>.
     *  @return A new array containing elements equal to
     *  (op.operate(z, array[i])).
     */
    public static final Complex[] applyBinaryOperation(
            ComplexBinaryOperation op, final Complex z, final Complex[] array) {
        int length = array.length;
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = op.operate(z, array[i]);
        }

        return returnValue;
    }

    /** Return a new array that is formed by applying an instance of a
     *  ComplexBinaryOperation to each element in the input array,
     *  using <i>z</i> as the right operand in all cases and the array elements
     *  as the left operands (op.operate(array[i], z)).
     *  If the length of the array is 0, return a new array of length 0.
     *
     *  @param op The complex binary operation to be applied to the given
     *  complex number and complex array.
     *  @param z The complex number that is the second argument to <i>op</i>.
     *  @param array The array of complex numbers that is the first argument
     *  to <i>op</i>.
     *  @return A new array containing elements equal to
     *  (op.operate(array[i], z)).
     */
    public static final Complex[] applyBinaryOperation(
            ComplexBinaryOperation op, final Complex[] array, final Complex z) {
        int length = array.length;
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = op.operate(array[i], z);
        }

        return returnValue;
    }

    /** Return a new array that is formed by applying an instance of a
     *  ComplexBinaryOperation to the two arrays, element by element,
     *  using the elements of the first array as the left operands and the
     *  elements of the second array as the right operands.
     *  (op.operate(array[i], array2[i])).
     *  If the lengths of both arrays are 0, return a new array of length 0.
     *
     *  @param op The complex binary operation to be applied to each pair
     *  of corresponding elements of each complex array.
     *  @param array1 The first array.
     *  @param array2 The second array.
     *  @return A new array that with elements equal to
     *  (op.operate(array[i], array2[i])).
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final Complex[] applyBinaryOperation(
            ComplexBinaryOperation op, final Complex[] array1,
            final Complex[] array2) {
        int length = _commonLength(array1, array2,
                "ComplexArrayMath.applyBinaryOperation");
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = op.operate(array1[i], array2[i]);
        }

        return returnValue;
    }

    /** Return a new array that is formed by applying an instance of a
     *  ComplexUnaryOperation to each element in the input array
     *  (op.operate(array[i])).
     *  If the length of the array is 0, return a new array of length 0.
     *
     *  @param op The complex unary operation to be applied to each
     *  element of the given complex array.
     *  @param array An array of complex numbers.
     *  @return A new array of complex numbers with each element
     *  equal to (op.operate(array[i])).
     */
    public static final Complex[] applyUnaryOperation(
            final ComplexUnaryOperation op, final Complex[] array) {
        int length = array.length;
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = op.operate(array[i]);
        }

        return returnValue;
    }

    /** Return a new array of complex numbers that is formed by taking the
     *  complex-conjugate of each element in the argument array.
     *  If the argument has length 0, return a new array of complex numbers,
     *  with length 0.
     *
     *  @param array The given array of complex numbers.
     *  @return A new array of complex numbers formed by taking the
     *  complex-conjugate of each element in the argument array.
     */
    public static final Complex[] conjugate(Complex[] array) {
        Complex[] result = new Complex[array.length];

        for (int i = array.length - 1; i >= 0; i--) {
            result[i] = array[i].conjugate();
        }

        return result;
    }

    /** Return a new array that is the element-by-element division of
     *  the first array by the second array.
     *  If the sizes of both arrays are 0, return a new array of size 0.
     *
     *  @param array1 The first array of complex numbers.
     *  @param array2 The second array of complex numbers.
     *  @return A new array of complex numbers equal to the
     *  element-by-element division of the first array by the second array.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final Complex[] divideElements(Complex[] array1,
            Complex[] array2) {
        int length = _commonLength(array1, array2,
                "ComplexArrayMath.divideElements");
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = array1[i].divide(array2[i]);
        }

        return returnValue;
    }

    /** Return a new array that is the result of dividing each element of
     *  the given array by the given value.
     *
     *  @param array An array of complex numbers.
     *  @param divisor The number by which to divide each element of the array.
     *  @return A new array of complex numbers that is the result of dividing
     *  each element of <i>array</i> by <i>divisor</i>.
     */
    public static final Complex[] divide(Complex[] array, Complex divisor) {
        int length = array.length;
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = array[i].divide(divisor);
        }

        return returnValue;
    }

    /** Return a complex number that is the dot product of the two argument
     *  arrays. The dot product is computed by the sum of the
     *  element-by-element products of <i>array1</i> and the complex
     *  conjugates of <i>array2</i>.
     *  If the size of each array is 0, return Complex.ZERO.
     *
     *  @param array1 The first array of complex numbers.
     *  @param array2 The second array of complex numbers.
     *  @return A new array of complex numbers equal to the
     *  dot product of the two given arrays.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final Complex dotProduct(final Complex[] array1,
            final Complex[] array2) {
        int length = _commonLength(array1, array2,
                "ComplexArrayMath.dotProduct");
        Complex returnValue = Complex.ZERO;

        for (int i = 0; i < length; i++) {
            returnValue = returnValue.add(array1[i].multiply(array2[i]
                    .conjugate()));
        }

        return returnValue;
    }

    /** Return a new array of Complex numbers using two arrays for the
     *  real and imaginary parts. If <i>realPart</i> is null, it is
     *  treated as if it were an array of zeros and an array of
     *  complex numbers that are purely imaginary is constructed. If
     *  <i>imagPart</i> is null, it is treated as if it were an array
     *  of zeroes and an array of complex numbers that are purely real
     *  is constructed.  If both arrays are of length 0, or one array
     *  is null and the other array is of length 0, return a new array
     *  of complex numbers with length 0.  If both arrays are null,
     *  allow a NullPointerException to be thrown by the array access
     *  code.
     *
     *  @param realPart An array of doubles, used for the real parts.
     *  @param imagPart An array of doubles, used for the imaginary parts.
     *  @return A new array of complex numbers each containing real
     *  and imaginary parts equal to the elements in <i>realPart</i>
     *  and <i>imagPart</i>, respectively.
     */
    public static final Complex[] formComplexArray(final double[] realPart,
            final double[] imagPart) {
        Complex[] returnValue;
        int size;

        if (realPart != null && imagPart != null) {
            size = DoubleArrayMath._commonLength(realPart, imagPart,
                    "ComplexArrayMath.formComplexArray");
            returnValue = new Complex[size];

            for (int i = 0; i < size; i++) {
                returnValue[i] = new Complex(realPart[i], imagPart[i]);
            }
        } else if (realPart == null) {
            // NullPointerException will be thrown here if both
            // arrays are null.
            size = imagPart.length;

            returnValue = new Complex[size];

            for (int i = 0; i < size; i++) {
                returnValue[i] = new Complex(0.0, imagPart[i]);
            }
        } else { // imagPart == null
            size = realPart.length;

            returnValue = new Complex[size];

            for (int i = 0; i < size; i++) {
                returnValue[i] = new Complex(realPart[i], 0.0);
            }
        }

        return returnValue;
    }

    /** Return a new array of doubles with the imaginary parts of the array of
     *  complex numbers.
     *
     *  @param x The input array of complex numbers.
     *  @return A new array of doubles with the imaginary parts of the array of
     *  complex numbers.
     */
    public static final double[] imagParts(final Complex[] x) {
        int size = x.length;

        double[] returnValue = new double[size];

        for (int i = 0; i < size; i++) {
            returnValue[i] = x[i].imag;
        }

        return returnValue;
    }

    /** Return a double that is the L2-norm of the array.  If the
     *  length of the array is zero, return 0.0.
     *
     *  @param array The given array of complex numbers.
     *  @return A double that is the L2-norm of <i>array</i>.
     */
    public static final double l2norm(Complex[] array) {
        return Math.sqrt(l2normSquared(array));
    }

    /** Return a double that is the sum of the squared magnitudes of
     *  the elements of <i>array</i>. This is equal to the square of the
     *  L2-norm of <i>array</i>. If the length of the array is zero,
     *  return 0.0.
     *
     *  @param array The given array of complex numbers.
     *  @return A double that is square of the L2-norm of <i>array</i>.
     */
    public static final double l2normSquared(Complex[] array) {
        int length = array.length;

        if (length <= 0) {
            return 0.0;
        }

        double returnValue = 0.0;

        for (int i = 0; i < length; i++) {
            returnValue += array[i].magnitudeSquared();
        }

        return returnValue;
    }

    /** Return a new array that is a copy of the first argument except
     *  that the elements are limited to lie within the specified range.
     *  The specified range is given by two complex numbers, <i>bottom</i>
     *  and <i>top</i>, where both the real and imaginary parts of
     *  <i>bottom</i> are expected to be less than the real and imaginary
     *  parts of <i>top</i>. Thus, <i>bottom</i> and <i>top</i> define a
     *  rectangle in the complex plane, with <i>bottom</i> at the lower
     *  left and <i>top</i> at the upper right.
     *  If any value in the array is infinite
     *  then it is replaced by the corresponding real or imaginary part
     *  of <i>top</i> or <i>bottom</i>, depending on the sign of infinity.
     *  If any value is NaN (not a number), then the result will be NaN.
     *  To leave either the bottom or the top unconstrained,
     *  specify Complex.NEGATIVE_INFINITY or Complex.POSITIVE_INFINITY.
     *  If the length of the array is 0, return a new array of length 0.
     *
     *  @param array An array of complex numbers.
     *  @param bottom The bottom limit.
     *  @param top The top limit.
     *  @return A new array with values in the rectangle defined by
     *   <i>bottom</i> and <i>top</i>.
     *  @exception IllegalArgumentException If <i>bottom</i> has either a
     *   real or imaginary part larger than the corresponding part of
     *   <i>top</i>.
     */
    public static final Complex[] limit(Complex[] array, Complex bottom,
            Complex top) throws IllegalArgumentException {
        Complex[] returnValue = new Complex[array.length];

        // Check validity of the rectangle.
        if (bottom.real > top.real || bottom.imag > top.imag) {
            throw new IllegalArgumentException(
                    "Complex.limit requires that bottom lie below and "
                            + "to the left of top.");
        }

        for (int i = 0; i < array.length; i++) {
            double realPart;
            double imagPart;

            // NOTE: Assume here that if array[i].real is NaN, then
            // this test returns false.
            if (array[i].real > top.real) {
                realPart = top.real;
            } else if (array[i].real < bottom.real) {
                realPart = bottom.real;
            } else {
                realPart = array[i].real;
            }

            // NOTE: Assume here that if array[i].imag is NaN, then
            // this test returns false.
            if (array[i].imag > top.imag) {
                imagPart = top.imag;
            } else if (array[i].imag < bottom.imag) {
                imagPart = bottom.imag;
            } else {
                imagPart = array[i].imag;
            }

            returnValue[i] = new Complex(realPart, imagPart);
        }

        return returnValue;
    }

    /** Return a new array of doubles containing the magnitudes of the elements
     *  of the specified array of complex numbers.
     *
     *  @param array The given array of complex numbers.
     *  @return A new array of doubles containing the magnitudes of
     *  the elements of the specified array of complex numbers.
     */
    public static final double[] magnitude(Complex[] array) {
        double[] mags = new double[array.length];

        for (int i = array.length - 1; i >= 0; i--) {
            mags[i] = array[i].magnitude();
        }

        return mags;
    }

    /** Return a new array that is the element-by-element multiplication of
     *  the two input arrays.
     *  If the size of each array is 0, return a new array of size 0.
     *
     *  @param array1 The first array of complex numbers.
     *  @param array2 The second array of complex numbers.
     *  @return A new array of complex numbers equal to the
     *  element-by-element multiplication of the two given arrays.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final Complex[] multiply(Complex[] array1, Complex[] array2) {
        int length = _commonLength(array1, array2, "ComplexArrayMath.multiply");
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = array1[i].multiply(array2[i]);
        }

        return returnValue;
    }

    /** Return a new array that is constructed from the argument by
     *  multiplying each element in <i>array</i> by the second argument,
     *  which is a complex number.
     *  If the size of the array is 0, return a new array of size 0.
     *
     *  @param array An array of complex numbers.
     *  @param factor The complex number by which each element of <i>array</i>
     *  is multiplied by.
     *  @return A new array of complex numbers formed by
     *  multiplying each element in <i>array</i> by <i>factor</i>.
     */
    public static final Complex[] multiply(Complex[] array, Complex factor) {
        int length = array.length;
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = array[i].multiply(factor);
        }

        return returnValue;
    }

    /** Return a new array that is the formed from the additive inverse of each
     *  element of the input array (-array[i]).
     *
     *  @param array The given array of complex numbers.
     *  @return A new array of complex numbers formed from the
     *  additive inverse of each element of the input array (-array[i]).
     */
    public static final Complex[] negative(final Complex[] array) {
        int length = array.length;
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = new Complex(-array[i].real, -array[i].imag);
        }

        return returnValue;
    }

    /** Return a new array of Complex numbers that is formed by padding the
     *  middle of the array with 0's. If the length of the
     *  input array is odd, the sample with index ceil(L/2) will be
     *  repeated in the output array, where L is the length of the input array.
     *  If the lengths of the input and output arrays are equal, return
     *  a copy of the input array.
     *  This method is useful for preparing data for an IFFT.
     *
     *  @param array An array of complex numbers.
     *  @param newLength The desired length of the returned array.
     *  @return A new array of complex numbers formed by padding the
     *  middle of <i>array</i> with 0's.
     */
    public static final Complex[] padMiddle(final Complex[] array,
            final int newLength) {
        int length = array.length;

        int entriesNeeded = newLength - length;

        if (entriesNeeded < 0) {
            throw new IllegalArgumentException("ptolemy.math."
                    + "ComplexArrayMath.padMiddle() : newLength must be "
                    + ">= length of array.");
        } else if (entriesNeeded == 0) {
            return resize(array, newLength); // allocates a new array
        }

        double halfLength = length * 0.5;
        int halfLengthFloor = (int) Math.floor(halfLength);
        int halfLengthCeil = (int) Math.ceil(halfLength);
        Complex[] returnValue = new Complex[newLength];

        System.arraycopy(array, 0, returnValue, 0, halfLengthCeil);

        System.arraycopy(array, halfLengthFloor, returnValue, newLength
                - halfLengthCeil, halfLengthCeil);

        for (int i = halfLengthCeil; i < newLength - halfLengthCeil; i++) {
            returnValue[i] = Complex.ZERO;
        }

        return returnValue;
    }

    /** Return a new array containing the angles of the elements of the
     *  specified complex array.
     *
     *  @param array An array of complex numbers.
     *  @return An array of angles in the range of
     *  <em>-pi</em> to <em>pi</em>.
     */
    public static final double[] phase(Complex[] array) {
        double[] angles = new double[array.length];

        for (int i = array.length - 1; i >= 0; i--) {
            angles[i] = array[i].angle();
        }

        return angles;
    }

    /** Given the roots of a polynomial, return a polynomial that has
     *  has such roots.  If the roots are
     *  [<em>r</em><sub>0</sub>, ..., <em>r</em><sub>N-1</sub>],
     *  then the polynomial is given by
     *  [<em>a</em><sub>0</sub>, ..., <em>a</em><sub>N</sub>], where
     *  <p>
     *  <em>a</em><sub>0</sub> +
     *  <em>a</em><sub>1</sub><em>z</em><sup>-1</sup> + ... +
     *  <em>a</em><sub>N</sub><em>z</em><sup>-N</sup> =
     *  (1 - <em>r</em><sub>0</sub><em>z</em><sup>-1</sup>)
     *  (1 - <em>r</em><sub>1</sub><em>z</em><sup>-1</sup>) ...
     *  (1 - <em>r</em><sub>N-1</sub><em>z</em><sup>-1</sup>).
     *  The returned polynomial will always be monic, meaning that
     *  <em>a</em><sub>0</sub> = 1.
     *
     *  @param roots An array of roots of a polynomial.
     *  @return A new array representing a monic polynomial with the given
     *  roots.
     */
    public static final Complex[] polynomial(final Complex[] roots) {
        if (roots.length <= 1) {
            return new Complex[] { Complex.ONE };
        }

        Complex[] result = new Complex[2];
        result[0] = Complex.ONE;

        if (roots.length >= 1) {
            result[1] = roots[0].negate();

            if (roots.length > 1) {
                for (int i = 1; i < roots.length; i++) {
                    Complex[] factor = { new Complex(1), roots[i].negate() };
                    result = SignalProcessing.convolve(result, factor);
                }
            }
        }

        return result;
    }

    /** Return a new array of complex numbers that is formed by raising each
     *  element to the specified exponent, a double.
     *  If the size of the array is 0, return a new array of size 0.
     *
     *  @param array The input array of complex numbers.
     *  @param exponent A double, which is the exponent.
     *  @return A new array that is formed by raising each
     *  element of <i>array</i> to the <i>element</i>th power.
     */
    public static final Complex[] pow(final Complex[] array,
            final double exponent) {
        int length = array.length;
        Complex[] returnValue = new Complex[length];

        for (int i = 0; i < length; i++) {
            returnValue[i] = array[i].pow(exponent);
        }

        return returnValue;
    }

    /** Return the product of the elements in the array.
     *  If there are no elements in the array, return a Complex number
     *  with value zero.
     *
     *  @param array An array of complex numbers.
     *  @return A new complex number equal to the product of
     *  the elements in the array.
     */
    public static final Complex product(final Complex[] array) {
        if (array.length == 0) {
            return Complex.ZERO;
        }

        double real = 1.0;
        double imag = 0.0;

        for (Complex element : array) {
            double tmp = real * element.real - imag * element.imag;
            imag = real * element.imag + imag * element.real;
            real = tmp;
        }

        return new Complex(real, imag);
    }

    /** Return a new array of doubles that includes the real
     *  parts of the array of complex numbers.
     *
     *  @param x An array of complex numbers
     *  @return A new array of doubles that includes the real
     *  parts of the array of complex numbers.
     */
    public static final double[] realParts(final Complex[] x) {
        int size = x.length;

        double[] returnValue = new double[size];

        for (int i = 0; i < size; i++) {
            returnValue[i] = x[i].real;
        }

        return returnValue;
    }

    /** Return a new array of length <i>newLength</i> that is formed by
     *  either truncating or padding the input array.
     *  This method simply calls :
     *  resize(array, newLength, 0)
     *
     *  @param array An array of complex numbers.
     *  @param newLength The desired size of the output array.
     *  @return A new array of length <i>newLength</i> that is formed by
     *  either truncating or padding <i>array</i>.
     */
    public static final Complex[] resize(final Complex[] array,
            final int newLength) {
        return resize(array, newLength, 0);
    }

    /** Return a new array of length <i>newLength</i> that is formed by
     *  either truncating or padding the input array.
     *  Elements from the input array are copied to the output array,
     *  starting from array[startIdx] until one of the following conditions
     *  is met :
     *  1) The input array has no more elements to copy.
     *  2) The output array has been completely filled.
     *  <i>startIdx</i> must index a valid entry in <i>array</i> unless
     *  the input array is of zero length or the output array is of zero length.
     *  If case 1) is met, the remainder of the output array is filled with
     *  new complex numbers with value 0.
     *  Copying here means shallow copying, i.e. pointers to Complex objects
     *  are copied instead of allocation of new copies. This works because
     *  Complex objects are immutable.
     *
     *  @param array An array of complex numbers.
     *  @param newLength The desired size of the output array.
     *  @param startIdx The starting index for the input array.
     *  @return A new array of length <i>newLength</i> that is formed by
     *  either truncating or padding <i>array</i>.
     */
    public static final Complex[] resize(final Complex[] array,
            final int newLength, final int startIdx) {
        Complex[] returnValue = new Complex[newLength];
        int copySize = Math.min(newLength, array.length - startIdx);

        if (startIdx >= array.length && copySize > 0) {
            throw new IllegalArgumentException("resize():  the start index '"
                    + startIdx
                    + "' is greater than equal to the array length '"
                    + array.length + "' and the number of items to be copied '"
                    + copySize + "' is greater than zero.");
        }

        if (copySize > 0) {
            System.arraycopy(array, startIdx, returnValue, 0, copySize);
        }

        for (int i = copySize; i < newLength; i++) {
            returnValue[i] = Complex.ZERO;
        }

        return returnValue;
    }

    /** Return a new array that is constructed from the argument by
     *  scaling each element in <i>array</i> by <i>factor</i>, which is a
     *  complex number. If the array argument is of length 0, return a new
     *  array of length 0.
     *
     *  @param array An array of complex numbers.
     *  @param factor A complex number used to multiply each element
     *  of <i>array</i> by.
     *  @return A new array of complex numbers that is constructed from
     *  the argument by scaling each element in <i>array</i> by <i>factor</i>.
     */
    public static final Complex[] scale(final Complex[] array,
            final Complex factor) {
        int len = array.length;
        Complex[] returnValue = new Complex[len];

        for (int i = 0; i < len; i++) {
            returnValue[i] = array[i].multiply(factor);
        }

        return returnValue;
    }

    /** Return a new array that is constructed from the argument by
     *  scaling each element in the array by factor, which is a
     *  double. If the array argument is of length 0, return a new
     *  array of length 0.
     *
     *  @param array An array of complex numbers.
     *  @param factor A double used to multiply each element
     *  of <i>array</i> by.
     *  @return A new array of complex numbers that is constructed from
     *  the argument by scaling each element in <i>array</i> by <i>factor</i>.
     */
    public static final Complex[] scale(final Complex[] array,
            final double factor) {
        int len = array.length;
        Complex[] returnValue = new Complex[len];

        for (int i = 0; i < len; i++) {
            returnValue[i] = array[i].scale(factor);
        }

        return returnValue;
    }

    /** Return a new array that is constructed by subtracting the complex
     *  number z from every element in the given array. If the array argument
     *  is of length 0, return a new array of length 0.
     *
     *  @param array An array of complex numbers.
     *  @param z A complex number subtracted from each element of <i>array</i>.
     *  @return A new array that is constructed by subtracting <i>z</i>
     *  from every element in <i>array</i>.
     */
    public static final Complex[] subtract(final Complex[] array,
            final Complex z) {
        Complex[] result = new Complex[array.length];

        for (int i = array.length - 1; i >= 0; i--) {
            result[i] = array[i].subtract(z);
        }

        return result;
    }

    /** Return a new array that is the element-by-element
     *  subtraction of the second array from the first array.
     *  If the size of each array is 0, return a new array of size 0.
     *
     *  @param array1 An array of complex numbers from which to subtract.
     *  @param array2 An array of complex numbers to subtract.
     *  @return A new array of complex numbers equal to the element-by-element
     *  subtraction of the second array from the first array.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final Complex[] subtract(Complex[] array1,
            final Complex[] array2) {
        int length = _commonLength(array1, array2, "ComplexArrayMath.subtract");
        Complex[] result = new Complex[length];

        for (int i = 0; i < length; i++) {
            result[i] = array1[i].subtract(array2[i]);
        }

        return result;
    }

    /** Return a new String representing the array, formatted as
     *  in Java array initializers.
     *
     *  @param array An array of complex numbers.
     *  @return A new string representing the array.
     */
    public static final String toString(Complex[] array) {
        return toString(array, ", ", "{", "}");
    }

    /** Return a new String representing the array, formatted
     *  specified starting with vectorBegin, where each
     *  successive element is separated by elementDelimiter
     *  and ending with vectorEnd.
     *
     *  @param array An array of complex numbers.
     *  @param elementDelimiter The delimiter between elements,
     *  typically ", ".
     *  @param vectorBegin The start of the array, typically "{".
     *  @param vectorEnd The end of the array, typically "}".
     *  @return A new string representing the array in the format specified
     *  by the ArrayStringFormat argument.
     */
    public static final String toString(final Complex[] array,
            String elementDelimiter, String vectorBegin, String vectorEnd) {
        int length = array.length;
        StringBuffer sb = new StringBuffer();

        sb.append(vectorBegin);

        for (int i = 0; i < length; i++) {
            sb.append(array[i].toString());

            if (i < length - 1) {
                sb.append(elementDelimiter);
            }
        }

        sb.append(vectorEnd);

        return sb.toString();
    }

    /** Return true if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  the magnitude of <i>maxError</i>. If both arrays are empty,
     *  return true.
     *
     *  @param array1 The first array.
     *  @param array2 The second array.
     *  @param maxError A complex number whose magnitude is taken to
     *   be the distance threshold.
     *  @return True if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  the magnitude of <i>maxError</i>.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final boolean within(Complex[] array1, Complex[] array2,
            Complex maxError) {
        return within(array1, array2, maxError.magnitude());
    }

    /** Return true if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  <i>maxError</i>. If both arrays are empty, return true.
     *  If <i>maxError</i> is negative, return false.
     *
     *  @param array1 The first array.
     *  @param array2 The second array.
     *  @param maxError The threshold for the magnitude of the difference.
     *  @return True if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  <i>maxError</i>.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final boolean within(Complex[] array1, Complex[] array2,
            double maxError) {
        int length = _commonLength(array1, array2, "ComplexArrayMath.within");

        for (int i = 0; i < length; i++) {
            if (!array1[i].isCloseTo(array2[i], maxError)) {
                return false;
            }
        }

        return true;
    }

    /** Return true if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  the corresponding elements in <i>maxError</i>. If both arrays
     *  are empty, return true. If any element in <i>maxError</i> is negative,
     *  return false.
     *
     *  @param array1 The first array.
     *  @param array2 The second array.
     *  @param maxError The array of thresholds for the magnitudes of
     *   the difference.
     *  @return True if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  the corresponding elements in <i>maxError</i>.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final boolean within(Complex[] array1, Complex[] array2,
            double[] maxError) {
        int length = _commonLength(array1, array2, "ComplexArrayMath.within");

        for (int i = 0; i < length; i++) {
            if (!array1[i].isCloseTo(array2[i], maxError[i])) {
                return false;
            }
        }

        return true;
    }

    /** Return true if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  the magnitudes of the corresponding elements in <i>maxError</i>.
     *  If both arrays are empty, return true.
     *
     *  <p>Note that there is no notion of negative distance with
     *  complex numbers, so unlike the within() methods for other
     *  types, this method will not return false if an element of the
     *  maxError matrix is negative.
     *
     *  @param array1 The first array.
     *  @param array2 The second array.
     *  @param maxError An array of complex numbers whose magnitude
     *  for each element is taken to be the distance threshold.
     *  @return True if all the distances between corresponding elements
     *  <i>array1</i> and <i>array2</i> are all less than or equal to
     *  the magnitudes of the corresponding elements in <i>maxError</i>.
     *  @exception IllegalArgumentException If the arrays are not of the same
     *   length.
     */
    public static final boolean within(Complex[] array1, Complex[] array2,
            Complex[] maxError) {
        int length = maxError.length;
        double[] doubleError = new double[length];

        for (int i = 0; i < length; i++) {
            doubleError[i] = maxError[i].magnitude();
        }

        return within(array1, array2, doubleError);
    }

    ///////////////////////////////////////////////////////////////////
    //    protected methods

    /** Throw an exception if the two arrays are not of the same length,
     *  or if either array is null. An exception is NOT thrown if both
     *  arrays are of length 0. If no exception is thrown, return the common
     *  length of the arrays.
     *  @param array1 The first array of doubles.
     *  @param array2 The second array of doubles.
     *  @param methodName A String representing the method name of the caller,
     *  without parentheses.
     *  @return The common length of both arrays.
     */
    protected static final int _commonLength(final Complex[] array1,
            final Complex[] array2, final String methodName) {
        if (array1 == null) {
            throw new IllegalArgumentException("ptolemy.math." + methodName
                    + "() : first input array is null.");
        }

        if (array2 == null) {
            throw new IllegalArgumentException("ptolemy.math." + methodName
                    + "() : second input array is null.");
        }

        if (array1.length != array2.length) {
            throw new IllegalArgumentException("ptolemy.math." + methodName
                    + "() : input arrays must have the same length, "
                    + "but the first array has length " + array1.length
                    + " and the second array has length " + array2.length + '.');
        }

        return array1.length;
    }
}