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

Class SparseDistributedMatrixStorage

java.lang.Object

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

org.apache.ignite.ml.math.impls.storage.matrix.SparseDistributedMatrixStorage

All Implemented Interfaces:

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

public class SparseDistributedMatrixStorage
extends CacheUtils
implements MatrixStorage, StorageConstants, DistributedStorage<RowColMatrixKey>

MatrixStorage implementation for SparseDistributedMatrix.

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
SparseDistributedMatrixStorage()
SparseDistributedMatrixStorage(int rows, int cols, int stoMode, int acsMode)

Method Summary

Modifier and Type	Method and Description
int	accessMode()
IgniteCache<RowColMatrixKey,Map<Integer,Double>>	cache()
String	cacheName()
int	columnSize()
void	destroy() Delete all data from cache.
boolean	equals(Object obj)
double	get(int x, int y)
Set<RowColMatrixKey>	getAllKeys() Build a keyset for this storage.
RowColMatrixKey	getCacheKey(int idx) Build cache key for row/column.
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)
int	rowSize()
void	set(int x, int y, double v)
int	storageMode()
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.MatrixStorage

data

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

assertAccessMode, assertStorageMode

Constructor Detail

SparseDistributedMatrixStorage

public SparseDistributedMatrixStorage()

SparseDistributedMatrixStorage

public SparseDistributedMatrixStorage(int rows,
                                      int cols,
                                      int stoMode,
                                      int acsMode)

Parameters:

rows - Amount of rows in the matrix.

cols - Amount of columns in the matrix.

stoMode - Row or column based storage mode.

acsMode - Random or sequential access mode.

Method Detail

cache

public IgniteCache<RowColMatrixKey,Map<Integer,Double>> cache()

accessMode

public int accessMode()

Specified by:

accessMode in interface MatrixStorage

Returns:

Matrix access mode.

See Also:

StorageConstants

get

public double get(int x,
                  int y)

Specified by:

get in interface MatrixStorage

Parameters:

x - Matrix row index.

y - Matrix column index.

Returns:

Value corresponding to given row and column.

set

public void set(int x,
                int y,
                double v)

Specified by:

set in interface MatrixStorage

Parameters:

x - Matrix row index.

y - Matrix column index.

v - Value to set at given row and column.

getCacheKey

public RowColMatrixKey getCacheKey(int idx)

Build cache key for row/column.

columnSize

public int columnSize()

Specified by:

columnSize in interface MatrixStorage

rowSize

public int rowSize()

Specified by:

rowSize in interface MatrixStorage

storageMode

public int storageMode()

Specified by:

storageMode in interface MatrixStorage

Returns:

Matrix elements storage mode.

See Also:

StorageConstants

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getUUID

public UUID getUUID()

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.