AScalar

Documentation of 'mikera.vectorz.AScalar' Java class AScalar

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- mikera.arrayz.impl.AbstractArray<java.lang.Object>
- - mikera.vectorz.AScalar

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<java.lang.Object>, IDense, INDArray, IScalar

Direct Known Subclasses:

ArrayIndexScalar, ImmutableScalar, MatrixIndexScalar, Scalar, VectorIndexScalar
```
public abstract class AScalar
extends AbstractArray<java.lang.Object>
implements IScalar, IDense
```
Abstract base class for scalar arrays that represent a wrapped 0-d scalar value. These may be a 0-d view into another vector/matrix/array

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AScalar()

Constructors
Constructor and Description
`AScalar()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete 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 d)` 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.
`void`	`addAt(long i, double v)` Adds to a mutable array, indexed by element position in row major order.
`AScalar`	`addCopy(double d)` Creates a new array equal to this array with a constant value added to every element
`INDArray`	`addCopy(INDArray a)` Creates a new array equal to the sum of this array with another array.
`void`	`addInnerProduct(INDArray a, INDArray b)` Adds the inner product of two arrays to this array.
`void`	`addInnerProduct(INDArray a, INDArray b, double d)` Adds a scalar multiple of the inner product of two arrays to this array.
`void`	`addMultiple(INDArray src, double factor)` Adds a scaled multiple of another array to this array
`void`	`addPower(INDArray src, double factor)` Adds an array with all elements of the source array raised to the specified power
`void`	`addToArray(double[] data, int offset)` Adds all the elements of this array to a double array at the specified offset, in row-major order
`void`	`applyOp(IOperator 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)
`void`	`applyOp(Op2 op, double b)` Applies a binary operator to this array and a double value.
`void`	`applyOp(Op2 op, INDArray b)` Applies a binary operator to this array and a second array.
`double[]`	`asDoubleArray()` Returns the underlying double array representing the densely packed elements of this array.
`AVector`	`asVector()` Constructs a view of all elements in the array as a single vector in row-major order.
`INDArray`	`broadcast(int... targetShape)` Returns a view of this array broadcasted up to a larger shape
`AMatrix`	`broadcastLike(AMatrix v)` Broadcasts an array to match the shape of the target matrix
`AVector`	`broadcastLike(AVector v)` Broadcasts an array to match the shape of the target vector
`INDArray`	`broadcastLike(INDArray v)` Broadcasts an array to match the shape of the target
`void`	`clamp(double min, double max)` Clamps all the elements of this array within the specified [min,max] range
`Scalar`	`clone()` Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original.
`int`	`compareTo(INDArray a)`
`INDArray`	`dense()` Coerces this INDArray to a dense format, without changing its element values.
`Scalar`	`denseClone()` Creates a fully mutable dense clone of this array.
`int`	`dimensionality()` Returns the dimensionality of the array (i.e.
`void`	`divide(double factor)` Divides all elements by a given factor
`long`	`elementCount()` Returns the total number of elements in this array.
`java.util.Iterator<java.lang.Double>`	`elementIterator()` Returns an iterator over all elements in this array, in row-major order
`double`	`elementMax()` Returns the maximum element value in this array.
`double`	`elementMaxAbs()` Returns the maximum absolute element value in this array.
`double`	`elementMin()` Returns the maximum element value in this array.
`double`	`elementProduct()` Returns the product of all elements in the array.
`boolean`	`elementsEqual(double value)` Returns true if all elements are equal to a specific value
`double`	`elementSquaredSum()` Returns the sum of squared elements in this array.
`double`	`elementSum()` Returns the sum of all elements in this 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(AScalar o)` Returns true if this scalar is equal in value to another scalar.
`boolean`	`equals(INDArray o)` Checks if two arrays are equal exactly in terms of both value and shape Element equality checks are consistent with compareTo
`boolean`	`equals(java.lang.Object o)`
`boolean`	`equalsArray(double[] data, int offset)` Returns true if the elements in this array exactly match the elements in the given array, in row-major order
`abstract AScalar`	`exactClone()` Creates a deep clone of an array, using the same class implementation as the original array
`abstract double`	`get()` Returns the double value of a scalar array
`double`	`get(int... indexes)` Returns the double value at the specified index position in an 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
`double`	`getElement(long i)` Gets a specific element of this array, indexed in row-major order
`void`	`getElements(double[] arr)` Copies all elements of this INDArray to the specified double array
`void`	`getElements(double[] dest, int offset)` Copies all elements of this array a double array at the specified offset
`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
`java.util.List<java.lang.Object>`	`getSlices()` Returns a list of all major slices of this array.
`AScalar`	`getTranspose()` Returns the transpose of this array.
`AScalar`	`getTransposeView()` Returns a transposed view of the array.
`int`	`hashCode()`
`boolean`	`hasUncountable()` Returns true if any element is this array is NaN or infinite
`ImmutableScalar`	`immutable()` Returns an immutable version of this array.
`Scalar`	`innerProduct(AScalar a)` Calculates the inner product of this array with a scalar
`AVector`	`innerProduct(AVector a)` Computes the inner product of this array with a vector
`Scalar`	`innerProduct(double a)` Calculates the inner product of this array with a double value
`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`	`isZero()` Returns true if the array is zero (all elements equal to zero)
`java.util.Iterator<java.lang.Object>`	`iterator()`
`void`	`multiply(double factor)` Multiplies all elements of the array in place by a given double value
`void`	`multiply(INDArray a)` Multiplies all elements by the equivalent elements in a second array, i.e.
`INDArray`	`multiplyCopy(INDArray a)` Multiplies all elements by the equivalent elements in a second array, i.e.
`AScalar`	`mutable()` Coerces this INDArray to a fully mutable format.
`void`	`negate()` Negates all elements in the array in place
`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 in place
`double`	`reduce(Op2 op)` Reduces over all elements of the array in row-major order.
`double`	`reduce(Op2 op, double init)` Reduces over all elements of the array in row-major order.
`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
`abstract void`	`set(double value)` Sets all elements of an array to a specific double value
`void`	`set(int[] indexes, double value)` Sets the element at the given indexed position in a mutable array
`void`	`setApplyOp(Op op, INDArray a)` Sets this array to the result of applying an operation to a source array
`void`	`setElements(double... values)` Sets all elements in an array using the given double values
`void`	`setElements(double[] values, int offset)` Sets all elements in an array using the given double values
`void`	`setElements(int pos, double[] values, int offset, int length)` Sets elements in an array using the given double values.
`void`	`setSparse(double v)` Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable
`INDArray`	`slice(int position)` Returns the specified major slice of this array as a view (slice along dimension 0) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.
`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 (i.e.
`AScalar`	`sparse()` Coerces this INDArray to a sparse format, without changing its element values.
`Scalar`	`sparseClone()` Creates a fully mutable clone of this array.
`void`	`square()` Squares all elements of the array in place
`void`	`sub(double d)` 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.
`AScalar`	`subArray(int[] offsets, int[] shape)` Returns a subarray view of a larger array
`double[]`	`toDoubleArray()` Copies the elements of this array to a new double[] array.
`void`	`toDoubleBuffer(java.nio.DoubleBuffer dest)` Copies the elements of this INDArray to the specified double buffer.
`INDArray[]`	`toSliceArray()` Copies the slices of this array to a new INDArray[] Throws an error if the array has no slices (i.e.
`java.lang.String`	`toString()`
`void`	`validate()` Validates the internal data structure of the INDArray.

Methods inherited from class mikera.arrayz.impl.AbstractArray
absCopy, absDiff, absDiffCopy, add, addApplyOp, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addSparse, addSparse, applyOpCopy, asElementList, broadcastCloneLike, broadcastCopyLike, componentCount, copy, density, divide, divideCopy, divideCopy, elementAbsPowSum, elementPowSum, ensureMutable, epsilonEquals, equals, equalsArray, exp, fill, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getShapeClone, getSlices, getSliceViews, getTransposeCopy, isDense, isSameShape, isSparse, join, join, log, multiplyCopy, negateCopy, reciprocal, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, setInnerProduct, setMultiple, setMultiple, setSparse, signum, signumCopy, sliceValue, sqrt, squareCopy, sub, subCopy, toStringFull, toVector, withComponents

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

Methods inherited from interface mikera.arrayz.INDArray
absCopy, absDiff, absDiffCopy, addApplyOp, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addSparse, addSparse, applyOpCopy, asElementList, broadcastCloneLike, broadcastCopyLike, componentCount, copy, divide, divideCopy, divideCopy, elementAbsPowSum, elementPowSum, ensureMutable, epsilonEquals, equalsArray, exp, fill, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getShapeClone, getSlices, getSliceViews, getTransposeCopy, isDense, isSameShape, isSparse, isView, join, join, log, multiplyCopy, negateCopy, reciprocal, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, setInnerProduct, setMultiple, setMultiple, setSparse, signum, signumCopy, sliceValue, sqrt, squareCopy, subCopy, toVector, withComponents

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - AScalar
```
public AScalar()
```
- Method Detail
  - get
```
public abstract double get()
```
    Description copied from interface: INDArray
    
    Returns the double value of a scalar array
    
    Specified by:
    
    get in interface INDArray
    
    Specified by:
    
    get in interface IScalar
    
    Specified by:
    
    get in class AbstractArray<java.lang.Object>
  - set
```
public abstract 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
    
    Specified by:
    
    set in interface IScalar
    
    Overrides:
    
    set in class AbstractArray<java.lang.Object>
  - setSparse
```
public void setSparse(double v)
```
    Description copied from interface: INDArray
    
    Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable
    
    Specified by:
    
    setSparse in interface INDArray
    
    Overrides:
    
    setSparse in class AbstractArray<java.lang.Object>
  - 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
    
    Specified by:
    
    get in class AbstractArray<java.lang.Object>
  - 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
    
    Specified by:
    
    get in class AbstractArray<java.lang.Object>
  - setElements
```
public void setElements(int pos,
                        double[] values,
                        int offset,
                        int length)
```
    Description copied from interface: INDArray
    
    Sets elements in an array using the given double values. The source array must contain at least the specified length in terms of number of elements
    
    Specified by:
    
    setElements in interface INDArray
    
    Overrides:
    
    setElements in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    pos - Offset into this array, expressed in terms of number of elements in row major order
    
    values - Element values in a double[] array. There must be at least as many element values as elements in this array.
    
    offset - Position in the values array from which to start taking values.
    
    length - Number of elements to set.
  - getElements
```
public void getElements(double[] dest,
                        int offset)
```
    Description copied from interface: INDArray
    
    Copies all elements of this array a double array at the specified offset
    
    Specified by:
    
    getElements in interface INDArray
    
    Overrides:
    
    getElements in class AbstractArray<java.lang.Object>
  - getTranspose
```
public final AScalar 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. May or may not return a view depending on the array type.
    
    Specified by:
    
    getTranspose in interface INDArray
    
    Overrides:
    
    getTranspose in class AbstractArray<java.lang.Object>
  - getTransposeView
```
public final AScalar getTransposeView()
```
    Description copied from interface: INDArray
    
    Returns a transposed view of the array. May throw UnsupportedOperationException if the array type does not support this capability
    
    Specified by:
    
    getTransposeView in interface INDArray
    
    Overrides:
    
    getTransposeView in class AbstractArray<java.lang.Object>
  - dimensionality
```
public final int dimensionality()
```
    Description copied from interface: INDArray
    
    Returns the dimensionality of the array (i.e. the number of dimensions in the array shape) e.g. 0 for a scalar, 1 for a vector, 2 for a matrix etc.
    
    Specified by:
    
    dimensionality in interface INDArray
  - slice
```
public INDArray slice(int position)
```
    Description copied from interface: INDArray
    
    Returns the specified major slice of this array as a view (slice along dimension 0) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.
    
    Specified by:
    
    slice in interface INDArray
  - slice
```
public INDArray slice(int dimension,
                      int index)
```
    Description copied from interface: INDArray
    
    Returns a slice view of this array along the specified dimension
    
    Specified by:
    
    slice in interface INDArray
  - sliceCount
```
public final int sliceCount()
```
    Description copied from interface: INDArray
    
    Returns the number of major slices in this array (i.e. the size of dimension 0)
    
    Specified by:
    
    sliceCount in interface INDArray
  - getSlices
```
public java.util.List<java.lang.Object> getSlices()
```
    Description copied from interface: INDArray
    
    Returns a list of all major slices of this array. Returns a list of Double values if a 1-dimensional array is sliced, otherwise a list of INDArray instances
    
    Specified by:
    
    getSlices in interface INDArray
    
    Overrides:
    
    getSlices in class AbstractArray<java.lang.Object>
  - subArray
```
public AScalar subArray(int[] offsets,
                        int[] shape)
```
    Description copied from interface: INDArray
    
    Returns a subarray view of a larger array
    
    Specified by:
    
    subArray in interface INDArray
    
    Overrides:
    
    subArray in class AbstractArray<java.lang.Object>
  - iterator
```
public java.util.Iterator<java.lang.Object> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Object>
    
    Overrides:
    
    iterator in class AbstractArray<java.lang.Object>
  - isMutable
```
public boolean isMutable()
```
    Description copied from interface: INDArray
    
    Returns true if the INDArray is mutable (at least partially)
    
    Specified by:
    
    isMutable in interface INDArray
    
    Overrides:
    
    isMutable in class AbstractArray<java.lang.Object>
  - 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
    
    Specified by:
    
    isFullyMutable in interface INDArray
    
    Overrides:
    
    isFullyMutable in class AbstractArray<java.lang.Object>
  - isElementConstrained
```
public boolean isElementConstrained()
```
    Description copied from interface: INDArray
    
    Returns true if this array has some constraints on element values
    
    Specified by:
    
    isElementConstrained in interface INDArray
    
    Overrides:
    
    isElementConstrained in class AbstractArray<java.lang.Object>
  - 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<java.lang.Object>
  - 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<java.lang.Object>
  - add
```
public void add(double d)
```
    Description copied from interface: INDArray
    
    Adds a double value to all elements in this array. Implementations may optimize the case of 0.0
    
    Specified by:
    
    add in interface INDArray
    
    Overrides:
    
    add in class AbstractArray<java.lang.Object>
  - addCopy
```
public AScalar addCopy(double d)
```
    Description copied from interface: INDArray
    
    Creates a new array equal to this array with a constant value added to every element
    
    Specified by:
    
    addCopy in interface INDArray
    
    Overrides:
    
    addCopy in class AbstractArray<java.lang.Object>
    
    Returns:
  - addCopy
```
public final INDArray addCopy(INDArray a)
```
    Description copied from interface: INDArray
    
    Creates a new array equal to the sum of this array with another array.
    
    Specified by:
    
    addCopy in interface INDArray
    
    Overrides:
    
    addCopy in class AbstractArray<java.lang.Object>
    
    Returns:
  - addAt
```
public void addAt(long i,
                  double v)
```
    Description copied from interface: INDArray
    
    Adds to a mutable array, indexed by element position in row major order. This is an unsafe operation: bounds are not checked
    
    Specified by:
    
    addAt in interface INDArray
    
    Overrides:
    
    addAt in class AbstractArray<java.lang.Object>
  - addToArray
```
public void addToArray(double[] data,
                       int offset)
```
    Description copied from interface: INDArray
    
    Adds all the elements of this array to a double array at the specified offset, in row-major order
    
    Specified by:
    
    addToArray in interface INDArray
    
    Overrides:
    
    addToArray in class AbstractArray<java.lang.Object>
  - addInnerProduct
```
public final void addInnerProduct(INDArray a,
                                  INDArray b)
```
    Description copied from interface: INDArray
    
    Adds the inner product of two arrays to this array.
    
    Specified by:
    
    addInnerProduct in interface INDArray
    
    Overrides:
    
    addInnerProduct in class AbstractArray<java.lang.Object>
  - addInnerProduct
```
public void addInnerProduct(INDArray a,
                            INDArray b,
                            double d)
```
    Description copied from interface: INDArray
    
    Adds a scalar multiple of the inner product of two arrays to this array.
    
    Specified by:
    
    addInnerProduct in interface INDArray
    
    Overrides:
    
    addInnerProduct in class AbstractArray<java.lang.Object>
  - addMultiple
```
public void addMultiple(INDArray src,
                        double factor)
```
    Description copied from interface: INDArray
    
    Adds a scaled multiple of another array to this array
    
    Specified by:
    
    addMultiple in interface INDArray
    
    Overrides:
    
    addMultiple in class AbstractArray<java.lang.Object>
  - addPower
```
public void addPower(INDArray src,
                     double factor)
```
    Description copied from interface: INDArray
    
    Adds an array with all elements of the source array raised to the specified power
    
    Specified by:
    
    addPower in interface INDArray
    
    Overrides:
    
    addPower in class AbstractArray<java.lang.Object>
  - sub
```
public void sub(double d)
```
    Description copied from interface: INDArray
    
    Subtracts a double value from all elements in this array
    
    Specified by:
    
    sub in interface INDArray
    
    Overrides:
    
    sub in class AbstractArray<java.lang.Object>
  - 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
    
    Overrides:
    
    add in class AbstractArray<java.lang.Object>
  - 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
    
    Overrides:
    
    sub in class AbstractArray<java.lang.Object>
  - negate
```
public void negate()
```
    Description copied from interface: INDArray
    
    Negates all elements in the array in place
    
    Specified by:
    
    negate in interface INDArray
    
    Overrides:
    
    negate in class AbstractArray<java.lang.Object>
  - square
```
public void square()
```
    Description copied from interface: INDArray
    
    Squares all elements of the array in place
    
    Specified by:
    
    square in interface INDArray
    
    Overrides:
    
    square in class AbstractArray<java.lang.Object>
  - pow
```
public void pow(double exponent)
```
    Description copied from interface: INDArray
    
    Raises all elements of the array to a specified power in place
    
    Specified by:
    
    pow in interface INDArray
    
    Overrides:
    
    pow in class AbstractArray<java.lang.Object>
  - clamp
```
public void clamp(double min,
                  double max)
```
    Description copied from interface: INDArray
    
    Clamps all the elements of this array within the specified [min,max] range
    
    Specified by:
    
    clamp in interface INDArray
    
    Overrides:
    
    clamp in class AbstractArray<java.lang.Object>
  - 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<java.lang.Object>
  - innerProduct
```
public Scalar innerProduct(AScalar a)
```
    Description copied from interface: INDArray
    
    Calculates the inner product of this array with a scalar
    
    Specified by:
    
    innerProduct in interface INDArray
    
    Overrides:
    
    innerProduct in class AbstractArray<java.lang.Object>
  - innerProduct
```
public Scalar innerProduct(double a)
```
    Description copied from interface: INDArray
    
    Calculates the inner product of this array with a double value
    
    Specified by:
    
    innerProduct in interface INDArray
    
    Overrides:
    
    innerProduct in class AbstractArray<java.lang.Object>
  - innerProduct
```
public AVector innerProduct(AVector a)
```
    Description copied from interface: INDArray
    
    Computes the inner product of this array with a vector
    
    Specified by:
    
    innerProduct in interface INDArray
    
    Overrides:
    
    innerProduct in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    a - A vector
    
    Returns:
    
    A new array representing the inner product
  - 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<java.lang.Object>
  - get
```
public double get(int... indexes)
```
    Description copied from interface: INDArray
    
    Returns the double value at the specified index position in an array
    
    Specified by:
    
    get in interface INDArray
  - set
```
public void set(int[] indexes,
                double value)
```
    Description copied from interface: INDArray
    
    Sets the element at the given indexed position in a mutable array
    
    Specified by:
    
    set in interface INDArray
  - getShape
```
public int[] getShape()
```
    Description copied from interface: INDArray
    
    Returns the shape of the array as an array of ints. WARNING: May return the internal int[] array describing the shape. Modifying this may cause undefined behaviour. If you want to guarantee a new int[] array that can be safely modified, use getShapeClone() instead
    
    Specified by:
    
    getShape in interface INDArray
  - 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<java.lang.Object>
  - getLongShape
```
public long[] getLongShape()
```
    Description copied from interface: INDArray
    
    Returns the shape of the array as an array of longs.
    
    Specified by:
    
    getLongShape in interface INDArray
    
    Overrides:
    
    getLongShape in class AbstractArray<java.lang.Object>
  - elementCount
```
public final long elementCount()
```
    Description copied from interface: INDArray
    
    Returns the total number of elements in this array. Equivalent to the product of all dimension sizes.
    
    Specified by:
    
    elementCount 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
    
    Overrides:
    
    nonZeroCount in class AbstractArray<java.lang.Object>
  - getElement
```
public double getElement(long i)
```
    Description copied from interface: INDArray
    
    Gets a specific element of this array, indexed in row-major order
    
    Specified by:
    
    getElement in interface INDArray
    
    Returns:
    
    The element value
  - getElements
```
public void getElements(double[] arr)
```
    Description copied from interface: INDArray
    
    Copies all elements of this INDArray to the specified double array
    
    Specified by:
    
    getElements in interface INDArray
    
    Overrides:
    
    getElements in class AbstractArray<java.lang.Object>
  - 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
    
    Overrides:
    
    setElements in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    values - Element values in a double[] array. There must be at least as many element values as elements in this array.
  - setElements
```
public void setElements(double[] values,
                        int offset)
```
    Description copied from interface: INDArray
    
    Sets all elements in an array using the given double values
    
    Specified by:
    
    setElements in interface INDArray
    
    Overrides:
    
    setElements in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    values - Element values in a double[] array. There must be at least as many element values as elements in this array.
    
    offset - Position in the values array from which to start taking values.
  - asVector
```
public AVector asVector()
```
    Description copied from interface: INDArray
    
    Constructs a view of all elements in the array as a single vector in row-major order.
    
    Specified by:
    
    asVector in interface INDArray
    
    Overrides:
    
    asVector in class AbstractArray<java.lang.Object>
  - 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<java.lang.Object>
  - applyOp
```
public void applyOp(IOperator op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    op - The operator to apply to the array
  - applyOp
```
public void applyOp(Op op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AbstractArray<java.lang.Object>
  - setApplyOp
```
public void setApplyOp(Op op,
                       INDArray a)
```
    Description copied from interface: INDArray
    
    Sets this array to the result of applying an operation to a source array
    
    Specified by:
    
    setApplyOp in interface INDArray
    
    Overrides:
    
    setApplyOp in class AbstractArray<java.lang.Object>
  - applyOp
```
public void applyOp(Op2 op,
                    INDArray b)
```
    Description copied from interface: INDArray
    
    Applies a binary operator to this array and a second array. Broadcasts the second array to the shape of this array if required.
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AbstractArray<java.lang.Object>
  - applyOp
```
public void applyOp(Op2 op,
                    double b)
```
    Description copied from interface: INDArray
    
    Applies a binary operator to this array and a double value. Works as if the double value was broadcast to the shape of this array.
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AbstractArray<java.lang.Object>
  - reduce
```
public double reduce(Op2 op,
                     double init)
```
    Description copied from interface: INDArray
    
    Reduces over all elements of the array in row-major order. Applies the operator to the initial/previous result at each step. Returns the final result.
    
    Specified by:
    
    reduce in interface INDArray
    
    Overrides:
    
    reduce in class AbstractArray<java.lang.Object>
  - reduce
```
public final double reduce(Op2 op)
```
    Description copied from interface: INDArray
    
    Reduces over all elements of the array in row-major order. Applies the operator to the previous result at each step. Returns the final result.
    
    Specified by:
    
    reduce in interface INDArray
    
    Overrides:
    
    reduce in class AbstractArray<java.lang.Object>
  - clone
```
public Scalar clone()
```
    Description copied from interface: INDArray
    
    Returns a clone of the array data, 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. Clone should preserve sparsity property where possible, but this is not guaranteed.
    
    Specified by:
    
    clone in interface INDArray
    
    Overrides:
    
    clone in class AbstractArray<java.lang.Object>
  - multiply
```
public void multiply(double factor)
```
    Description copied from interface: INDArray
    
    Multiplies all elements of the array in place by a given double value
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class AbstractArray<java.lang.Object>
  - divide
```
public void divide(double factor)
```
    Description copied from interface: INDArray
    
    Divides all elements by a given factor
    
    Specified by:
    
    divide in interface INDArray
    
    Overrides:
    
    divide in class AbstractArray<java.lang.Object>
  - multiply
```
public void multiply(INDArray a)
```
    Description copied from interface: INDArray
    
    Multiplies all elements by the equivalent elements in a second array, i.e. performs elementwise multiplication. If matrix-style multiplication is required, use innerProduct instead.
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class AbstractArray<java.lang.Object>
  - multiplyCopy
```
public final INDArray multiplyCopy(INDArray a)
```
    Description copied from interface: INDArray
    
    Multiplies all elements by the equivalent elements in a second array, i.e. performs elementwise multiplication. Returns a new array. If matrix-style multiplication is required, use innerProduct instead.
    
    Specified by:
    
    multiplyCopy in interface INDArray
    
    Overrides:
    
    multiplyCopy in class AbstractArray<java.lang.Object>
  - elementSum
```
public final double elementSum()
```
    Description copied from interface: INDArray
    
    Returns the sum of all elements in this array.
    
    Specified by:
    
    elementSum in interface INDArray
    
    Overrides:
    
    elementSum in class AbstractArray<java.lang.Object>
  - elementProduct
```
public final double elementProduct()
```
    Description copied from interface: INDArray
    
    Returns the product of all elements in the array.
    
    Specified by:
    
    elementProduct in interface INDArray
    
    Overrides:
    
    elementProduct in class AbstractArray<java.lang.Object>
    
    Returns:
  - elementMaxAbs
```
public double elementMaxAbs()
```
    Description copied from interface: INDArray
    
    Returns the maximum absolute element value in this array. Throws an error if there are no elements.
    
    Specified by:
    
    elementMaxAbs in interface INDArray
    
    Overrides:
    
    elementMaxAbs in class AbstractArray<java.lang.Object>
  - elementMax
```
public double elementMax()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array. Throws an error if there are no elements.
    
    Specified by:
    
    elementMax in interface INDArray
    
    Overrides:
    
    elementMax in class AbstractArray<java.lang.Object>
  - elementMin
```
public double elementMin()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array. Throws an error if there are no elements.
    
    Specified by:
    
    elementMin in interface INDArray
    
    Overrides:
    
    elementMin in class AbstractArray<java.lang.Object>
  - elementSquaredSum
```
public final double elementSquaredSum()
```
    Description copied from interface: INDArray
    
    Returns the sum of squared elements in this array.
    
    Specified by:
    
    elementSquaredSum in interface INDArray
    
    Overrides:
    
    elementSquaredSum in class AbstractArray<java.lang.Object>
  - 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
    
    Overrides:
    
    broadcast in class AbstractArray<java.lang.Object>
  - broadcastLike
```
public INDArray broadcastLike(INDArray v)
```
    Description copied from interface: INDArray
    
    Broadcasts an array to match the shape of the target
    
    Specified by:
    
    broadcastLike in interface INDArray
    
    Overrides:
    
    broadcastLike in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    v - The target array
  - broadcastLike
```
public AVector broadcastLike(AVector v)
```
    Description copied from interface: INDArray
    
    Broadcasts an array to match the shape of the target vector
    
    Specified by:
    
    broadcastLike in interface INDArray
    
    Overrides:
    
    broadcastLike in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    v - The target vector
  - broadcastLike
```
public AMatrix broadcastLike(AMatrix v)
```
    Description copied from interface: INDArray
    
    Broadcasts an array to match the shape of the target matrix
    
    Specified by:
    
    broadcastLike in interface INDArray
    
    Overrides:
    
    broadcastLike in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    v - The target matrix
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class AbstractArray<java.lang.Object>
  - 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
    
    Overrides:
    
    epsilonEquals in class AbstractArray<java.lang.Object>
  - compareTo
```
public int compareTo(INDArray a)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<INDArray>
    
    Overrides:
    
    compareTo in class AbstractArray<java.lang.Object>
  - equals
```
public boolean equals(INDArray o)
```
    Description copied from interface: INDArray
    
    Checks if two arrays are equal exactly in terms of both value and shape Element equality checks are consistent with compareTo
    
    Specified by:
    
    equals in interface INDArray
    
    Overrides:
    
    equals in class AbstractArray<java.lang.Object>
  - equalsArray
```
public boolean equalsArray(double[] data,
                           int offset)
```
    Description copied from interface: INDArray
    
    Returns true if the elements in this array exactly match the elements in the given array, in row-major order
    
    Specified by:
    
    equalsArray in interface INDArray
    
    Overrides:
    
    equalsArray in class AbstractArray<java.lang.Object>
    
    Parameters:
    
    data - Array of double element values to check for equality
    
    offset - Offset into the data array
    
    Returns:
  - equals
```
public boolean equals(AScalar o)
```
    Returns true if this scalar is equal in value to another scalar.
    
    Parameters:
    
    o -
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractArray<java.lang.Object>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class AbstractArray<java.lang.Object>
  - elementIterator
```
public java.util.Iterator<java.lang.Double> elementIterator()
```
    Description copied from interface: INDArray
    
    Returns an iterator over all elements in this array, in row-major order
    
    Specified by:
    
    elementIterator in interface INDArray
    
    Overrides:
    
    elementIterator in class AbstractArray<java.lang.Object>
  - toDoubleBuffer
```
public void toDoubleBuffer(java.nio.DoubleBuffer dest)
```
    Description copied from interface: INDArray
    
    Copies the elements of this INDArray to the specified double buffer.
    
    Specified by:
    
    toDoubleBuffer in interface INDArray
    
    Overrides:
    
    toDoubleBuffer in class AbstractArray<java.lang.Object>
  - asDoubleArray
```
public double[] asDoubleArray()
```
    Description copied from interface: INDArray
    
    Returns the underlying double array representing the densely packed elements of this array. Modifications to this double array will change the original array. Returns null if there is no such array.
    
    Specified by:
    
    asDoubleArray in interface INDArray
    
    Overrides:
    
    asDoubleArray in class AbstractArray<java.lang.Object>
  - toDoubleArray
```
public double[] toDoubleArray()
```
    Description copied from interface: INDArray
    
    Copies the elements of this array to a new double[] array.
    
    Specified by:
    
    toDoubleArray in interface INDArray
    
    Overrides:
    
    toDoubleArray in class AbstractArray<java.lang.Object>
  - toSliceArray
```
public INDArray[] toSliceArray()
```
    Description copied from interface: INDArray
    
    Copies the slices of this array to a new INDArray[] Throws an error if the array has no slices (i.e. is zero-dimensional)
    
    Specified by:
    
    toSliceArray in interface INDArray
    
    Overrides:
    
    toSliceArray in class AbstractArray<java.lang.Object>
  - exactClone
```
public abstract AScalar exactClone()
```
    Description copied from interface: INDArray
    
    Creates a deep clone of an array, using the same class implementation as the original array
    
    Specified by:
    
    exactClone in interface INDArray
    
    Returns:
    
    A clone of the original array
  - mutable
```
public AScalar mutable()
```
    Description copied from interface: INDArray
    
    Coerces this INDArray to a fully mutable format. May return the same INDArray if already fully mutable
    
    Specified by:
    
    mutable in interface INDArray
    
    Specified by:
    
    mutable in interface IScalar
    
    Overrides:
    
    mutable in class AbstractArray<java.lang.Object>
  - elementsEqual
```
public boolean elementsEqual(double value)
```
    Description copied from interface: INDArray
    
    Returns true if all elements are equal to a specific value
    
    Specified by:
    
    elementsEqual in interface INDArray
    
    Overrides:
    
    elementsEqual in class AbstractArray<java.lang.Object>
  - sparse
```
public AScalar sparse()
```
    Description copied from interface: INDArray
    
    Coerces this INDArray to a sparse format, without changing its element values. May return the same INDArray if already sparse. May also mutate the internal structure of the original NDArray, or create a view over parts of the original INDArray. You should take a defensive copy of the original NDArray if any of this concerns you. The returned sparse array may not be fully mutable in all elements.
    
    Specified by:
    
    sparse in interface INDArray
    
    Overrides:
    
    sparse in class AbstractArray<java.lang.Object>
  - dense
```
public INDArray dense()
```
    Description copied from interface: INDArray
    
    Coerces this INDArray to a dense format, without changing its element values. May return the same INDArray if already dense. May also mutate the internal structure of the original NDArray, or create a view over parts of the original INDArray. You should take a defensive copy of the original NDArray if any of this concerns you. The returned dense array may not be fully mutable in all elements.
    
    Specified by:
    
    dense in interface INDArray
    
    Overrides:
    
    dense in class AbstractArray<java.lang.Object>
  - denseClone
```
public final Scalar denseClone()
```
    Description copied from interface: INDArray
    
    Creates a fully mutable dense clone of this array. Will always use a dense format, even if the array data is sparse.
    
    Specified by:
    
    denseClone in interface INDArray
    
    Overrides:
    
    denseClone in class AbstractArray<java.lang.Object>
  - sparseClone
```
public final Scalar sparseClone()
```
    Description copied from interface: INDArray
    
    Creates a fully mutable clone of this array. Will use a sparse format if possible.
    
    Specified by:
    
    sparseClone in interface INDArray
    
    Overrides:
    
    sparseClone in class AbstractArray<java.lang.Object>
  - immutable
```
public ImmutableScalar immutable()
```
    Description copied from interface: INDArray
    
    Returns an immutable version of this array. May return the same array if already immutable. Guarantees a defensive copy if the array is mutable.
    
    Specified by:
    
    immutable in interface INDArray
    
    Specified by:
    
    immutable in interface IScalar
    
    Overrides:
    
    immutable in class AbstractArray<java.lang.Object>
  - 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<java.lang.Object>
  - 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
    
    Overrides:
    
    abs in class AbstractArray<java.lang.Object>
  - hasUncountable
```
public boolean hasUncountable()
```
    Description copied from class: AbstractArray
    
    Returns true if any element is this array is NaN or infinite
    
    Specified by:
    
    hasUncountable in interface INDArray
    
    Overrides:
    
    hasUncountable in class AbstractArray<java.lang.Object>
    
    Returns:
    
    True if any element is this array is NaN or infinite, false otherwise

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class AScalar

Constructor Summary

Method Summary

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.arrayz.INDArray

Methods inherited from interface java.lang.Iterable

Constructor Detail

AScalar

Method Detail

get

set

setSparse

get

get

setElements

getElements

getTranspose

getTransposeView

dimensionality

slice

slice

sliceCount

getSlices

subArray

iterator

isMutable

isFullyMutable

isElementConstrained

isZero

isBoolean

add

addCopy

addCopy

addAt

addToArray

addInnerProduct

addInnerProduct

addMultiple

addPower

sub

add

sub

negate

square

pow

clamp

innerProduct

innerProduct

innerProduct

innerProduct

outerProduct

get

set

getShape

getShape

getLongShape

elementCount

nonZeroCount

getElement

getElements

setElements

setElements

asVector

reshape

applyOp

applyOp

setApplyOp

applyOp

applyOp

reduce

reduce

clone

multiply

divide

multiply

multiplyCopy

elementSum

elementProduct

elementMaxAbs