IntegerArray

java.lang.Object
- org.shared.array.ProtoArray<IntegerArray,int[],Integer>
- - org.shared.array.IntegerArray

All Implemented Interfaces:

Cloneable, Array<IntegerArray,Integer>
```
public class IntegerArray
extends ProtoArray<IntegerArray,int[],Integer>
```
A multidimensional integer array class.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.shared.array.Array
  Array.IndexingOrder

Field Summary
- Fields inherited from class org.shared.array.ProtoArray
  dims, order, strides, values

Constructor Summary

Constructors
Modifier	Constructor and Description
	`IntegerArray(Array.IndexingOrder order, int... dims)` Default constructor.
`protected`	`IntegerArray(Array.IndexingOrder order, int[] dims, int[] strides)` Internal constructor for package use only.
	`IntegerArray(int[] values, Array.IndexingOrder order, int... dims)` Alternate constructor.
	`IntegerArray(int[] values, int... dims)` Alternate constructor.
`protected`	`IntegerArray(int unused, Array.IndexingOrder order, int[] dims)` Internal constructor with a distinctive signature.
	`IntegerArray(IntegerArray array)` Alternate constructor.
`protected`	`IntegerArray(int unused, int[] values, Array.IndexingOrder order, int[] dims)` Internal constructor with a distinctive signature.

Method Summary

Methods
Modifier and Type	Method and Description
`protected IntegerArray`	`applyKernelElementwiseOperation(IntegerArray b, int type)` Supports the e* series of operations.
`protected IntegerArray`	`applyKernelIntegerUnaryOperation(int a, int type)` Supports the u* series of operations.
`protected IntegerArray`	`applyKernelLeftElementwiseOperation(IntegerArray b, int type)` Supports the l* series of operations.
`protected void`	`checkShape(IntegerArray b)` Checks that two `IntegerArray`s have the same size and underlying `Array.IndexingOrder`.
`IntegerArray`	`eAdd(IntegerArray array)` Computes the elementwise addition.
`IntegerArray`	`eMax(IntegerArray array)` Computes the elementwise maximum.
`IntegerArray`	`eMin(IntegerArray array)` Computes the elementwise minimum.
`IntegerArray`	`eMul(IntegerArray array)` Computes the elementwise multiplication.
`IntegerArray`	`eSub(IntegerArray array)` Computes the elementwise subtraction.
`int[]`	`find(int... s)` Assumes that this array results from an indexing operation.
`int`	`get(int... s)` Gets the value at the given logical index.
`byte[]`	`getBytes()` Converts this array into `byte`s.
`Class<Integer>`	`getComponentType()` Gets the component type.
`IntegerArray`	`lAdd(IntegerArray array)` Computes the left elementwise addition.
`IntegerArray`	`lMax(IntegerArray array)` Computes the left elementwise maximum.
`IntegerArray`	`lMin(IntegerArray array)` Computes the left elementwise minimum.
`IntegerArray`	`lMul(IntegerArray array)` Computes the left elementwise multiplication.
`IntegerArray`	`lSub(IntegerArray array)` Computes the left elementwise subtraction.
`static IntegerArray[]`	`ndgrid(int... ranges)` Generates arrays representing integral coordinates along each dimension of a multidimensional function's domain.
`static IntegerArray`	`parse(byte[] data)` Parses an array from `byte`s.
`void`	`set(int value, int... s)` Sets the value at the given logical index.
`int`	`singleton()` Gets the singleton value from this array.
`RealArray`	`tor()` Converts this array to a `RealArray`.
`String`	`toString()` Creates a human-readable representation of this array.
`IntegerArray`	`uAdd(int a)` Mutatively adds the argument to the elements.
`IntegerArray`	`uFill(int a)` Mutatively fills this array with the argument.
`IntegerArray`	`uMul(int a)` Mutatively multiplies the elements by the argument.
`IntegerArray`	`uShuffle()` Mutatively shuffles this array.
`protected IntegerArray`	`wrap(Array.IndexingOrder order, int[] dims, int[] strides)` Allocates a new array.
`protected IntegerArray`	`wrap(Integer value, Array.IndexingOrder order, int[] dims, int[] strides)` Allocates a new array initialized to the given value.

Methods inherited from class org.shared.array.ProtoArray
clone, concat, dims, map, nDims, order, physical, reshape, reverse, reverseOrder, shift, size, slice, slice, slice, slice, splice, stride, strides, subarray, tile, transpose, values

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

- Constructor Detail
  - IntegerArray
```
public IntegerArray(Array.IndexingOrder order,
            int... dims)
```
    Default constructor.
  - IntegerArray
```
protected IntegerArray(int unused,
            Array.IndexingOrder order,
            int[] dims)
```
    Internal constructor with a distinctive signature.
  - IntegerArray
```
public IntegerArray(int[] values,
            int... dims)
```
    Alternate constructor.
  - IntegerArray
```
public IntegerArray(int[] values,
            Array.IndexingOrder order,
            int... dims)
```
    Alternate constructor.
  - IntegerArray
```
public IntegerArray(IntegerArray array)
```
    Alternate constructor.
  - IntegerArray
```
protected IntegerArray(int unused,
            int[] values,
            Array.IndexingOrder order,
            int[] dims)
```
    Internal constructor with a distinctive signature.
  - IntegerArray
```
protected IntegerArray(Array.IndexingOrder order,
            int[] dims,
            int[] strides)
```
    Internal constructor for package use only.
- Method Detail
  - wrap
```
protected IntegerArray wrap(Array.IndexingOrder order,
                int[] dims,
                int[] strides)
```
    Description copied from class: ProtoArray
    
    Allocates a new array.
    
    Specified by:
    
    wrap in class ProtoArray<IntegerArray,int[],Integer>
    
    Parameters:
    order - the storage order.
    dims - the dimensions.
    strides - the strides.
    
    Returns:
    the new array.
  - wrap
```
protected IntegerArray wrap(Integer value,
                Array.IndexingOrder order,
                int[] dims,
                int[] strides)
```
    Description copied from class: ProtoArray
    
    Allocates a new array initialized to the given value.
    
    Specified by:
    
    wrap in class ProtoArray<IntegerArray,int[],Integer>
    
    Parameters:
    value - the initial value.
    order - the storage order.
    dims - the dimensions.
    strides - the strides.
    
    Returns:
    the new array.
  - get
```
public int get(int... s)
```
    Gets the value at the given logical index.
  - set
```
public void set(int value,
       int... s)
```
    Sets the value at the given logical index.
  - getBytes
```
public byte[] getBytes()
```
    Description copied from class: ProtoArray
    
    Converts this array into bytes.
    
    Overrides:
    
    getBytes in class ProtoArray<IntegerArray,int[],Integer>
    
    Returns:
    the bytes.
  - getComponentType
```
public Class<Integer> getComponentType()
```
    Description copied from interface: Array
    
    Gets the component type.
  - toString
```
public String toString()
```
    Description copied from interface: Array
    
    Creates a human-readable representation of this array.
    
    Specified by:
    
    toString in interface Array<IntegerArray,Integer>
    
    Overrides:
    
    toString in class Object
  - find
```
public int[] find(int... s)
```
    Assumes that this array results from an indexing operation. Extracts the valid indices along a dimension anchored at the given logical index.
    
    Parameters:
    s - the logical index, where the dimension of interest is marked with a -1.
    
    Returns:
    the valid indices along said dimension and at said logical index.
  - tor
```
public RealArray tor()
```
    Converts this array to a RealArray.
  - singleton
```
public int singleton()
```
    Gets the singleton value from this array.
  - uAdd
```
public IntegerArray uAdd(int a)
```
    Mutatively adds the argument to the elements.
  - uMul
```
public IntegerArray uMul(int a)
```
    Mutatively multiplies the elements by the argument.
  - uFill
```
public IntegerArray uFill(int a)
```
    Mutatively fills this array with the argument.
  - uShuffle
```
public IntegerArray uShuffle()
```
    Mutatively shuffles this array.
  - eAdd
```
public IntegerArray eAdd(IntegerArray array)
```
    Computes the elementwise addition.
  - eSub
```
public IntegerArray eSub(IntegerArray array)
```
    Computes the elementwise subtraction.
  - eMul
```
public IntegerArray eMul(IntegerArray array)
```
    Computes the elementwise multiplication.
  - eMax
```
public IntegerArray eMax(IntegerArray array)
```
    Computes the elementwise maximum.
  - eMin
```
public IntegerArray eMin(IntegerArray array)
```
    Computes the elementwise minimum.
  - lAdd
```
public IntegerArray lAdd(IntegerArray array)
```
    Computes the left elementwise addition.
  - lSub
```
public IntegerArray lSub(IntegerArray array)
```
    Computes the left elementwise subtraction.
  - lMul
```
public IntegerArray lMul(IntegerArray array)
```
    Computes the left elementwise multiplication.
  - lMax
```
public IntegerArray lMax(IntegerArray array)
```
    Computes the left elementwise maximum.
  - lMin
```
public IntegerArray lMin(IntegerArray array)
```
    Computes the left elementwise minimum.
  - applyKernelElementwiseOperation
```
protected IntegerArray applyKernelElementwiseOperation(IntegerArray b,
                                           int type)
```
    Supports the e* series of operations.
  - applyKernelLeftElementwiseOperation
```
protected IntegerArray applyKernelLeftElementwiseOperation(IntegerArray b,
                                               int type)
```
    Supports the l* series of operations.
  - applyKernelIntegerUnaryOperation
```
protected IntegerArray applyKernelIntegerUnaryOperation(int a,
                                            int type)
```
    Supports the u* series of operations.
  - checkShape
```
protected void checkShape(IntegerArray b)
```
    Checks that two IntegerArrays have the same size and underlying Array.IndexingOrder.
    
    Parameters:
    b - the IntegerArray to compare to.
  - parse
```
public static final IntegerArray parse(byte[] data)
```
    Parses an array from bytes.
  - ndgrid
```
public static final IntegerArray[] ndgrid(int... ranges)
```
    Generates arrays representing integral coordinates along each dimension of a multidimensional function's domain. Intended to mimic the behavior of the MATLAB function of the same name.
    
    Parameters:
    ranges - the range specifications as an array of three-tuples. Given the ith tuple, the first component denotes the start value, the second component denotes the end value, and the third component denotes the step size.
    
    Returns:
    an array of n IntegerArrays, where n is the number of dimensions.

Class IntegerArray

Nested Class Summary

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

Field Summary

Fields inherited from class org.shared.array.ProtoArray

Constructor Summary

Method Summary

Methods inherited from class org.shared.array.ProtoArray

Methods inherited from class java.lang.Object

Constructor Detail

IntegerArray

IntegerArray

IntegerArray

IntegerArray

IntegerArray

IntegerArray

IntegerArray

Method Detail

wrap

wrap

get

set

getBytes

getComponentType

toString

find

tor

singleton

uAdd

uMul

uFill

uShuffle

eAdd

eSub

eMul

eMax

eMin

lAdd

lSub

lMul

lMax

lMin

applyKernelElementwiseOperation

applyKernelLeftElementwiseOperation

applyKernelIntegerUnaryOperation

checkShape

parse

ndgrid