mikera.vectorz.impl

Class JoinedVector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.JoinedVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, IVector

public final class JoinedVector
extends AVector

A vector that represents the concatenation of two vectors.

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(AVector a, int aOffset) Adds part another vector to this one, starting at the specified offset in the source vector
void	add(double constant)
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	add(JoinedVector a)
void	addAt(int i, double v)
void	addMultiple(AVector a, double factor) Adds a scaled multiple of another vector to this one
void	addMultiple(AVector a, int aOffset, double factor)
void	addMultiple(JoinedVector a, 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	addToArray(int offset, double[] array, int arrayOffset, int length)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
void	copyTo(AVector dest, int offset) Copies a the contents of a vector to a vector at the specified offset
void	copyTo(double[] data, int offset) Copies a the contents of a vector to a double array at the specified offset
void	copyTo(int start, AVector dest, int destOffset, int length) Copies a subset of this vector to a vector at the specified offset
int	depth()
static int	depthCalc(AVector v)
void	divideTo(double[] data, int offset)
double	dotProduct(AVector v)
double	dotProduct(JoinedVector jv)
double	elementSum() Returns the sum of all elements in a vector
JoinedVector	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)
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.
static AVector	joinVectors(AVector left, AVector right) returns a JoinedVector connecting the two vectors
int	length()
void	multiply(double value) Multiplies the vector by a constant factor
void	multiplyTo(double[] data, int offset)
void	scaleAdd(double factor, double constant)
void	set(AVector src) Sets the vector to equal the value of another vector
void	set(AVector src, int srcOffset) Set the vector equal to an offset into another vector
void	set(int i, double value)
void	setElements(double[] values, int offset, int length)
void	signum() Sets each component of the vector to its sign value (-1, 0 or 1)
void	square()
AVector	subVector(int start, int length) Obtains a sub-vector that refers to this vector.

Methods inherited from class mikera.vectorz.AVector

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

Methods inherited from class mikera.arrayz.AbstractArray

get, get, scale, set, set, setElements

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

get, get, scale, set, set, setElements

Method Detail

joinVectors

public static AVector joinVectors(AVector left,
                  AVector right)

returns a JoinedVector connecting the two vectors

Parameters:

left -

right -

Returns:

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:

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

addToArray

public void addToArray(int offset,
              double[] array,
              int arrayOffset,
              int length)

Overrides:

addToArray in class AVector

addMultipleToArray

public void addMultipleToArray(double factor,
                      int offset,
                      double[] array,
                      int arrayOffset,
                      int length)

Overrides:

addMultipleToArray in class AVector

addAt

public void addAt(int i,
         double v)

Overrides:

addAt in class AVector

copyTo

public void copyTo(double[] data,
          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[] data,
              int offset)

Overrides:

multiplyTo in class AVector

divideTo

public void divideTo(double[] data,
            int offset)

Overrides:

divideTo in class AVector

copyTo

public void copyTo(int start,
          AVector dest,
          int destOffset,
          int length)

Description copied from class: AVector

Copies a subset of this vector to a vector at the specified offset

Overrides:

copyTo in class AVector

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

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

scaleAdd

public void scaleAdd(double factor,
            double constant)

Overrides:

scaleAdd in class AVector

add

public void add(double constant)

Overrides:

add in class AVector

dotProduct

public double dotProduct(AVector v)

Overrides:

dotProduct in class AVector

dotProduct

public double dotProduct(JoinedVector jv)

add

public void add(AVector a,
       int aOffset)

Description copied from class: AVector

Adds part another vector to this one, starting at the specified offset in the source vector

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

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(JoinedVector a,
               double factor)

addMultiple

public void addMultiple(AVector a,
               int aOffset,
               double factor)

Overrides:

addMultiple in class AVector

addProduct

public void addProduct(AVector a,
              AVector b,
              double factor)

Overrides:

addProduct in class AVector

addProduct

public void addProduct(AVector a,
              int aOffset,
              AVector b,
              int bOffset,
              double factor)

Overrides:

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

Overrides:

signum in class AVector

abs

public void abs()

Description copied from class: AVector

Sets each component of the vector to its absolute value

Overrides:

abs 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

elementSum

public double elementSum()

Description copied from class: AVector

Returns the sum of all elements in a vector

Overrides:

elementSum in class AVector

Returns:

get

public double get(int i)

Specified by:

get in interface INDArray

Specified by:

get in interface IVector

Specified by:

get in class AVector

set

public void set(AVector src)

Description copied from class: AVector

Sets the vector to equal the value of another vector

Overrides:

set in class AVector

set

public void set(AVector src,
       int srcOffset)

Description copied from class: AVector

Set the vector equal to an offset into another vector

Overrides:

set in class AVector

setElements

public void setElements(double[] values,
               int offset,
               int length)

Specified by:

setElements in interface INDArray

Overrides:

setElements 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

fill

public void fill(double value)

Description copied from class: AVector

Fills the entire vector with a given value

Overrides:

fill in class AVector

square

public void square()

Overrides:

square 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

depthCalc

public static int depthCalc(AVector v)

depth

public int depth()

exactClone

public JoinedVector 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: