org.apache.ignite.ml.math.impls.vector

Class CacheVector<K,V>

java.lang.Object

org.apache.ignite.ml.math.impls.vector.AbstractVector

org.apache.ignite.ml.math.impls.vector.CacheVector<K,V>

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, MetaAttributes, StorageOpsMetrics, Vector

public class CacheVector<K,V>
extends AbstractVector

Vector based on existing cache and index and value mapping functions.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.ml.math.Vector

Vector.Element

Constructor Summary

Constructors

Constructor and Description
CacheVector()
CacheVector(int size, IgniteCache<K,V> cache, VectorKeyMapper<K> keyFunc, ValueMapper<V> valMapper) Creates new vector over existing cache.

Method Summary

Modifier and Type	Method and Description
Vector	assign(double val) Assigns given value to all elements of this vector.
Vector	divide(double x) Creates new vector containing values from this vector divided by the argument.
Vector	like(int crd) Creates new empty vector of the same underlying class but of different cardinality.
Matrix	likeMatrix(int rows, int cols) Creates new matrix of compatible flavor with given size.
Vector	map(IgniteBiFunction<Double,Double,Double> fun, double y) Maps all elements of this vector by applying given function to each element with a constant second parameter y.
Vector	map(IgniteDoubleFunction<Double> fun) Maps all values in this vector through a given function.
double	maxValue() Gets maximum value in this vector.
double	minValue() Gets minimal value in this vector.
Vector	plus(double x) Creates new vector containing sum of each element in this vector and argument.
double	sum() Gets the sum of all elements in this vector.
Vector	times(double x) Gets a new vector that contains product of each element and the argument.

Methods inherited from class org.apache.ignite.ml.math.impls.vector.AbstractVector

all, allSpliterator, assign, assign, assign, checkCardinality, checkCardinality, checkCardinality, checkIndex, compute, copy, cross, destroy, dot, dotSelf, equals, foldMap, foldMap, get, getDistanceSquared, getElement, getLengthSquared, getMetaStorage, getStorage, getX, guid, hashCode, increment, incrementX, isArrayBased, isDense, isDistributed, isRandomAccess, isSequentialAccess, isZero, kNorm, logNormalize, logNormalize, makeElement, map, maxElement, minElement, minus, nonZeroElements, nonZeroes, nonZeroSpliterator, normalize, normalize, plus, readExternal, set, setStorage, setX, size, sort, storageGet, storageSet, times, toMatrix, toMatrixPlusOne, viewPart, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.ignite.ml.math.MetaAttributes

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

CacheVector

public CacheVector()

CacheVector

public CacheVector(int size,
                   IgniteCache<K,V> cache,
                   VectorKeyMapper<K> keyFunc,
                   ValueMapper<V> valMapper)

Creates new vector over existing cache.

Parameters:

size - Vector size.

cache - Ignite cache.

keyFunc - VectorKeyMapper to validate cache key.

valMapper - ValueMapper to obtain value for given cache key.

Method Detail

minValue

public double minValue()

Gets minimal value in this vector.

Specified by:

minValue in interface Vector

Overrides:

minValue in class AbstractVector

Returns:

Minimal value.

maxValue

public double maxValue()

Gets maximum value in this vector.

Specified by:

maxValue in interface Vector

Overrides:

maxValue in class AbstractVector

Returns:

Maximum c.

map

public Vector map(IgniteDoubleFunction<Double> fun)

Maps all values in this vector through a given function.

Specified by:

map in interface Vector

Overrides:

map in class AbstractVector

Parameters:

fun - Mapping function.

Returns:

This vector.

map

public Vector map(IgniteBiFunction<Double,Double,Double> fun,
                  double y)

Maps all elements of this vector by applying given function to each element with a constant second parameter y.

Specified by:

map in interface Vector

Overrides:

map in class AbstractVector

Parameters:

fun - Mapping function.

y - Second parameter for mapping function.

Returns:

This vector.

sum

public double sum()

Gets the sum of all elements in this vector.

Specified by:

sum in interface Vector

Overrides:

sum in class AbstractVector

Returns:

Vector's sum

assign

public Vector assign(double val)

Assigns given value to all elements of this vector.

Specified by:

assign in interface Vector

Overrides:

assign in class AbstractVector

Parameters:

val - Value to assign.

Returns:

This vector.

plus

public Vector plus(double x)

Creates new vector containing sum of each element in this vector and argument.

Specified by:

plus in interface Vector

Overrides:

plus in class AbstractVector

Parameters:

x - Argument value.

Returns:

New vector.

divide

public Vector divide(double x)

Creates new vector containing values from this vector divided by the argument.

Specified by:

divide in interface Vector

Overrides:

divide in class AbstractVector

Parameters:

x - Division argument.

Returns:

New vector.

times

public Vector times(double x)

Gets a new vector that contains product of each element and the argument.

Specified by:

times in interface Vector

Overrides:

times in class AbstractVector

Parameters:

x - Multiply argument.

Returns:

New vector.

like

public Vector like(int crd)

Creates new empty vector of the same underlying class but of different cardinality.

Parameters:

crd - Cardinality for new vector.

Returns:

New vector.

likeMatrix

public Matrix likeMatrix(int rows,
                         int cols)

Creates new matrix of compatible flavor with given size.

Parameters:

rows - Number of rows.

cols - Number of columns.

Returns:

New matrix.