org.shared.array

Class ComplexArray

java.lang.Object

org.shared.array.ProtoArray<T,double[],E>

org.shared.array.AbstractArray<C,C,R,AbstractComplexArray.Complex>

org.shared.array.AbstractComplexArray<ComplexArray,RealArray>

org.shared.array.ComplexArray

All Implemented Interfaces:

Cloneable, Array<ComplexArray,AbstractComplexArray.Complex>, Matrix<ComplexArray,AbstractComplexArray.Complex>

Direct Known Subclasses:

Gabor, GaborCircular

public class ComplexArray
extends AbstractComplexArray<ComplexArray,RealArray>
implements Matrix<ComplexArray,AbstractComplexArray.Complex>

A multidimensional complex array class.

Nested Class Summary

Nested classes/interfaces inherited from class org.shared.array.AbstractComplexArray

AbstractComplexArray.Complex

Nested classes/interfaces inherited from interface org.shared.array.Array

Array.IndexingOrder

Field Summary

Fields inherited from class org.shared.array.AbstractArray

INVALID_PARITY, parity

Fields inherited from class org.shared.array.ProtoArray

dims, order, strides, values

Constructor Summary

Constructors

Modifier	Constructor and Description
	ComplexArray(ComplexArray array) Alternate constructor.
	ComplexArray(double[] values, int... dims) Alternate constructor.
	ComplexArray(int... dims) Default constructor.
protected	ComplexArray(int unused, double[] values, int[] dims) Internal constructor with a distinctive signature.
protected	ComplexArray(int unused, int[] dims) Internal constructor with a distinctive signature.
protected	ComplexArray(int parity, int[] dims, int[] strides) Internal constructor for package use only.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBytes() Converts this array into bytes.
ComplexArray	mDiag() Gets the diagonal of this matrix as a column vector.
ComplexArray[]	mEigs() Gets the eigenvectors and eigenvalues of this matrix.
ComplexArray	mInvert() Inverts this matrix.
ComplexArray	mMul(ComplexArray b) Multiplies two matrices.
ComplexArray[]	mSvd() Gets the singular value decomposition of this matrix.
ComplexArray	mTranspose() Transposes this matrix.
static ComplexArray	parse(byte[] data) Parses an array from bytes.
double[]	singleton() Gets the singleton value from this array.
protected ComplexArray	wrap(int parity, Array.IndexingOrder order, int[] dims, int[] strides) Creates an instance of the base type.
protected RealArray	wrapDown(int parity, Array.IndexingOrder order, int[] dims, int[] strides) Creates an instance of the "down" type after a backward FFT.

Methods inherited from class org.shared.array.AbstractComplexArray

aMean, applyKernelComplexAccumulatorOperation, applyKernelComplexToRealOperation, applyKernelComplexUnaryOperation, applyKernelElementwiseOperation, applyKernelLeftElementwiseOperation, aProd, aSum, eAdd, eDiv, eMul, eSub, fft, fftShift, fftShift, getComponentType, ifft, ifftShift, lAdd, lDiv, lMul, lSub, reshape, reverseOrder, rifft, rifftDimensions, subarray, tile, torAbs, torIm, torRe, toString, transpose, uAdd, uConj, uCos, uExp, uFill, uMul, uRnd, uShuffle, uSin, wrap, wrapUp

Methods inherited from class org.shared.array.AbstractArray

checkInvalidParity, checkMatrixOrder, checkShape, get, rfft, rfftDimensions, set, transform, wrap

Methods inherited from class org.shared.array.ProtoArray

clone, concat, dims, map, nDims, order, physical, reverse, shift, size, slice, slice, slice, slice, splice, stride, strides, values

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.shared.array.Array

clone, concat, dims, getComponentType, map, nDims, order, reshape, reverse, reverseOrder, shift, size, slice, slice, slice, slice, splice, stride, strides, subarray, tile, toString, transpose

Constructor Detail

ComplexArray

public ComplexArray(int... dims)

Default constructor.

ComplexArray

protected ComplexArray(int unused,
            int[] dims)

Internal constructor with a distinctive signature.

ComplexArray

public ComplexArray(double[] values,
            int... dims)

Alternate constructor.

ComplexArray

public ComplexArray(ComplexArray array)

Alternate constructor.

ComplexArray

protected ComplexArray(int unused,
            double[] values,
            int[] dims)

Internal constructor with a distinctive signature.

ComplexArray

protected ComplexArray(int parity,
            int[] dims,
            int[] strides)

Internal constructor for package use only.

Method Detail

wrap

protected ComplexArray wrap(int parity,
                Array.IndexingOrder order,
                int[] dims,
                int[] strides)

Description copied from class: AbstractArray

Creates an instance of the base type.

Specified by:

wrap in class AbstractArray<ComplexArray,ComplexArray,RealArray,AbstractComplexArray.Complex>

wrapDown

protected RealArray wrapDown(int parity,
                 Array.IndexingOrder order,
                 int[] dims,
                 int[] strides)

Description copied from class: AbstractArray

Creates an instance of the "down" type after a backward FFT.

Specified by:

wrapDown in class AbstractArray<ComplexArray,ComplexArray,RealArray,AbstractComplexArray.Complex>

mMul

public ComplexArray mMul(ComplexArray b)

Description copied from interface: Matrix

Multiplies two matrices.

Specified by:

mMul in interface Matrix<ComplexArray,AbstractComplexArray.Complex>

Parameters:

b - the right hand side.

Returns:

the multiplication result.

mDiag

public ComplexArray mDiag()

Description copied from interface: Matrix

Gets the diagonal of this matrix as a column vector.

Specified by:

mDiag in interface Matrix<ComplexArray,AbstractComplexArray.Complex>

Returns:

the diagonal.

mTranspose

public ComplexArray mTranspose()

Description copied from interface: Matrix

Transposes this matrix.

Specified by:

mTranspose in interface Matrix<ComplexArray,AbstractComplexArray.Complex>

Returns:

the transposed matrix.

getBytes

public byte[] getBytes()

Description copied from class: ProtoArray

Converts this array into bytes.

Overrides:

getBytes in class ProtoArray<ComplexArray,double[],AbstractComplexArray.Complex>

Returns:

the bytes.

singleton

public double[] singleton()

Gets the singleton value from this array.

parse

public static final ComplexArray parse(byte[] data)

Parses an array from bytes.

mSvd

public ComplexArray[] mSvd()

Description copied from interface: Matrix

Gets the singular value decomposition of this matrix.

Specified by:

mSvd in interface Matrix<ComplexArray,AbstractComplexArray.Complex>

Returns:

the matrices U, S, and V.

mEigs

public ComplexArray[] mEigs()

Description copied from interface: Matrix

Gets the eigenvectors and eigenvalues of this matrix.

Specified by:

mEigs in interface Matrix<ComplexArray,AbstractComplexArray.Complex>

Returns:

the eigenvectors and eigenvalues.

mInvert

public ComplexArray mInvert()

Description copied from interface: Matrix

Inverts this matrix.

Specified by:

mInvert in interface Matrix<ComplexArray,AbstractComplexArray.Complex>

Returns:

the inverted matrix.