AScalar (vectorz 0.13.0 API)

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

All Implemented Interfaces:

Cloneable, Iterable<Object>, INDArray

Direct Known Subclasses:

ArrayIndexScalar, DoubleScalar, VectorIndexScalar
```
public abstract class AScalar
extends AbstractArray<Object>
```
Class to represent a wrapped 0-d scalar value. Can be a view into another vector/matrix/array

Author:

Mike

Constructor Summary

Constructors
Constructor and Description

AScalar()

Constructors
Constructor and Description
`AScalar()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(AScalar s)`
`void`	`add(double d)`
`void`	`add(INDArray a)`
`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()` Creates a view of the array as a single vector in row-major order.
`INDArray`	`broadcast(int... targetShape)`
`AScalar`	`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.
`int`	`dimensionality()`
`long`	`elementCount()`
`boolean`	`equals(AScalar o)`
`boolean`	`equals(INDArray o)` Returns true if the two arrays are exactly equal in value and shape
`boolean`	`equals(Object o)`
`abstract AScalar`	`exactClone()` Returns an exact deep clone of an array (i.e.
`abstract double`	`get()`
`double`	`get(int... indexes)`
`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.
`List<Object>`	`getSlices()`
`int`	`hashCode()`
`INDArray`	`innerProduct(INDArray a)`
`boolean`	`isElementConstrained()` Returns true if the IND has additional constraints on element values
`boolean`	`isFullyMutable()` Returns true if the INDArray is fully mutable in all positions i.e.
`boolean`	`isMutable()` Returns true if the INDArray is mutable (at least partially)
`Iterator<Object>`	`iterator()`
`void`	`multiply(double factor)`
`INDArray`	`outerProduct(INDArray a)`
`INDArray`	`reshape(int... dimensions)`
`void`	`set(double value)`
`void`	`set(int[] indexes, double value)`
`void`	`setElements(double[] values, int offset, int length)`
`INDArray`	`slice(int position)`
`int`	`sliceCount()`
`void`	`sub(AScalar s)`
`void`	`sub(double d)`
`void`	`sub(INDArray a)`
`String`	`toString()`

Methods inherited from class mikera.arrayz.AbstractArray
get, get, scale, set, set, set, set, setElements, square

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

Methods inherited from interface mikera.arrayz.INDArray
isView

- Constructor Detail
  - AScalar
```
public AScalar()
```
- Method Detail
  - get
```
public abstract double get()
```
    Specified by:
    
    get in interface INDArray
    
    Overrides:
    
    get in class AbstractArray<Object>
  - set
```
public void set(double value)
```
    Specified by:
    
    set in interface INDArray
    
    Overrides:
    
    set in class AbstractArray<Object>
  - setElements
```
public void setElements(double[] values,
               int offset,
               int length)
```
  - dimensionality
```
public int dimensionality()
```
  - slice
```
public INDArray slice(int position)
```
  - sliceCount
```
public int sliceCount()
```
  - getSlices
```
public List<Object> getSlices()
```
  - iterator
```
public Iterator<Object> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Object>
    
    Overrides:
    
    iterator in class AbstractArray<Object>
  - 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
    
    Returns true if the INDArray is fully mutable in all positions i.e. every position can store any valid double value
    
    Returns:
  - isElementConstrained
```
public boolean isElementConstrained()
```
    Description copied from interface: INDArray
    
    Returns true if the IND has additional constraints on element values
  - add
```
public void add(double d)
```
  - sub
```
public void sub(double d)
```
  - add
```
public void add(AScalar s)
```
  - add
```
public void add(INDArray a)
```
    Specified by:
    
    add in interface INDArray
    
    Overrides:
    
    add in class AbstractArray<Object>
  - sub
```
public void sub(INDArray a)
```
    Specified by:
    
    sub in interface INDArray
    
    Overrides:
    
    sub in class AbstractArray<Object>
  - sub
```
public void sub(AScalar s)
```
  - innerProduct
```
public INDArray innerProduct(INDArray a)
```
    Specified by:
    
    innerProduct in interface INDArray
    
    Overrides:
    
    innerProduct in class AbstractArray<Object>
  - outerProduct
```
public INDArray outerProduct(INDArray a)
```
    Specified by:
    
    outerProduct in interface INDArray
    
    Overrides:
    
    outerProduct in class AbstractArray<Object>
  - get
```
public double get(int... indexes)
```
  - set
```
public void set(int[] indexes,
       double value)
```
  - getShape
```
public int[] getShape()
```
    Description copied from interface: INDArray
    
    Returns the shape of the array as an array of ints.
    
    Returns:
  - getLongShape
```
public long[] getLongShape()
```
    Description copied from interface: INDArray
    
    Returns the shape of the array as an array of longs.
    
    Returns:
  - elementCount
```
public long elementCount()
```
  - asVector
```
public AVector asVector()
```
    Description copied from interface: INDArray
    
    Creates a view of the array as a single vector in row-major order.
    
    Returns:
  - reshape
```
public INDArray reshape(int... dimensions)
```
    Specified by:
    
    reshape in interface INDArray
    
    Overrides:
    
    reshape in class AbstractArray<Object>
  - applyOp
```
public void applyOp(IOp op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
  - applyOp
```
public void applyOp(Op op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
  - clone
```
public AScalar 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.
    
    Specified by:
    
    clone in interface INDArray
    
    Overrides:
    
    clone in class AbstractArray<Object>
    
    Returns:
  - multiply
```
public void multiply(double factor)
```
  - broadcast
```
public INDArray broadcast(int... targetShape)
```
    Specified by:
    
    broadcast in interface INDArray
    
    Overrides:
    
    broadcast in class AbstractArray<Object>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class AbstractArray<Object>
  - equals
```
public boolean equals(INDArray o)
```
    Description copied from interface: INDArray
    
    Returns true if the two arrays are exactly equal in value and shape
    
    Returns:
  - equals
```
public boolean equals(AScalar o)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractArray<Object>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractArray<Object>
  - exactClone
```
public abstract AScalar exactClone()
```
    Description copied from interface: INDArray
    
    Returns an exact deep clone of an array (i.e. of the same class as the original).
    
    Returns:

Class AScalar

Constructor Summary

Method Summary

Methods inherited from class mikera.arrayz.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.arrayz.INDArray

Constructor Detail

AScalar

Method Detail

get

set

setElements

dimensionality

slice

sliceCount

getSlices

iterator

isMutable

isFullyMutable

isElementConstrained

add

sub

add

add

sub

sub

innerProduct

outerProduct

get

set

getShape

getLongShape

elementCount

asVector

reshape

applyOp

applyOp

clone

multiply

broadcast

equals

equals

equals

hashCode

toString

exactClone