AbstractArray (vectorz 0.22.0 API)

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

Type Parameters:
T - The type of array slices

All Implemented Interfaces:

Cloneable, Iterable<T>, INDArray

Direct Known Subclasses:

Array, AScalar, AVector, NDArray, SliceArray
```
public abstract class AbstractArray<T>
extends Object
implements INDArray, Iterable<T>
```
Abstract base class for INDArray implementations

Author:

Mike

Constructor Summary

Constructors
Constructor and Description

AbstractArray()

Constructors
Constructor and Description
`AbstractArray()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abs()` Replaces all elements of this array with their absolute values, according to Math.abs(double)
`void`	`add(double a)` Adds a double value to all elements in this array
`void`	`add(INDArray a)` Adds all the elements of another array to this array, in an elementwise order.
`double[]`	`asDoubleArray()` Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array
`List<Double>`	`asElementList()` Returns a list containing all elements of this array
`INDArray`	`broadcast(int... targetShape)` Returns a view of this array broadcasted up to a larger shape
`INDArray`	`broadcastCloneLike(INDArray target)` Creates a clone of the array, broadcasted if necessary to match the shape of the target
`INDArray`	`broadcastLike(INDArray target)` Broadcasts to match the shape of the target
`void`	`clamp(double min, double max)` Clamps all the elments of this array within the specified [min,max] range
`INDArray`	`clone()` Returns a clone of the array, as a new array which will be fully mutable and may be of a different class to the original.
`void`	`copyTo(double[] arr)` Copies all the elements of this INDArray to the specified double array
`void`	`divide(double factor)` Divides all elements by a given factor
`void`	`divide(INDArray a)` Divides all elements by the equivalent elements in a second array
`Iterator<Double>`	`elementIterator()` Returns an iterator over all elements in this array.
`double`	`elementSquaredSum()` Returns the total sum of elements in this array.
`double`	`elementSum()` Returns the total sum of elements in this array.
`INDArray`	`ensureMutable()` Ensures the array is a fully mutable, efficient representation that is not a view.
`boolean`	`epsilonEquals(INDArray a)` Tests is this array is approximately equal to another array.
`boolean`	`epsilonEquals(INDArray a, double epsilon)` Tests is this array is approximately equal to another array, up to a given tolerance (epsilon) The arrays must have the same shape
`boolean`	`equals(INDArray a)` Returns true if the two arrays are exactly equal in value and shape
`boolean`	`equals(Object o)`
`void`	`exp()` Computes the function e^x (in-place) for all array elements
`void`	`fill(double value)` Fills the array with asingle double value
`double`	`get()` Returns the double value of a scalar array
`double`	`get(int x)` Returns the double value at the specified position in a 1D vector
`double`	`get(int x, int y)` Returns the double value at the specified position in a 2D matrix
`void`	`getElements(double[] dest, int offset)` Gets all elements of the array, copying them into a double array
`int`	`getShape(int dim)` Returns the dimension size for a specific dimension in the array's shape
`abstract List<T>`	`getSlices()` Returns a list of all major slices of this array.
`List<INDArray>`	`getSliceViews()` Returns a list of slices as mutable INDArray views.
`INDArray`	`getTranspose()` Returns the transpose of this array.
`INDArray`	`getTransposeCopy()` Returns a transposed copy of the array.
`INDArray`	`getTransposeView()` Returns a transposed view of the array.
`int`	`hashCode()`
`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`	`isSameShape(INDArray a)` Returns true if this array is the same shape as another array
`boolean`	`isZero()` Returns true if the array is zero (all elements equal to zero)
`Iterator<T>`	`iterator()`
`void`	`log()` Computes the natural logarithm (in-place) for all array elements
`void`	`multiply(INDArray a)` Multiplies all elements by the equivalent elements in a second array
`void`	`negate()` Negates all elements in the array
`long`	`nonZeroCount()` Returns the number of non-zero elements in the array.
`INDArray`	`outerProduct(INDArray a)` Calculates the outer product of this array with another array.
`void`	`pow(double exponent)` Raises all elements of the array to a specified power
`void`	`reciprocal()` Replaces all elements in the array with their reciprocal
`INDArray`	`reshape(int... targetShape)` 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`	`scale(double d)` Scales all elements of the array by a given double value
`void`	`scaleAdd(double factor, double constant)` Scales all elements of the array by a given double value and adds a constant vale
`void`	`set(double value)` Sets all elements of an array to a specific double value
`void`	`set(INDArray a)` Sets this array to the element values contained in another array
`void`	`set(int x, double value)`
`void`	`set(int x, int y, double value)`
`void`	`set(Object o)` Sets this array to the element values contained in the given object.
`void`	`setElements(double[] values)` Sets all elements in an array using the given double values
`void`	`signum()` Calculates the signum of all elements of the array
`void`	`sqrt()` Computes the square root of all elements in the array
`void`	`square()` Squares all elements of the array
`void`	`sub(double a)` Subtracts a double value from all elements in this array
`void`	`sub(INDArray a)` Subtracts all the elements of another array from this array, in an elementwise order.
`Array`	`toArray()` Converts the array into a packed mutable Array instance
`double[]`	`toDoubleArray()` Copies the elements of this INDArray to a new double array
`void`	`toDoubleBuffer(DoubleBuffer dest)` Copies the elements of this INDArray to the specified double buffer
`String`	`toString()`
`Vector`	`toVector()` Converts the array into a flattened vector
`void`	`validate()` Validates the internal data structure of the INDArray.

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

Methods inherited from interface mikera.arrayz.INDArray
applyOp, applyOp, asVector, dimensionality, elementCount, exactClone, get, getLongShape, getShape, isElementConstrained, isFullyMutable, isMutable, isView, multiply, set, setElements, slice, slice, sliceCount

- Constructor Detail
  - AbstractArray
```
public AbstractArray()
```
- Method Detail
  - get
```
public double get()
```
    Description copied from interface: INDArray
    
    Returns the double value of a scalar array
    
    Specified by:
    
    get in interface INDArray
    
    Returns:
  - get
```
public double get(int x)
```
    Description copied from interface: INDArray
    
    Returns the double value at the specified position in a 1D vector
    
    Specified by:
    
    get in interface INDArray
    
    Returns:
  - get
```
public double get(int x,
         int y)
```
    Description copied from interface: INDArray
    
    Returns the double value at the specified position in a 2D matrix
    
    Specified by:
    
    get in interface INDArray
    
    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
    
    Returns:
  - epsilonEquals
```
public boolean epsilonEquals(INDArray a)
```
    Description copied from interface: INDArray
    
    Tests is this array is approximately equal to another array. The arrays must have the same shape
    
    Specified by:
    
    epsilonEquals in interface INDArray
    
    Returns:
  - epsilonEquals
```
public boolean epsilonEquals(INDArray a,
                    double epsilon)
```
    Description copied from interface: INDArray
    
    Tests is this array is approximately equal to another array, up to a given tolerance (epsilon) The arrays must have the same shape
    
    Specified by:
    
    epsilonEquals in interface 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
  - isSameShape
```
public boolean isSameShape(INDArray a)
```
    Description copied from interface: INDArray
    
    Returns true if this array is the same shape as another array
    
    Specified by:
    
    isSameShape in interface INDArray
  - 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
    
    Returns:
  - ensureMutable
```
public INDArray ensureMutable()
```
    Description copied from interface: INDArray
    
    Ensures the array is a fully mutable, efficient representation that is not a view. Returns either the same array or a new clone.
    
    Specified by:
    
    ensureMutable in interface 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
  - 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
    
    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
    
    Returns:
  - getTranspose
```
public INDArray getTranspose()
```
    Description copied from interface: INDArray
    
    Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions
    
    Specified by:
    
    getTranspose in interface INDArray
    
    Returns:
  - getTransposeView
```
public INDArray getTransposeView()
```
    Description copied from interface: INDArray
    
    Returns a transposed view of the array. May throw UnsupportedOperationException if the array does not support this capability
    
    Specified by:
    
    getTransposeView in interface INDArray
    
    Returns:
  - getTransposeCopy
```
public INDArray getTransposeCopy()
```
    Description copied from interface: INDArray
    
    Returns a transposed copy of the array.
    
    Specified by:
    
    getTransposeCopy in interface INDArray
    
    Returns:
  - scale
```
public final void scale(double d)
```
    Description copied from interface: INDArray
    
    Scales all elements of the array by a given double value
    
    Specified by:
    
    scale in interface INDArray
  - scaleAdd
```
public void scaleAdd(double factor,
            double constant)
```
    Description copied from interface: INDArray
    
    Scales all elements of the array by a given double value and adds a constant vale
    
    Specified by:
    
    scaleAdd in interface INDArray
  - 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
  - set
```
public void set(int x,
       double value)
```
    Specified by:
    
    set in interface INDArray
  - set
```
public void set(int x,
       int y,
       double value)
```
    Specified by:
    
    set in interface INDArray
  - set
```
public void set(INDArray a)
```
    Description copied from interface: INDArray
    
    Sets this array to the element values contained in another array
    
    Specified by:
    
    set in interface INDArray
  - clamp
```
public void clamp(double min,
         double max)
```
    Description copied from interface: INDArray
    
    Clamps all the elments of this array within the specified [min,max] range
    
    Specified by:
    
    clamp in interface INDArray
  - set
```
public void set(Object o)
```
    Description copied from interface: INDArray
    
    Sets this array to the element values contained in the given object. Attempts to interpret the object as an array
    
    Specified by:
    
    set in interface INDArray
  - setElements
```
public void setElements(double[] values)
```
    Description copied from interface: INDArray
    
    Sets all elements in an array using the given double values
    
    Specified by:
    
    setElements in interface INDArray
  - square
```
public void square()
```
    Description copied from interface: INDArray
    
    Squares all elements of the array
    
    Specified by:
    
    square in interface INDArray
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
  - elementIterator
```
public Iterator<Double> elementIterator()
```
    Description copied from interface: INDArray
    
    Returns an iterator over all elements in this array.
    
    Specified by:
    
    elementIterator in interface INDArray
    
    Returns:
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public INDArray clone()
```
    Description copied from interface: INDArray
    
    Returns a clone of the array, as a new array which will be fully mutable and may be of a different class to the original. Clone should attempt to return the most efficient possible array type.
    
    Specified by:
    
    clone in interface INDArray
    
    Overrides:
    
    clone in class Object
    
    Returns:
  - 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
    
    Returns:
  - add
```
public void add(INDArray a)
```
    Description copied from interface: INDArray
    
    Adds all the elements of another array to this array, in an elementwise order.
    
    Specified by:
    
    add in interface INDArray
  - add
```
public void add(double a)
```
    Description copied from interface: INDArray
    
    Adds a double value to all elements in this array
    
    Specified by:
    
    add in interface INDArray
  - pow
```
public void pow(double exponent)
```
    Description copied from interface: INDArray
    
    Raises all elements of the array to a specified power
    
    Specified by:
    
    pow in interface INDArray
  - sub
```
public void sub(double a)
```
    Description copied from interface: INDArray
    
    Subtracts a double value from all elements in this array
    
    Specified by:
    
    sub in interface INDArray
  - multiply
```
public void multiply(INDArray a)
```
    Description copied from interface: INDArray
    
    Multiplies all elements by the equivalent elements in a second array
    
    Specified by:
    
    multiply in interface INDArray
  - divide
```
public void divide(INDArray a)
```
    Description copied from interface: INDArray
    
    Divides all elements by the equivalent elements in a second array
    
    Specified by:
    
    divide in interface INDArray
  - divide
```
public void divide(double factor)
```
    Description copied from interface: INDArray
    
    Divides all elements by a given factor
    
    Specified by:
    
    divide in interface INDArray
  - nonZeroCount
```
public long nonZeroCount()
```
    Description copied from interface: INDArray
    
    Returns the number of non-zero elements in the array.
    
    Specified by:
    
    nonZeroCount in interface INDArray
    
    Returns:
  - elementSum
```
public double elementSum()
```
    Description copied from interface: INDArray
    
    Returns the total sum of elements in this array.
    
    Specified by:
    
    elementSum in interface INDArray
    
    Returns:
  - elementSquaredSum
```
public double elementSquaredSum()
```
    Description copied from interface: INDArray
    
    Returns the total sum of elements in this array.
    
    Specified by:
    
    elementSquaredSum in interface INDArray
    
    Returns:
  - sub
```
public void sub(INDArray a)
```
    Description copied from interface: INDArray
    
    Subtracts all the elements of another array from this array, in an elementwise order.
    
    Specified by:
    
    sub in interface INDArray
  - negate
```
public void negate()
```
    Description copied from interface: INDArray
    
    Negates all elements in the array
    
    Specified by:
    
    negate in interface INDArray
  - reciprocal
```
public void reciprocal()
```
    Description copied from interface: INDArray
    
    Replaces all elements in the array with their reciprocal
    
    Specified by:
    
    reciprocal in interface INDArray
  - abs
```
public void abs()
```
    Description copied from interface: INDArray
    
    Replaces all elements of this array with their absolute values, according to Math.abs(double)
    
    Specified by:
    
    abs in interface INDArray
  - sqrt
```
public void sqrt()
```
    Description copied from interface: INDArray
    
    Computes the square root of all elements in the array
    
    Specified by:
    
    sqrt in interface INDArray
  - log
```
public void log()
```
    Description copied from interface: INDArray
    
    Computes the natural logarithm (in-place) for all array elements
    
    Specified by:
    
    log in interface INDArray
  - exp
```
public void exp()
```
    Description copied from interface: INDArray
    
    Computes the function e^x (in-place) for all array elements
    
    Specified by:
    
    exp in interface INDArray
  - signum
```
public void signum()
```
    Description copied from interface: INDArray
    
    Calculates the signum of all elements of the array
    
    Specified by:
    
    signum in interface INDArray
  - reshape
```
public INDArray reshape(int... targetShape)
```
    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
    
    Returns:
  - getSlices
```
public abstract List<T> getSlices()
```
    Description copied from interface: INDArray
    
    Returns a list of all major slices of this array.
    
    Specified by:
    
    getSlices in interface INDArray
    
    Returns:
  - getSliceViews
```
public List<INDArray> getSliceViews()
```
    Description copied from interface: INDArray
    
    Returns a list of slices as mutable INDArray views. Note: will return a list of AScalar values when this array is a 1D vector
    
    Specified by:
    
    getSliceViews in interface INDArray
    
    Returns:
  - toVector
```
public Vector toVector()
```
    Description copied from interface: INDArray
    
    Converts the array into a flattened vector
    
    Specified by:
    
    toVector in interface INDArray
    
    Returns:
  - toArray
```
public Array toArray()
```
    Description copied from interface: INDArray
    
    Converts the array into a packed mutable Array instance
    
    Specified by:
    
    toArray in interface INDArray
    
    Returns:
  - asElementList
```
public List<Double> asElementList()
```
    Description copied from interface: INDArray
    
    Returns a list containing all elements of this array
    
    Specified by:
    
    asElementList in interface INDArray
    
    Returns:
  - getElements
```
public void getElements(double[] dest,
               int offset)
```
    Description copied from interface: INDArray
    
    Gets all elements of the array, copying them into a double array
    
    Specified by:
    
    getElements in interface INDArray
  - copyTo
```
public void copyTo(double[] arr)
```
    Description copied from interface: INDArray
    
    Copies all the elements of this INDArray to the specified double array
    
    Specified by:
    
    copyTo in interface INDArray
  - toDoubleBuffer
```
public void toDoubleBuffer(DoubleBuffer dest)
```
    Description copied from interface: INDArray
    
    Copies the elements of this INDArray to the specified double buffer
    
    Specified by:
    
    toDoubleBuffer in interface INDArray
  - toDoubleArray
```
public double[] toDoubleArray()
```
    Description copied from interface: INDArray
    
    Copies the elements of this INDArray to a new double array
    
    Specified by:
    
    toDoubleArray in interface INDArray
  - asDoubleArray
```
public double[] asDoubleArray()
```
    Description copied from interface: INDArray
    
    Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array
    
    Specified by:
    
    asDoubleArray in interface INDArray
  - broadcast
```
public INDArray broadcast(int... targetShape)
```
    Description copied from interface: INDArray
    
    Returns a view of this array broadcasted up to a larger shape
    
    Specified by:
    
    broadcast in interface INDArray
    
    Returns:
  - broadcastLike
```
public INDArray broadcastLike(INDArray target)
```
    Description copied from interface: INDArray
    
    Broadcasts to match the shape of the target
    
    Specified by:
    
    broadcastLike in interface INDArray
    
    Returns:
  - broadcastCloneLike
```
public INDArray broadcastCloneLike(INDArray target)
```
    Description copied from interface: INDArray
    
    Creates a clone of the array, broadcasted if necessary to match the shape of the target
    
    Specified by:
    
    broadcastCloneLike in interface INDArray
    
    Returns:
  - 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

Class AbstractArray<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.arrayz.INDArray

Constructor Detail

AbstractArray

Method Detail

get

get

get

getShape

epsilonEquals

epsilonEquals

isBoolean

isSameShape

isZero

ensureMutable

fill

innerProduct

outerProduct

getTranspose

getTransposeView

getTransposeCopy

scale

scaleAdd

set

set

set

set

clamp

set

setElements

square

iterator

elementIterator

equals

hashCode

toString

clone

equals

add

add

pow

sub

multiply

divide

divide

nonZeroCount

elementSum

elementSquaredSum

sub

negate

reciprocal

abs

sqrt

log

exp

signum

reshape

getSlices

getSliceViews

toVector

toArray

asElementList

getElements

copyTo

toDoubleBuffer

toDoubleArray

asDoubleArray

broadcast

broadcastLike

broadcastCloneLike

validate