mikera.vectorz.impl

Class WrappedScalarVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.AWrappedVector<AScalar>

mikera.vectorz.impl.WrappedScalarVector

All Implemented Interfaces:

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

public class WrappedScalarVector
extends AWrappedVector<AScalar>

A length 1 vector, as a view wrapping a single AScalar Main purpose is to provide an efficient view for AScalar.asVector()

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
AScalar	scalar

Fields inherited from class mikera.vectorz.impl.ASizedVector

length

Constructor Summary

Constructors

Constructor and Description
WrappedScalarVector(AScalar s)

Method Summary

Modifier and Type	Method and Description
void	addAt(int i, double v) Adds a value to a specific element of the vector This function does not perform bounds checking, i.e.
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
int	componentCount() Returns the number of components of this array.
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
double	dotProduct(double[] data, int offset, int stride) Fast dot product with a double[] array and a stride.
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
double	elementSquaredSum() Returns the sum of squared elements in this array.
double	elementSum() Returns the sum of all elements in a vector
boolean	equalsArray(double[] data, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
WrappedScalarVector	exactClone() Returns an exact clone of this vector, i.e.
double	get(int i) Returns the double value at the specified position in a 1D vector
AScalar	getComponent(int k) Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isMutable() Returns true if this vector is mutable.
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
void	multiply(double factor) Multiplies the vector by a constant factor
void	set(int i, double value) Sets a value at a given position in a mutable 1D array
double	unsafeGet(int i)

Methods inherited from class mikera.vectorz.impl.ASizedVector

checkIndex, checkLength, checkRange, checkSameLength, checkSameLength, elementCount, equalsArray, get, getShape, getShapeClone, isSameShape, length, sliceCount

Methods inherited from class mikera.vectorz.AVector

abs, absCopy, add, add, add, add, add, add, add, add, add, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleToArray, addMultipleToArray, addPower, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, checkDimension, checkSameLength, clamp, clampMax, clampMin, clone, compareTo, copy, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, elementAbsPowSum, elementIterator, elementPowSum, elementProduct, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, fill, fillRange, get, get, get, get, getElements, getElements, getElements, getLongShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isRangeZero, isSameShape, isUnitLengthVector, isUnitLengthVector, isView, iterator, join, join, join, log, logistic, magnitude, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyCopy, multiplyTo, mutable, negate, negateCopy, nonSparseIndex, nonZeroCount, nonZeroIndices, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, selectView, set, set, set, set, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, shiftCopy, signum, slice, slice, sliceValue, softmax, softmaxCopy, sparse, sparseClone, sqrtCopy, square, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, subVector, tanh, toDoubleArray, toDoubleBuffer, toList, toNormal, toSliceArray, toString, toStringFull, toVector, tryEfficientJoin, unsafeSet, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, addInnerProduct, addInnerProduct, addOuterProduct, broadcastCloneLike, broadcastCopyLike, checkMutable, density, ensureMutable, exp, get, get, get, getComponents, getElements, getElements, getSlices, getSliceViews, isDense, isSparse, reciprocal, reciprocalCopy, scale, set, set, signumCopy, sqrt, sub, sub, toArray, withComponents

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

addOuterProduct, broadcastCloneLike, broadcastCopyLike, checkMutable, ensureMutable, exp, get, get, get, getComponents, getElements, getElements, getSlices, getSliceViews, isDense, isSparse, reciprocal, reciprocalCopy, scale, set, set, signumCopy, sqrt, sub, toArray, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

scalar

public final AScalar scalar

Constructor Detail

WrappedScalarVector

public WrappedScalarVector(AScalar s)

Method Detail

isMutable

public boolean isMutable()

Description copied from class: AVector

Returns true if this vector is mutable.

Specified by:

isMutable in interface INDArray

Overrides:

isMutable in class AVector

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

componentCount

public int componentCount()

Description copied from interface: INDArray

Returns the number of components of this array. May return 0 if components are not supported

Specified by:

componentCount in interface INDArray

Overrides:

componentCount in class AbstractArray<Double>

Returns:

getComponent

public AScalar getComponent(int k)

Description copied from interface: INDArray

Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k

Specified by:

getComponent in interface INDArray

Overrides:

getComponent in class AbstractArray<Double>

Returns:

multiply

public void multiply(double factor)

Description copied from class: AVector

Multiplies the vector by a constant factor

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AVector

Parameters:

factor - Factor by which to multiply each component of the vector

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

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<Double>

isZero

public boolean isZero()

Description copied from class: AVector

Returns true if this vector is a zero vector (all components zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AVector

unsafeGet

public double unsafeGet(int i)

Overrides:

unsafeGet in class AVector

set

public void set(int i,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 1D array

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Specified by:

set 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

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AVector

elementSquaredSum

public 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 AVector

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 AVector

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 AVector

dotProduct

public double dotProduct(double[] data,
                         int offset)

Description copied from class: AVector

Fast dot product with a double[] array. Performs no bounds checking. Likely to be faster than most other dot product operations

Specified by:

dotProduct in class AVector

exactClone

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

A clone of the original array

addAt

public void addAt(int i,
                  double v)

Description copied from class: AVector

Adds a value to a specific element of the vector This function does not perform bounds checking, i.e. is an unsafe operation

Overrides:

addAt in class AVector

dotProduct

public double dotProduct(double[] data,
                         int offset,
                         int stride)

Description copied from class: AVector

Fast dot product with a double[] array and a stride. Performs no bounds checking. Likely to be faster than other dot product operations

Overrides:

dotProduct in class AVector

equalsArray

public boolean equalsArray(double[] data,
                           int offset)

Description copied from class: AVector

Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset

Specified by:

equalsArray in interface INDArray

Overrides:

equalsArray in class ASizedVector

Parameters:

data - Array of double element values to check for equality

offset - Offset into the data array

Returns: