mikera.vectorz.impl

Class JoinedArrayVector

java.lang.Object

mikera.arrayz.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	add(AVector a) Adds another vector to this one
void	add(double value)
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)
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(ArrayVector v)
double	dotProduct(AVector v)
double	elementSum() Returns the sum of all elements in a vector
JoinedArrayVector	exactClone() Returns an exact clone of this vector, i.e.
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(ArrayVector 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(ArrayVector a, ArrayVector b)
static JoinedArrayVector	joinVectors(JoinedArrayVector a, JoinedArrayVector b)
int	length()
void	multiply(double value) Multiplies the vector by a constant factor
void	multiplyTo(double[] target, int offset)
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	numArrays()
void	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	square() Squares all elements of the vector
AVector	subVector(int start, int length) Obtains a sub-vector that refers to this vector.
List<ArrayVector>	toSubArrays()
void	validate() Validates the internal data structure of the INDArray.
static JoinedArrayVector	wrap(ArrayVector v)

Methods inherited from class mikera.vectorz.AVector

abs, add, add, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addProduct, addProductToArray, addProductToArray, addToArray, addToArray, addWeighted, angle, applyOp, asElementList, asVector, broadcast, clampMax, clampMin, clone, compareTo, copyTo, copyTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, dotProduct, elementCount, elementSquaredSum, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fillRange, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isMutable, isUnitLengthVector, isZeroVector, iterator, magnitude, magnitudeSquared, maxAbsElement, multiply, multiply, multiply, negate, normalise, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, setValues, signum, slice, slice, sliceCount, sub, sub, sub, subMultiple, toArray, toDoubleBuffer, toList, toString

Methods inherited from class mikera.arrayz.AbstractArray

epsilonEquals, epsilonEquals, get, get, getSliceViews, scale, set, set, setElements, toVector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

epsilonEquals, epsilonEquals, get, get, getSliceViews, scale, set, set, setElements, toVector

Method Detail

create

public static final JoinedArrayVector create(AVector v)

wrap

public static JoinedArrayVector wrap(ArrayVector v)

numArrays

public int numArrays()

toSubArrays

public List<ArrayVector> 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:

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

addAt

public void addAt(int i,
         double value)

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(ArrayVector v)

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

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()

Specified by:

reciprocal in interface INDArray

Overrides:

reciprocal in class AbstractArray<Double>

add

public void add(double value)

Specified by:

add in interface INDArray

Overrides:

add 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

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(ArrayVector v)

join

public JoinedArrayVector join(JoinedArrayVector v)

joinVectors

public static JoinedArrayVector joinVectors(JoinedArrayVector a,
                            JoinedArrayVector b)

joinVectors

public static AVector joinVectors(ArrayVector a,
                  ArrayVector 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