JoinedArrayVector (vectorz 0.22.0 API)

java.lang.Object
- mikera.arrayz.impl.AbstractArray<Double>
- - mikera.vectorz.AVector
  - - mikera.vectorz.impl.JoinedArrayVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, IVector
```
public final class JoinedArrayVector
extends AVector
```
Class representing a join of one or more array subvectors

Author:

Mike

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abs()` Sets each component of the vector to its absolute value
`void`	`add(AVector a)` Adds another vector to this one
`void`	`add(double value)` Adds a double value to all elements in this array
`void`	`add(int offset, AVector a)` Adds another vector into this one, at the specified offset
`void`	`add(int offset, AVector a, int aOffset, int length)` Adds another vector into this one, at the specified offset
`void`	`addAt(int i, double value)` Adds a value to a specific element of the vector This function does not perform bounds checking
`void`	`addMultiple(AVector a, double factor)` Adds a scaled multiple of another vector to this one
`void`	`addMultiple(int offset, AVector a, double factor)`
`void`	`addMultiple(int offset, AVector a, int aOffset, int length, double factor)`
`void`	`addMultipleToArray(double factor, int offset, double[] array, int arrayOffset, int length)`
`void`	`addProduct(AVector a, AVector b, double factor)`
`void`	`addProduct(AVector a, int aOffset, AVector b, int bOffset, double factor)`
`void`	`applyOp(Op op)` Applies a unary operator to all elements of the array (in-place)
`void`	`clamp(double min, double max)` Clamps all values in the vector to a given range
`void`	`copyTo(AVector dest, int offset)` Copies a the contents of a vector to a vector at the specified offset
`void`	`copyTo(double[] destArray, int offset)` Copies a the contents of a vector to a double array at the specified offset
`static JoinedArrayVector`	`create(AVector v)`
`void`	`divideTo(double[] target, int offset)`
`double`	`dotProduct(AArrayVector v)`
`double`	`dotProduct(AVector v)`
`double`	`dotProduct(double[] arr, int offset)` Fast dot product with a double[] array.
`double`	`elementSum()` Returns the sum of all elements in a vector
`JoinedArrayVector`	`exactClone()` Returns an exact clone of this vector, i.e.
`void`	`exp()` Computes the function e^x (in-place) for all array elements
`void`	`fill(double value)` Fills the entire vector with a given value
`double`	`get(int i)` Returns the double value at the specified position in a 1D vector
`boolean`	`isFullyMutable()` Returns true if this vector is fully mutable, i.e.
`boolean`	`isView()` Returns true if this vector is of a view type that references other vectors / data.
`JoinedArrayVector`	`join(AArrayVector v)`
`AVector`	`join(AVector v)` Returns a new vector that refers to this vector joined to a second vector
`JoinedArrayVector`	`join(JoinedArrayVector v)`
`static AVector`	`joinVectors(AArrayVector a, AArrayVector b)`
`static JoinedArrayVector`	`joinVectors(JoinedArrayVector a, JoinedArrayVector b)`
`int`	`length()`
`void`	`log()` Computes the natural logarithm (in-place) for all array elements
`void`	`logistic()`
`void`	`multiply(double value)` Multiplies the vector by a constant factor
`void`	`multiplyTo(double[] target, int offset)`
`void`	`negate()` Negates all elements in the array
`long`	`nonZeroCount()` Returns the number of non-zero elements in the array.
`int`	`numArrays()`
`void`	`reciprocal()` Replaces all elements in the array with their reciprocal
`void`	`scaleAdd(double factor, double constant)` Scales all elements of the array by a given double value and adds a constant vale
`void`	`set(AVector v)` Sets the vector to equal the value of another vector
`void`	`set(int i, double value)`
`void`	`setElements(double[] values, int offset, int length)` Sets all elements in an array using the given double values
`void`	`signum()` Sets each component of the vector to its sign value (-1, 0 or 1)
`void`	`sqrt()` Computes the square root of all elements in the array
`void`	`square()` Squares all elements of the vector
`AVector`	`subVector(int start, int length)` Obtains a sub-vector that refers to this vector.
`void`	`tanh()`
`List<AArrayVector>`	`toSubArrays()`
`double`	`unsafeGet(int i)`
`void`	`unsafeSet(int i, double value)`
`void`	`validate()` Validates the internal data structure of the INDArray.
`static JoinedArrayVector`	`wrap(AArrayVector v)`

Methods inherited from class mikera.vectorz.AVector
add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addProduct, addProductToArray, addProductToArray, addToArray, addToArray, addWeighted, angle, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, clampMax, clampMin, clone, compareTo, copyTo, copyTo, copyTo, copyTo, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, dotProduct, dotProduct, elementCount, elementIterator, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fillRange, get, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isMutable, isSameShape, isSameShape, isUnitLengthVector, isZero, iterator, magnitude, magnitudeSquared, maxAbsElement, multiply, multiply, multiply, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, setElements, setRange, setValues, slice, slice, sliceCount, sub, sub, sub, subMultiple, toDoubleArray, toDoubleBuffer, toList, toNormal, toString, toVector, zeroCount

Methods inherited from class mikera.arrayz.impl.AbstractArray
broadcastCloneLike, ensureMutable, get, getSliceViews, isBoolean, scale, set, set, toArray

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

Methods inherited from interface mikera.arrayz.INDArray
broadcastCloneLike, ensureMutable, get, getSliceViews, isBoolean, scale, set, set, toArray

- Method Detail
  - create
```
public static final JoinedArrayVector create(AVector v)
```
  - wrap
```
public static JoinedArrayVector wrap(AArrayVector v)
```
  - numArrays
```
public int numArrays()
```
  - toSubArrays
```
public List<AArrayVector> toSubArrays()
```
  - length
```
public int length()
```
    Specified by:
    
    length in interface IVector
    
    Specified by:
    
    length in class AVector
  - isView
```
public boolean isView()
```
    Description copied from class: AVector
    
    Returns true if this vector is of a view type that references other vectors / data.
    
    Specified by:
    
    isView in interface INDArray
    
    Overrides:
    
    isView in class AVector
    
    Returns:
  - isFullyMutable
```
public boolean isFullyMutable()
```
    Description copied from class: AVector
    
    Returns true if this vector is fully mutable, i.e. can contain any unconstrained double values
    
    Specified by:
    
    isFullyMutable in interface INDArray
    
    Overrides:
    
    isFullyMutable in class AVector
    
    Returns:
  - get
```
public double get(int i)
```
    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 interface IVector
    
    Specified by:
    
    get in class AVector
    
    Returns:
  - unsafeGet
```
public double unsafeGet(int i)
```
    Overrides:
    
    unsafeGet in class AVector
  - set
```
public void set(int i,
       double value)
```
    Specified by:
    
    set in interface INDArray
    
    Specified by:
    
    set in interface IVector
    
    Specified by:
    
    set in class AVector
  - unsafeSet
```
public void unsafeSet(int i,
             double value)
```
    Overrides:
    
    unsafeSet in class AVector
  - addAt
```
public void addAt(int i,
         double value)
```
    Description copied from class: AVector
    
    Adds a value to a specific element of the vector This function does not perform bounds checking
    
    Overrides:
    
    addAt in class AVector
  - copyTo
```
public void copyTo(AVector dest,
          int offset)
```
    Description copied from class: AVector
    
    Copies a the contents of a vector to a vector at the specified offset
    
    Overrides:
    
    copyTo in class AVector
  - elementSum
```
public double elementSum()
```
    Description copied from class: AVector
    
    Returns the sum of all elements in a vector
    
    Specified by:
    
    elementSum in interface INDArray
    
    Overrides:
    
    elementSum in class AVector
    
    Returns:
  - 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 AVector
    
    Returns:
  - dotProduct
```
public double dotProduct(AVector v)
```
    Overrides:
    
    dotProduct in class AVector
  - dotProduct
```
public double dotProduct(AArrayVector v)
```
  - dotProduct
```
public double dotProduct(double[] arr,
                int offset)
```
    Description copied from class: AVector
    
    Fast dot product with a double[] array.
    
    Overrides:
    
    dotProduct in class AVector
    
    Returns:
  - add
```
public void add(AVector a)
```
    Description copied from class: AVector
    
    Adds another vector to this one
    
    Overrides:
    
    add in class AVector
  - add
```
public void add(int offset,
       AVector a)
```
    Description copied from class: AVector
    
    Adds another vector into this one, at the specified offset
    
    Overrides:
    
    add in class AVector
  - add
```
public void add(int offset,
       AVector a,
       int aOffset,
       int length)
```
    Description copied from class: AVector
    
    Adds another vector into this one, at the specified offset
    
    Overrides:
    
    add in class AVector
  - addProduct
```
public void addProduct(AVector a,
              AVector b,
              double factor)
```
    Overrides:
    
    addProduct in class AVector
  - addMultiple
```
public void addMultiple(AVector a,
               double factor)
```
    Description copied from class: AVector
    
    Adds a scaled multiple of another vector to this one
    
    Overrides:
    
    addMultiple in class AVector
  - addMultiple
```
public void addMultiple(int offset,
               AVector a,
               double factor)
```
    Overrides:
    
    addMultiple in class AVector
  - addMultiple
```
public void addMultiple(int offset,
               AVector a,
               int aOffset,
               int length,
               double factor)
```
    Overrides:
    
    addMultiple in class AVector
  - addMultipleToArray
```
public void addMultipleToArray(double factor,
                      int offset,
                      double[] array,
                      int arrayOffset,
                      int length)
```
    Overrides:
    
    addMultipleToArray in class AVector
  - addProduct
```
public void addProduct(AVector a,
              int aOffset,
              AVector b,
              int bOffset,
              double factor)
```
    Overrides:
    
    addProduct in class AVector
  - 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 AVector
  - copyTo
```
public void copyTo(double[] destArray,
          int offset)
```
    Description copied from class: AVector
    
    Copies a the contents of a vector to a double array at the specified offset
    
    Overrides:
    
    copyTo in class AVector
  - multiplyTo
```
public void multiplyTo(double[] target,
              int offset)
```
    Overrides:
    
    multiplyTo in class AVector
  - divideTo
```
public void divideTo(double[] target,
            int offset)
```
    Overrides:
    
    divideTo in class AVector
  - fill
```
public void fill(double value)
```
    Description copied from class: AVector
    
    Fills the entire vector with a given value
    
    Specified by:
    
    fill in interface INDArray
    
    Overrides:
    
    fill in class AVector
  - set
```
public void set(AVector v)
```
    Description copied from class: AVector
    
    Sets the vector to equal the value of another vector
    
    Overrides:
    
    set in class AVector
  - 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
    
    Specified by:
    
    setElements in interface INDArray
    
    Overrides:
    
    setElements in class AVector
  - multiply
```
public void multiply(double value)
```
    Description copied from class: AVector
    
    Multiplies the vector by a constant factor
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class AVector
    
    Parameters:
    value - Factor by which to multiply each component of the vector
  - 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
    
    Overrides:
    
    scaleAdd in class AVector
  - clamp
```
public void clamp(double min,
         double max)
```
    Description copied from class: AVector
    
    Clamps all values in the vector to a given range
    
    Specified by:
    
    clamp in interface INDArray
    
    Overrides:
    
    clamp in class AVector
  - reciprocal
```
public void reciprocal()
```
    Description copied from interface: INDArray
    
    Replaces all elements in the array with their reciprocal
    
    Specified by:
    
    reciprocal in interface INDArray
    
    Overrides:
    
    reciprocal in class AbstractArray<Double>
  - add
```
public void add(double value)
```
    Description copied from interface: INDArray
    
    Adds a double value to all elements in this array
    
    Specified by:
    
    add in interface INDArray
    
    Overrides:
    
    add in class AVector
  - abs
```
public void abs()
```
    Description copied from class: AVector
    
    Sets each component of the vector to its absolute value
    
    Specified by:
    
    abs in interface INDArray
    
    Overrides:
    
    abs in class AVector
  - 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
    
    Overrides:
    
    exp in class AbstractArray<Double>
  - 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
    
    Overrides:
    
    log in class AVector
  - signum
```
public void signum()
```
    Description copied from class: AVector
    
    Sets each component of the vector to its sign value (-1, 0 or 1)
    
    Specified by:
    
    signum in interface INDArray
    
    Overrides:
    
    signum in class AVector
  - square
```
public void square()
```
    Description copied from class: AVector
    
    Squares all elements of the vector
    
    Specified by:
    
    square in interface INDArray
    
    Overrides:
    
    square in class AVector
  - tanh
```
public void tanh()
```
    Overrides:
    
    tanh in class AVector
  - logistic
```
public void logistic()
```
    Overrides:
    
    logistic in class AVector
  - 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
    
    Overrides:
    
    sqrt in class AbstractArray<Double>
  - negate
```
public void negate()
```
    Description copied from interface: INDArray
    
    Negates all elements in the array
    
    Specified by:
    
    negate in interface INDArray
    
    Overrides:
    
    negate in class AVector
  - exactClone
```
public JoinedArrayVector exactClone()
```
    Description copied from class: AVector
    
    Returns an exact clone of this vector, i.e. of the same type
    
    Specified by:
    
    exactClone in interface INDArray
    
    Specified by:
    
    exactClone in class AVector
    
    Returns:
  - subVector
```
public AVector subVector(int start,
                int length)
```
    Description copied from class: AVector
    
    Obtains a sub-vector that refers to this vector. Changes to the sub-vector will be reflected in this vector
    
    Overrides:
    
    subVector in class AVector
  - join
```
public AVector join(AVector v)
```
    Description copied from class: AVector
    
    Returns a new vector that refers to this vector joined to a second vector
    
    Overrides:
    
    join in class AVector
    
    Returns:
  - join
```
public JoinedArrayVector join(AArrayVector v)
```
  - join
```
public JoinedArrayVector join(JoinedArrayVector v)
```
  - joinVectors
```
public static JoinedArrayVector joinVectors(JoinedArrayVector a,
                            JoinedArrayVector b)
```
  - joinVectors
```
public static AVector joinVectors(AArrayVector a,
                  AArrayVector b)
```
  - 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 AVector

Class JoinedArrayVector

Method Summary

Methods inherited from class mikera.vectorz.AVector

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.arrayz.INDArray

Method Detail

create

wrap

numArrays

toSubArrays

length

isView

isFullyMutable

get

unsafeGet

set

unsafeSet

addAt

copyTo

elementSum

nonZeroCount

dotProduct

dotProduct

dotProduct

add

add

add

addProduct

addMultiple

addMultiple

addMultiple

addMultipleToArray

addProduct

applyOp

copyTo

multiplyTo

divideTo

fill

set

setElements

multiply

scaleAdd

clamp

reciprocal

add

abs

exp

log

signum

square

tanh

logistic

sqrt

negate

exactClone

subVector

join

join

join

joinVectors

joinVectors

validate