org.shared.array

Class AbstractArray<T extends AbstractArray<T,U,D,E>,U extends AbstractArray<? extends U,?,?,?>,D extends AbstractArray<? extends D,?,?,?>,E>

java.lang.Object

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

org.shared.array.AbstractArray<T,U,D,E>

Type Parameters:

T - the base parameterization.

U - the "up" parameterization representing the forward FFT type.

D - the "down" parameterization representing the backward FFT type.

E - the array element type.

All Implemented Interfaces:

Cloneable, Array<T,E>

Direct Known Subclasses:

AbstractComplexArray, AbstractRealArray

public abstract class AbstractArray<T extends AbstractArray<T,U,D,E>,U extends AbstractArray<? extends U,?,?,?>,D extends AbstractArray<? extends D,?,?,?>,E>
extends ProtoArray<T,double[],E>

An abstract base class for multidimensional arrays of real and complex values.

Nested Class Summary

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

Array.IndexingOrder

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	INVALID_PARITY A value for parity indicating that this array was not the result of rfft().
protected int	parity An extra bit of information to help rifft() correctly size destination arrays.

Fields inherited from class org.shared.array.ProtoArray

dims, order, strides, values

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractArray(double[] values, int parity, Array.IndexingOrder order, int[] dims, int[] strides) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkInvalidParity() Checks that this array's parity is INVALID_PARITY.
protected void	checkMatrixOrder() Checks that this array has storage order ArrayBase.DEFAULT_ORDER.
protected int	checkShape(T b) Checks that two AbstractArrays have the same size and underlying Array.IndexingOrder.
protected T	fft() Computes the full FFT of this array.
double	get(int... s) Gets the value at the given logical index.
protected T	ifft() Computes the full IFFT of this array.
protected U	rfft() Computes the reduced FFT of this array.
protected int[]	rfftDimensions() Gets the reduced FFT dimensions.
protected D	rifft() Computes the reduced IFFT of this array.
protected int[]	rifftDimensions() Gets the reduced IFFT dimensions.
void	set(double value, int... s) Sets the value at the given logical index.
String	toString() Creates a human-readable representation of this array.
protected T	transform(int direction) Transforms this array in the forward/backward FFT direction.
protected T	wrap(Array.IndexingOrder order, int[] dims, int[] strides) Allocates a new array.
protected abstract T	wrap(int parity, Array.IndexingOrder order, int[] dims, int[] strides) Creates an instance of the base type.
protected abstract D	wrapDown(int parity, Array.IndexingOrder order, int[] dims, int[] strides) Creates an instance of the "down" type after a backward FFT.
protected abstract U	wrapUp(int parity, Array.IndexingOrder order, int[] dims, int[] strides) Creates an instance of the "up" type after a forward FFT.

Methods inherited from class org.shared.array.ProtoArray

clone, concat, dims, getBytes, map, nDims, order, physical, reshape, reverse, reverseOrder, shift, size, slice, slice, slice, slice, splice, stride, strides, subarray, tile, transpose, values, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.shared.array.Array

getComponentType

Field Detail

parity

protected final int parity

An extra bit of information to help rifft() correctly size destination arrays.

INVALID_PARITY

protected static final int INVALID_PARITY

A value for parity indicating that this array was not the result of rfft().

See Also:

Constant Field Values

Constructor Detail

AbstractArray

protected AbstractArray(double[] values,
             int parity,
             Array.IndexingOrder order,
             int[] dims,
             int[] strides)

Default constructor.

Method Detail

wrap

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

Creates an instance of the base type.

wrapUp

protected abstract U wrapUp(int parity,
       Array.IndexingOrder order,
       int[] dims,
       int[] strides)

Creates an instance of the "up" type after a forward FFT.

wrapDown

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

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

get

public double get(int... s)

Gets the value at the given logical index.

set

public void set(double value,
       int... s)

Sets the value at the given logical index.

wrap

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

Description copied from class: ProtoArray

Allocates a new array.

Specified by:

wrap in class ProtoArray<T extends AbstractArray<T,U,D,E>,double[],E>

Parameters:

order - the storage order.

dims - the dimensions.

strides - the strides.

Returns:

the new array.

toString

public String toString()

Description copied from interface: Array

Creates a human-readable representation of this array.

Specified by:

toString in interface Array<T extends AbstractArray<T,U,D,E>,E>

Overrides:

toString in class Object

rfft

protected U rfft()

Computes the reduced FFT of this array.

rifft

protected D rifft()

Computes the reduced IFFT of this array.

fft

protected T fft()

Computes the full FFT of this array.

ifft

protected T ifft()

Computes the full IFFT of this array.

rfftDimensions

protected int[] rfftDimensions()

Gets the reduced FFT dimensions.

rifftDimensions

protected int[] rifftDimensions()

Gets the reduced IFFT dimensions.

checkMatrixOrder

protected void checkMatrixOrder()

Checks that this array has storage order ArrayBase.DEFAULT_ORDER.

checkInvalidParity

protected void checkInvalidParity()

Checks that this array's parity is INVALID_PARITY.

checkShape

protected int checkShape(T b)

Checks that two AbstractArrays have the same size and underlying Array.IndexingOrder.

Parameters:

b - the AbstractArray to compare to.

Returns:

the common parity value.

transform

protected T transform(int direction)

Transforms this array in the forward/backward FFT direction.

Parameters:

direction - the FFT direction.

Returns:

the transformed array.