org.shared.array

Class ArrayBase

java.lang.Object

org.shared.array.ArrayBase

public class ArrayBase
extends Object

A static utility class for common Array operations.

Field Summary

Fields

Modifier and Type	Field and Description
static Array.IndexingOrder	DEFAULT_ORDER The default storage order shall be Array.IndexingOrder.FAR.
static ModalFftService	fftService A global service providing access to FFT operations.
static int	fieldPrecision The field precision to use when printing.
static int	fieldWidth The field width to use when printing.
static ModalArrayIoKernel	ioKernel The array I/O kernel.
static ModalArrayKernel	opKernel The array operations kernel.

Method Summary

Methods

Modifier and Type	Method and Description
static int[]	canonicalizeSlices(int[][] srcSlices, int[] srcDims, int[][] dstSlices, int[] dstDims) Canonicalizes the alternate slicing specification.
static int[]	canonicalizeSlices(int[] srcDims, int[] dstDims, int[][] dstSlices) Canonicalizes the alternate slicing specification.
static int[]	canonicalizeSlices(int nSlices, int[] srcDims, int[][] srcSlices) Canonicalizes the alternate slicing specification.
static int[]	createReverseSlices(int[] srcDims, int[] opDims) Creates a slicing specification for Array.reverse(int...).
static void	format(int width, int precision) Sets the formatting parameters fieldWidth and fieldPrecision.
static void	formatEmptyArray(Formatter f, int[] dims) Formats an empty array message.
static double[]	formatRescale(Formatter f, int exponent, double[] values) Formats a potential rescale message if the given exponent is too large or too small.
static void	formatSlice(Formatter f, String format, Object values, int[] indices, int offset, int nRows, int nCols, boolean complex) Formats a two-dimensional slice of an array for display.
static void	formatSparseArray(Formatter f, String valueFormat, String indexFormat, Object values, int[] indices, int[] strides) Formats a sparse array for display.
static int[]	inferDimensions(int[] dims, int len, boolean complex) Infers dimensions from the backing array length if the number of declared dimensions is 0.
static int[]	logical(int physical, int[] strides, int[] logical) Computes the logical index from the given physical index and strides.

Methods inherited from class java.lang.Object

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

Field Detail

opKernel

public static final ModalArrayKernel opKernel

The array operations kernel.

ioKernel

public static final ModalArrayIoKernel ioKernel

The array I/O kernel.

fftService

public static final ModalFftService fftService

A global service providing access to FFT operations.

DEFAULT_ORDER

public static final Array.IndexingOrder DEFAULT_ORDER

The default storage order shall be Array.IndexingOrder.FAR.

fieldWidth

public static int fieldWidth

The field width to use when printing.

fieldPrecision

public static int fieldPrecision

The field precision to use when printing.

Method Detail

canonicalizeSlices

public static final int[] canonicalizeSlices(int[][] srcSlices,
                       int[] srcDims,
                       int[][] dstSlices,
                       int[] dstDims)

Canonicalizes the alternate slicing specification.

canonicalizeSlices

public static final int[] canonicalizeSlices(int[] srcDims,
                       int[] dstDims,
                       int[][] dstSlices)

Canonicalizes the alternate slicing specification.

canonicalizeSlices

public static final int[] canonicalizeSlices(int nSlices,
                       int[] srcDims,
                       int[][] srcSlices)

Canonicalizes the alternate slicing specification.

createReverseSlices

public static final int[] createReverseSlices(int[] srcDims,
                        int[] opDims)

Creates a slicing specification for Array.reverse(int...).

format

public static final void format(int width,
          int precision)

Sets the formatting parameters fieldWidth and fieldPrecision.

Parameters:

width - the number width.

precision - the number precision.

formatSlice

public static final void formatSlice(Formatter f,
               String format,
               Object values,
               int[] indices,
               int offset,
               int nRows,
               int nCols,
               boolean complex)

Formats a two-dimensional slice of an array for display.

Parameters:

f - the target Formatter.

format - the formatting string.

values - the values.

indices - the physical indices.

offset - the physical index offset.

nRows - the number of rows in the slice.

nCols - the number of columns in the slice.

complex - whether the values are complex.

formatEmptyArray

public static final void formatEmptyArray(Formatter f,
                    int[] dims)

Formats an empty array message.

Parameters:

f - the target Formatter.

dims - the dimensions.

formatRescale

public static final double[] formatRescale(Formatter f,
                     int exponent,
                     double[] values)

Formats a potential rescale message if the given exponent is too large or too small.

Parameters:

f - the target Formatter.

exponent - the exponent.

values - the values.

Returns:

the potentially rescaled values.

formatSparseArray

public static final void formatSparseArray(Formatter f,
                     String valueFormat,
                     String indexFormat,
                     Object values,
                     int[] indices,
                     int[] strides)

Formats a sparse array for display.

Parameters:

f - the target Formatter.

valueFormat - the formatting string for values.

indexFormat - the formatting string for logical indices.

values - the values.

indices - the physical indices.

strides - the strides.

logical

public static final int[] logical(int physical,
            int[] strides,
            int[] logical)

Computes the logical index from the given physical index and strides.

Parameters:

physical - the physical index.

strides - the strides.

logical - the logical index.

Returns:

the logical index.

inferDimensions

public static final int[] inferDimensions(int[] dims,
                    int len,
                    boolean complex)

Infers dimensions from the backing array length if the number of declared dimensions is 0.

Parameters:

dims - the declared dimensions.

len - the array length.

complex - whether the array contains complex values.

Returns:

the inferred dimensions.