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

Class SparseDistributedVectorStorage

java.lang.Object

org.apache.ignite.ml.math.distributed.CacheUtils

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

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, DistributedStorage<RowColMatrixKey>, StorageConstants, StorageOpsMetrics, VectorStorage

public class SparseDistributedVectorStorage
extends CacheUtils
implements VectorStorage, StorageConstants, DistributedStorage<RowColMatrixKey>

VectorStorage implementation for SparseDistributedVector.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ignite.ml.math.distributed.CacheUtils

CacheUtils.CacheEntry<K,V>

Field Summary

Fields inherited from interface org.apache.ignite.ml.math.StorageConstants

COLUMN_STORAGE_MODE, RANDOM_ACCESS_MODE, ROW_STORAGE_MODE, SEQUENTIAL_ACCESS_MODE, UNKNOWN_STORAGE_MODE

Constructor Summary

Constructors

Constructor and Description
SparseDistributedVectorStorage()
SparseDistributedVectorStorage(int size, int acsMode)

Method Summary

Modifier and Type	Method and Description
int	accessMode() Gets access mode
IgniteCache<RowColMatrixKey,Double>	cache() Gets cache
String	cacheName()
double[]	data() Gets underlying array if StorageOpsMetrics.isArrayBased() returns true.
void	destroy() Delete all data from cache.
boolean	equals(Object obj)
double	get(int i) Gets vector element by element index
Set<RowColMatrixKey>	getAllKeys() Build a keyset for this storage.
RowColMatrixKey	getCacheKey(int idx) Builds cache key for vector element.
UUID	getUUID()
int	hashCode()
boolean	isArrayBased() Checks if implementation is based on Java arrays.
boolean	isDense() Checks if this implementation should be considered dense so that it explicitly represents every value.
boolean	isDistributed() Checks whether implementation is JVM-local or distributed (multi-JVM).
boolean	isRandomAccess() Checks if this implementation is optimized for random access.
boolean	isSequentialAccess() Checks if this implementation should be considered to be iterable in index order in an efficient way.
void	readExternal(ObjectInput in)
void	set(int i, double v) Sets vector element by index
int	size()
void	writeExternal(ObjectOutput out)

Methods inherited from class org.apache.ignite.ml.math.distributed.CacheUtils

bcast, bcast, bcast, bcast, distributedFold, fold, fold, foreach, getClusterGroupForGivenKey, ignite, map, max, min, reduce, reduce, sparseMap, sparseMapForVector, sparseMax, sparseMin, sparseSum, sum, update, update

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.StorageConstants

assertAccessMode, assertStorageMode

Constructor Detail

SparseDistributedVectorStorage

public SparseDistributedVectorStorage()

SparseDistributedVectorStorage

public SparseDistributedVectorStorage(int size,
                                      int acsMode)

Parameters:

size - Amount of elements in the vector.

acsMode - Random or sequential access mode.

Method Detail

cache

public IgniteCache<RowColMatrixKey,Double> cache()

Gets cache

Returns:

cache

accessMode

public int accessMode()

Gets access mode

Returns:

code of access mode

get

public double get(int i)

Gets vector element by element index

Specified by:

get in interface VectorStorage

Parameters:

i - Vector element index.

Returns:

vector element

set

public void set(int i,
                double v)

Sets vector element by index

Specified by:

set in interface VectorStorage

Parameters:

i - Vector element index.

v - Value to set at given index.

size

public int size()

Specified by:

size in interface VectorStorage

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

isSequentialAccess

public boolean isSequentialAccess()

Checks if this implementation should be considered to be iterable in index order in an efficient way.

Specified by:

isSequentialAccess in interface StorageOpsMetrics

isDense

public boolean isDense()

Checks if this implementation should be considered dense so that it explicitly represents every value.

Specified by:

isDense in interface StorageOpsMetrics

isRandomAccess

public boolean isRandomAccess()

Checks if this implementation is optimized for random access.

Specified by:

isRandomAccess in interface StorageOpsMetrics

isDistributed

public boolean isDistributed()

Checks whether implementation is JVM-local or distributed (multi-JVM).

Specified by:

isDistributed in interface StorageOpsMetrics

isArrayBased

public boolean isArrayBased()

Checks if implementation is based on Java arrays.

Specified by:

isArrayBased in interface StorageOpsMetrics

destroy

public void destroy()

Delete all data from cache.

Specified by:

destroy in interface Destroyable

getCacheKey

public RowColMatrixKey getCacheKey(int idx)

Builds cache key for vector element.

Parameters:

idx - Index.

Returns:

RowColMatrixKey.

getAllKeys

public Set<RowColMatrixKey> getAllKeys()

Build a keyset for this storage.

Specified by:

getAllKeys in interface DistributedStorage<RowColMatrixKey>

cacheName

public String cacheName()

Specified by:

cacheName in interface DistributedStorage<RowColMatrixKey>

Returns:

The name of cache used in this storage.

getUUID

public UUID getUUID()

data

public double[] data()

Gets underlying array if StorageOpsMetrics.isArrayBased() returns true. Returns null if in other cases.

Specified by:

data in interface VectorStorage

See Also:

StorageOpsMetrics.isArrayBased()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object