SliceArray (vectorz 0.23.0 API)

java.lang.Object
- mikera.arrayz.impl.AbstractArray<T>
- - mikera.arrayz.impl.SliceArray<T>

Type Parameters:
T -

All Implemented Interfaces:

Cloneable, Iterable<T>, INDArray
```
public final class SliceArray<T extends INDArray>
extends AbstractArray<T>
```
A general n-dimensional double array implemented as a collection of (n-1) dimensional slices

Author:

Mike

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyOp(IOp op)` Applies a unary operator to all elements of the array (in-place)
`void`	`applyOp(Op op)` Applies a unary operator to all elements of the array (in-place)
`AVector`	`asVector()` Constructs a view of the array as a single vector in row-major order.
`static <T extends INDArray> SliceArray<T>`	`create(List<T> slices)`
`static <T extends INDArray> SliceArray<T>`	`create(T... slices)`
`int`	`dimensionality()` Returns the dimensionality of the array (number of dimensions in the array shape) e.g.
`long`	`elementCount()` Returns the total number of elements in this array.
`boolean`	`equals(INDArray a)` Returns true if the two arrays are exactly equal in value and shape
`SliceArray<T>`	`exactClone()` Returns an exact deep clone of an array (i.e.
`void`	`fill(double value)` Fills the array with asingle double value
`double`	`get(int... indexes)` Returns the double value at the specified index position in an array
`long[]`	`getLongShape()` Returns the shape of the array as an array of longs.
`int[]`	`getShape()` Returns the shape of the array as an array of ints.
`int`	`getShape(int dim)` Returns the dimension size for a specific dimension in the array's shape
`List<T>`	`getSlices()` Returns a list of all major slices of this array.
`INDArray`	`innerProduct(INDArray a)` Calculates the inner product of this array with another array.
`boolean`	`isBoolean()` Returns true if the array is boolean (contains only 0.0 or 1.0 values)
`boolean`	`isElementConstrained()` Returns true if this array has some constraints on element values
`boolean`	`isFullyMutable()` If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
`boolean`	`isMutable()` Returns true if the INDArray is mutable (at least partially)
`boolean`	`isView()` Return true if this array is a view type
`boolean`	`isZero()` Returns true if the array is zero (all elements equal to zero)
`void`	`multiply(double d)` Multiplies all elements of the array by a given double value
`INDArray`	`outerProduct(INDArray a)` Calculates the outer product of this array with another array.
`static <T extends INDArray> SliceArray<T>`	`repeat(T s, int n)`
`INDArray`	`reshape(int... dimensions)` Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape
`void`	`set(double value)` Sets all elements of an array to a specific double value
`void`	`set(int[] indexes, double value)`
`void`	`setElements(double[] values, int offset, int length)` Sets all elements in an array using the given double values
`INDArray`	`slice(int majorSlice)` Returns the specified major slice of this array as a view (slice along dimension 0)
`INDArray`	`slice(int dimension, int index)` Returns a slice view of this array along the specified dimension
`int`	`sliceCount()` returns the number of major slices in this array.
`void`	`validate()` Validates the internal data structure of the INDArray.

Methods inherited from class mikera.arrayz.impl.AbstractArray
abs, add, add, asDoubleArray, asElementList, broadcast, broadcastCloneLike, broadcastLike, clamp, clone, copyTo, divide, divide, elementIterator, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, exp, get, get, get, getElements, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, isSameShape, iterator, log, multiply, negate, nonZeroCount, pow, reciprocal, scale, scaleAdd, set, set, set, set, setElements, signum, sqrt, square, sub, sub, toArray, toDoubleArray, toDoubleBuffer, toString, toVector

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

- Method Detail
  - create
```
public static <T extends INDArray> SliceArray<T> create(T... slices)
```
  - repeat
```
public static <T extends INDArray> SliceArray<T> repeat(T s,
                                        int n)
```
  - create
```
public static <T extends INDArray> SliceArray<T> create(List<T> slices)
```
  - dimensionality
```
public int dimensionality()
```
    Description copied from interface: INDArray
    
    Returns the dimensionality of the array (number of dimensions in the array shape) e.g. 0 for a scalar, 1 for a vector, 2 for a matrix etc.
    
    Returns:
  - getShape
```
public int[] getShape()
```
    Description copied from interface: INDArray
    
    Returns the shape of the array as an array of ints.
    
    Returns:
  - getShape
```
public int getShape(int dim)
```
    Description copied from interface: INDArray
    
    Returns the dimension size for a specific dimension in the array's shape
    
    Specified by:
    
    getShape in interface INDArray
    
    Overrides:
    
    getShape in class AbstractArray<T extends INDArray>
    
    Returns:
  - getLongShape
```
public long[] getLongShape()
```
    Description copied from interface: INDArray
    
    Returns the shape of the array as an array of longs.
    
    Returns:
  - get
```
public double get(int... indexes)
```
    Description copied from interface: INDArray
    
    Returns the double value at the specified index position in an array
    
    Returns:
  - set
```
public void set(double value)
```
    Description copied from interface: INDArray
    
    Sets all elements of an array to a specific double value
    
    Specified by:
    
    set in interface INDArray
    
    Overrides:
    
    set in class AbstractArray<T extends INDArray>
  - fill
```
public void fill(double value)
```
    Description copied from interface: INDArray
    
    Fills the array with asingle double value
    
    Specified by:
    
    fill in interface INDArray
    
    Overrides:
    
    fill in class AbstractArray<T extends INDArray>
  - set
```
public void set(int[] indexes,
       double value)
```
  - asVector
```
public AVector asVector()
```
    Description copied from interface: INDArray
    
    Constructs a view of the array as a single vector in row-major order.
    
    Returns:
  - reshape
```
public INDArray reshape(int... dimensions)
```
    Description copied from interface: INDArray
    
    Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape
    
    Specified by:
    
    reshape in interface INDArray
    
    Overrides:
    
    reshape in class AbstractArray<T extends INDArray>
    
    Returns:
  - slice
```
public INDArray slice(int majorSlice)
```
    Description copied from interface: INDArray
    
    Returns the specified major slice of this array as a view (slice along dimension 0)
    
    Returns:
  - slice
```
public INDArray slice(int dimension,
             int index)
```
    Description copied from interface: INDArray
    
    Returns a slice view of this array along the specified dimension
    
    Returns:
  - elementCount
```
public long elementCount()
```
    Description copied from interface: INDArray
    
    Returns the total number of elements in this array. Equivalent to the product all dimension sizes.
    
    Returns:
  - innerProduct
```
public INDArray innerProduct(INDArray a)
```
    Description copied from interface: INDArray
    
    Calculates the inner product of this array with another array.
    
    Specified by:
    
    innerProduct in interface INDArray
    
    Overrides:
    
    innerProduct in class AbstractArray<T extends INDArray>
    
    Returns:
  - outerProduct
```
public INDArray outerProduct(INDArray a)
```
    Description copied from interface: INDArray
    
    Calculates the outer product of this array with another array.
    
    Specified by:
    
    outerProduct in interface INDArray
    
    Overrides:
    
    outerProduct in class AbstractArray<T extends INDArray>
    
    Returns:
  - isMutable
```
public boolean isMutable()
```
    Description copied from interface: INDArray
    
    Returns true if the INDArray is mutable (at least partially)
    
    Returns:
  - isFullyMutable
```
public boolean isFullyMutable()
```
    Description copied from interface: INDArray
    
    If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e. every position can store any valid double value
    
    Returns:
  - isZero
```
public boolean isZero()
```
    Description copied from interface: INDArray
    
    Returns true if the array is zero (all elements equal to zero)
    
    Specified by:
    
    isZero in interface INDArray
    
    Overrides:
    
    isZero in class AbstractArray<T extends INDArray>
    
    Returns:
  - isBoolean
```
public boolean isBoolean()
```
    Description copied from interface: INDArray
    
    Returns true if the array is boolean (contains only 0.0 or 1.0 values)
    
    Specified by:
    
    isBoolean in interface INDArray
    
    Overrides:
    
    isBoolean in class AbstractArray<T extends INDArray>
  - isElementConstrained
```
public boolean isElementConstrained()
```
    Description copied from interface: INDArray
    
    Returns true if this array has some constraints on element values
  - isView
```
public boolean isView()
```
    Description copied from interface: INDArray
    
    Return true if this array is a view type
    
    Returns:
  - applyOp
```
public void applyOp(Op op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
  - applyOp
```
public void applyOp(IOp op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
  - multiply
```
public void multiply(double d)
```
    Description copied from interface: INDArray
    
    Multiplies all elements of the array by a given double value
  - equals
```
public boolean equals(INDArray a)
```
    Description copied from interface: INDArray
    
    Returns true if the two arrays are exactly equal in value and shape
    
    Specified by:
    
    equals in interface INDArray
    
    Overrides:
    
    equals in class AbstractArray<T extends INDArray>
    
    Returns:
  - exactClone
```
public SliceArray<T> exactClone()
```
    Description copied from interface: INDArray
    
    Returns an exact deep clone of an array (i.e. of the same class as the original).
    
    Returns:
  - sliceCount
```
public int sliceCount()
```
    Description copied from interface: INDArray
    
    returns the number of major slices in this array.
    
    Returns:
  - getSlices
```
public List<T> getSlices()
```
    Description copied from interface: INDArray
    
    Returns a list of all major slices of this array.
    
    Specified by:
    
    getSlices in interface INDArray
    
    Specified by:
    
    getSlices in class AbstractArray<T extends INDArray>
    
    Returns:
  - setElements
```
public void setElements(double[] values,
               int offset,
               int length)
```
    Description copied from interface: INDArray
    
    Sets all elements in an array using the given double values
  - validate
```
public void validate()
```
    Description copied from interface: INDArray
    
    Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.
    
    Specified by:
    
    validate in interface INDArray
    
    Overrides:
    
    validate in class AbstractArray<T extends INDArray>

Class SliceArray<T extends INDArray>

Method Summary

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Method Detail

create

repeat

create

dimensionality

getShape

getShape

getLongShape

get

set

fill

set

asVector

reshape

slice

slice

elementCount

innerProduct

outerProduct

isMutable

isFullyMutable

isZero

isBoolean

isElementConstrained

isView

applyOp

applyOp

multiply

equals

exactClone

sliceCount

getSlices

setElements

validate