ProtoArray

java.lang.Object
- org.shared.array.ProtoArray<T,V,E>

Type Parameters:
T - the parameterization lower bounded by ProtoArray itself.
V - the storage array type.
E - the element type.

All Implemented Interfaces:

Cloneable, Array<T,E>

Direct Known Subclasses:

AbstractArray, IntegerArray, ObjectArray
```
public abstract class ProtoArray<T extends ProtoArray<T,V,E>,V,E>
extends Object
implements Array<T,E>
```
An abstract, primordial base class for all multidimensional arrays. Supports operations like mapping, slicing, tiling, shifting, transposition of dimensions, and storage order reversals.

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 int[]`	`dims` The dimensions.
`protected Array.IndexingOrder`	`order` The storage order.
`protected int[]`	`strides` The strides.
`protected V`	`values` The backing values.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ProtoArray(V values, Array.IndexingOrder order, int[] dims, int[] strides)
Default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`ProtoArray(V values, Array.IndexingOrder order, int[] dims, int[] strides)` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`T`	`clone()` Copies this array.
`T`	`concat(int opDim, T... srcs)` Concatenates this array with the given arrays along the given dimension.
`int[]`	`dims()` Gets the dimensions.
`byte[]`	`getBytes()` Converts this array into `byte`s.
`T`	`map(T dst, int... bounds)` Maps this array into a destination array.
`int`	`nDims()` Gets the number of dimensions.
`Array.IndexingOrder`	`order()` Gets the storage order of this array.
`protected int`	`physical(int[] logical)` Converts a logical index into a physical index.
`T`	`reshape(int... dims)` Reshapes this array.
`T`	`reverse(int... opDims)` Reverses along the given dimensions.
`T`	`reverseOrder()` Creates an array where the storage order is reversed.
`T`	`shift(int... shifts)` Circularly shifts this array.
`int`	`size(int i)` Gets the size along the given dimension.
`T`	`slice(E value, int[]... srcSlices)` Slices a value into this array.
`T`	`slice(int[]... srcSlices)` Gets a subarray specified by the given slicing indices.
`T`	`slice(int[][] srcSlices, T dst, int[][] dstSlices)` Slices this array into a destination array.
`T`	`slice(T dst, int[]... dstSlices)` Slices this entire array into a destination array.
`T`	`splice(T dst, int... slices)` A primitive slicing operation.
`int`	`stride(int i)` Gets the stride along the given dimension.
`int[]`	`strides()` Gets the strides.
`T`	`subarray(int... bounds)` Gets a subarray delimited by the given bounds.
`T`	`tile(int... repetitions)` Tiles this array according to the given number repetitions along each dimension.
`T`	`transpose(int... permutation)` Transposes (permutes) the dimensions of this array.
`V`	`values()` Gets the backing values.
`protected abstract T`	`wrap(Array.IndexingOrder order, int[] dims, int[] strides)` Allocates a new array.
`protected abstract T`	`wrap(E value, Array.IndexingOrder order, int[] dims, int[] strides)` Allocates a new array initialized to the given value.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.shared.array.Array
getComponentType, toString

- Field Detail
  - values
```
protected final V values
```
    The backing values.
  - order
```
protected final Array.IndexingOrder order
```
    The storage order.
  - dims
```
protected final int[] dims
```
    The dimensions.
  - strides
```
protected final int[] strides
```
    The strides.
- Constructor Detail
  - ProtoArray
```
protected ProtoArray(V values,
          Array.IndexingOrder order,
          int[] dims,
          int[] strides)
```
    Default constructor.
- Method Detail
  - wrap
```
protected abstract T wrap(Array.IndexingOrder order,
     int[] dims,
     int[] strides)
```
    Allocates a new array.
    
    Parameters:
    order - the storage order.
    dims - the dimensions.
    strides - the strides.
    
    Returns:
    the new array.
  - wrap
```
protected abstract T wrap(E value,
     Array.IndexingOrder order,
     int[] dims,
     int[] strides)
```
    Allocates a new array initialized to the given value.
    
    Parameters:
    value - the initial value.
    order - the storage order.
    dims - the dimensions.
    strides - the strides.
    
    Returns:
    the new array.
  - getBytes
```
public byte[] getBytes()
```
    Converts this array into bytes.
    
    Returns:
    the bytes.
  - values
```
public V values()
```
    Gets the backing values.
  - physical
```
protected int physical(int[] logical)
```
    Converts a logical index into a physical index.
  - map
```
public T map(T dst,
    int... bounds)
```
    Description copied from interface: Array
    
    Maps this array into a destination array.
    
    Specified by:
    
    map in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    dst - the destination array.
    bounds - the mapping bounds as an array of three-tuples. Given the ith tuple, the first component denotes the source start, the second component denotes the destination start, and the third component denotes the mapping size. Is very much the multidimensional analogy to System.arraycopy(Object, int, Object, int, int).
    
    Returns:
    the destination array.
  - splice
```
public T splice(T dst,
       int... slices)
```
    Description copied from interface: Array
    
    A primitive slicing operation.
    
    Specified by:
    
    splice in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    dst - the destination array.
    slices - the slicing specifications as an array of three-tuples. Given the ith tuple, the first component denotes the source index, the second component denotes the destination index, and the third component denotes the dimension of interest. The sliced portion is the Cartesian product subarray delineated by these specifications.
    
    Returns:
    the destination array.
  - slice
```
public T slice(int[][] srcSlices,
      T dst,
      int[][] dstSlices)
```
    Description copied from interface: Array
    
    Slices this array into a destination array.
    
    Specified by:
    
    slice in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    srcSlices - the source slicing indices along each dimension.
    dst - the destination array.
    dstSlices - the destination slicing indices along each dimension.
    
    Returns:
    the destination array.
  - slice
```
public T slice(T dst,
      int[]... dstSlices)
```
    Description copied from interface: Array
    
    Slices this entire array into a destination array.
    
    Specified by:
    
    slice in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    dst - the destination array.
    dstSlices - the destination slicing indices along each dimension.
    
    Returns:
    the destination array.
  - slice
```
public T slice(E value,
      int[]... srcSlices)
```
    Description copied from interface: Array
    
    Slices a value into this array.
    
    Specified by:
    
    slice in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    value - the value.
    srcSlices - the source slicing indices along each dimension.
    
    Returns:
    this array.
  - slice
```
public T slice(int[]... srcSlices)
```
    Description copied from interface: Array
    
    Gets a subarray specified by the given slicing indices.
    
    Specified by:
    
    slice in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    srcSlices - the slicing indices.
    
    Returns:
    the subarray.
  - tile
```
public T tile(int... repetitions)
```
    Description copied from interface: Array
    
    Tiles this array according to the given number repetitions along each dimension.
    
    Specified by:
    
    tile in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    repetitions - the number times to repeat along each dimension.
    
    Returns:
    the tiled result.
  - transpose
```
public T transpose(int... permutation)
```
    Description copied from interface: Array
    
    Transposes (permutes) the dimensions of this array.
    
    Specified by:
    
    transpose in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    permutation - the dimension permutation.
    
    Returns:
    the transposed result.
  - shift
```
public T shift(int... shifts)
```
    Description copied from interface: Array
    
    Circularly shifts this array.
    
    Specified by:
    
    shift in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    shifts - the shift amounts.
    
    Returns:
    the shifted array.
  - subarray
```
public T subarray(int... bounds)
```
    Description copied from interface: Array
    
    Gets a subarray delimited by the given bounds.
    
    Specified by:
    
    subarray in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    bounds - the subarray bounds as an array of two-tuples. Given the ith tuple, the first component is the (inclusive) lower range and the second component is the (exclusive) upper range.
    
    Returns:
    the subarray.
  - reverse
```
public T reverse(int... opDims)
```
    Description copied from interface: Array
    
    Reverses along the given dimensions.
    
    Specified by:
    
    reverse in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    opDims - the dimensions to reverse along.
    
    Returns:
    the reversed array.
  - reshape
```
public T reshape(int... dims)
```
    Description copied from interface: Array
    
    Reshapes this array.
    
    Specified by:
    
    reshape in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    dims - the reshaped dimensions.
    
    Returns:
    the reshaped array.
  - concat
```
public T concat(int opDim,
       T... srcs)
```
    Description copied from interface: Array
    
    Concatenates this array with the given arrays along the given dimension.
    
    Specified by:
    
    concat in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Parameters:
    opDim - the dimension to concatenate along.
    srcs - the arrays to concatenate with.
    
    Returns:
    the concatenation result.
  - reverseOrder
```
public T reverseOrder()
```
    Description copied from interface: Array
    
    Creates an array where the storage order is reversed.
    
    Specified by:
    
    reverseOrder in interface Array<T extends ProtoArray<T,V,E>,E>
  - clone
```
public T clone()
```
    Description copied from interface: Array
    
    Copies this array.
    
    Specified by:
    
    clone in interface Array<T extends ProtoArray<T,V,E>,E>
    
    Overrides:
    
    clone in class Object
  - order
```
public Array.IndexingOrder order()
```
    Description copied from interface: Array
    
    Gets the storage order of this array.
    
    Specified by:
    
    order in interface Array<T extends ProtoArray<T,V,E>,E>
  - size
```
public int size(int i)
```
    Description copied from interface: Array
    
    Gets the size along the given dimension.
    
    Specified by:
    
    size in interface Array<T extends ProtoArray<T,V,E>,E>
  - stride
```
public int stride(int i)
```
    Description copied from interface: Array
    
    Gets the stride along the given dimension.
    
    Specified by:
    
    stride in interface Array<T extends ProtoArray<T,V,E>,E>
  - nDims
```
public int nDims()
```
    Description copied from interface: Array
    
    Gets the number of dimensions.
    
    Specified by:
    
    nDims in interface Array<T extends ProtoArray<T,V,E>,E>
  - dims
```
public int[] dims()
```
    Description copied from interface: Array
    
    Gets the dimensions.
    
    Specified by:
    
    dims in interface Array<T extends ProtoArray<T,V,E>,E>
  - strides
```
public int[] strides()
```
    Description copied from interface: Array
    
    Gets the strides.
    
    Specified by:
    
    strides in interface Array<T extends ProtoArray<T,V,E>,E>

Class ProtoArray<T extends ProtoArray<T,V,E>,V,E>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.shared.array.Array

Field Detail

values

order

dims

strides

Constructor Detail

ProtoArray

Method Detail

wrap

wrap

getBytes

values

physical

map

splice

slice

slice

slice

slice

tile

transpose

shift

subarray

reverse

reshape

concat

reverseOrder

clone

order

size

stride

nDims

dims

strides