ShrinkingVector (Tribuo 4.0.2 API)

java.lang.Object
- org.tribuo.math.la.DenseVector
- - org.tribuo.math.optimisers.util.ShrinkingVector

All Implemented Interfaces:

Serializable, Iterable<VectorTuple>, SGDVector, Tensor, ShrinkingTensor
```
public class ShrinkingVector
extends DenseVector
implements ShrinkingTensor
```
A subclass of DenseVector which shrinks the value every time a new value is added.
Be careful when modifying this or DenseVector.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.tribuo.math.la.DenseVector
  elements
- Fields inherited from interface org.tribuo.math.optimisers.util.ShrinkingTensor
  tolerance

Constructor Summary

Constructors
Constructor and Description
`ShrinkingVector(DenseVector v, double baseRate, boolean scaleShrinking)`
`ShrinkingVector(DenseVector v, double baseRate, double lambda)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DenseVector`	`convertToDense()`
`ShrinkingVector`	`copy()` Returns a deep copy of this vector.
`double`	`dot(SGDVector other)` Calculates the dot product between this vector and `other`.
`double`	`get(int index)` Gets an element from this vector.
`int`	`indexOfMax()` Returns the index of the maximum value.
`void`	`intersectAndAddInPlace(Tensor other, DoubleUnaryOperator f)` Updates this `Tensor` by adding all the values from the intersection with `other`.
`VectorIterator`	`iterator()`
`double`	`maxValue()` Returns the maximum value.
`double`	`minValue()` Returns the minimum value.
`void`	`scaleInPlace(double value)` Scales each element of this `Tensor` by `coefficient`.
`double`	`sum()` Calculates the sum of this vector.
`double[]`	`toArray()` Generates a copy of the values in this DenseVector.
`double`	`twoNorm()` Calculates the euclidean norm for this vector.

Methods inherited from class org.tribuo.math.la.DenseVector
add, add, createDenseVector, equals, euclideanDistance, expNormalize, fill, foreachInPlace, getShape, hadamardProductInPlace, hashCode, l1Distance, normalize, numActiveElements, oneNorm, outer, reduce, reshape, scale, set, setElements, size, sparsify, sparsify, subtract, sum, toString, variance

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

Methods inherited from interface org.tribuo.math.la.SGDVector
cosineDistance, cosineSimilarity, l2Distance, variance

Methods inherited from interface org.tribuo.math.la.Tensor
hadamardProductInPlace, intersectAndAddInPlace, scalarAddInPlace, shapeCheck, shapeSum

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ShrinkingVector
```
public ShrinkingVector(DenseVector v,
                       double baseRate,
                       boolean scaleShrinking)
```
  - ShrinkingVector
```
public ShrinkingVector(DenseVector v,
                       double baseRate,
                       double lambda)
```
- Method Detail
  - convertToDense
```
public DenseVector convertToDense()
```
    Specified by:
    
    convertToDense in interface ShrinkingTensor
  - copy
```
public ShrinkingVector copy()
```
    Description copied from interface: SGDVector
    
    Returns a deep copy of this vector.
    
    Specified by:
    
    copy in interface SGDVector
    
    Overrides:
    
    copy in class DenseVector
    
    Returns:
    
    A copy of this vector.
  - toArray
```
public double[] toArray()
```
    Description copied from class: DenseVector
    
    Generates a copy of the values in this DenseVector.
    This implementation uses Arrays.copyOf, and should be overridden if the get function has been modified.
    
    Overrides:
    
    toArray in class DenseVector
    
    Returns:
    
    A copy of the values in this DenseVector.
  - get
```
public double get(int index)
```
    Description copied from interface: SGDVector
    
    Gets an element from this vector.
    
    Specified by:
    
    get in interface SGDVector
    
    Overrides:
    
    get in class DenseVector
    
    Parameters:
    
    index - The index of the element.
    
    Returns:
    
    The value at that index.
  - sum
```
public double sum()
```
    Description copied from interface: SGDVector
    
    Calculates the sum of this vector.
    
    Specified by:
    
    sum in interface SGDVector
    
    Overrides:
    
    sum in class DenseVector
    
    Returns:
    
    The sum.
  - intersectAndAddInPlace
```
public void intersectAndAddInPlace(Tensor other,
                                   DoubleUnaryOperator f)
```
    Description copied from interface: Tensor
    
    Updates this Tensor by adding all the values from the intersection with other.
    The function f is applied to all values from other before the addition.
    Each value is updated as value += f(otherValue).
    
    Specified by:
    
    intersectAndAddInPlace in interface Tensor
    
    Overrides:
    
    intersectAndAddInPlace in class DenseVector
    
    Parameters:
    
    other - The other Tensor.
    
    f - A function to apply.
  - indexOfMax
```
public int indexOfMax()
```
    Description copied from interface: SGDVector
    
    Returns the index of the maximum value. Requires probing the array.
    
    Specified by:
    
    indexOfMax in interface SGDVector
    
    Overrides:
    
    indexOfMax in class DenseVector
    
    Returns:
    
    The index of the maximum value.
  - dot
```
public double dot(SGDVector other)
```
    Description copied from interface: SGDVector
    
    Calculates the dot product between this vector and other.
    
    Specified by:
    
    dot in interface SGDVector
    
    Overrides:
    
    dot in class DenseVector
    
    Parameters:
    
    other - The other vector.
    
    Returns:
    
    The dot product.
  - scaleInPlace
```
public void scaleInPlace(double value)
```
    Description copied from interface: Tensor
    
    Scales each element of this Tensor by coefficient.
    
    Specified by:
    
    scaleInPlace in interface Tensor
    
    Parameters:
    
    value - The coefficient of scaling.
  - twoNorm
```
public double twoNorm()
```
    Description copied from interface: SGDVector
    
    Calculates the euclidean norm for this vector.
    
    Specified by:
    
    twoNorm in interface SGDVector
    
    Specified by:
    
    twoNorm in interface Tensor
    
    Overrides:
    
    twoNorm in class DenseVector
    
    Returns:
    
    The euclidean norm.
  - maxValue
```
public double maxValue()
```
    Description copied from interface: SGDVector
    
    Returns the maximum value. Requires probing the array.
    
    Specified by:
    
    maxValue in interface SGDVector
    
    Overrides:
    
    maxValue in class DenseVector
    
    Returns:
    
    The maximum value.
  - minValue
```
public double minValue()
```
    Description copied from interface: SGDVector
    
    Returns the minimum value. Requires probing the array.
    
    Specified by:
    
    minValue in interface SGDVector
    
    Overrides:
    
    minValue in class DenseVector
    
    Returns:
    
    The minimum value.
  - iterator
```
public VectorIterator iterator()
```
    Specified by:
    
    iterator in interface Iterable<VectorTuple>
    
    Overrides:
    
    iterator in class DenseVector

Class ShrinkingVector

Field Summary

Fields inherited from class org.tribuo.math.la.DenseVector

Fields inherited from interface org.tribuo.math.optimisers.util.ShrinkingTensor

Constructor Summary

Method Summary

Methods inherited from class org.tribuo.math.la.DenseVector

Methods inherited from class java.lang.Object

Methods inherited from interface org.tribuo.math.la.SGDVector

Methods inherited from interface org.tribuo.math.la.Tensor

Methods inherited from interface java.lang.Iterable

Constructor Detail

ShrinkingVector

ShrinkingVector

Method Detail

convertToDense

copy

toArray

get

sum

intersectAndAddInPlace

indexOfMax

dot

scaleInPlace

twoNorm

maxValue

minValue

iterator