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

Class FunctionVectorStorage

java.lang.Object

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

All Implemented Interfaces:

Externalizable, Serializable, Destroyable, StorageOpsMetrics, VectorStorage

public class FunctionVectorStorage
extends Object
implements VectorStorage

Read-only or read-write function-based vector storage.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FunctionVectorStorage()
FunctionVectorStorage(int size, IgniteFunction<Integer,Double> getFunc) Creates read-only storage.
FunctionVectorStorage(int size, IgniteFunction<Integer,Double> getFunc, IntDoubleToVoidFunction setFunc) Creates read-only or read-write storage.

Method Summary

Modifier and Type	Method and Description
double	get(int i)
IgniteFunction<Integer,Double>	getFunction()
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)
IntDoubleToVoidFunction	setFunction()
int	size()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

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

data

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

destroy

Constructor Detail

FunctionVectorStorage

public FunctionVectorStorage()

FunctionVectorStorage

public FunctionVectorStorage(int size,
                             IgniteFunction<Integer,Double> getFunc,
                             IntDoubleToVoidFunction setFunc)

Creates read-only or read-write storage.

Parameters:

size - Cardinality of this vector storage.

getFunc - Get function.

setFunc - Optional set function (null for read-only storage).

FunctionVectorStorage

public FunctionVectorStorage(int size,
                             IgniteFunction<Integer,Double> getFunc)

Creates read-only storage.

Parameters:

size - Cardinality of this vector storage.

getFunc - Get function.

Method Detail

getFunction

public IgniteFunction<Integer,Double> getFunction()

Returns:

Getter function.

setFunction

public IntDoubleToVoidFunction setFunction()

Returns:

Setter function.

size

public int size()

Specified by:

size in interface VectorStorage

get

public double get(int i)

Specified by:

get in interface VectorStorage

Parameters:

i - Vector element index.

Returns:

Value obtained for given element index.

set

public void set(int i,
                double v)

Specified by:

set in interface VectorStorage

Parameters:

i - Vector element index.

v - Value to set at given index.

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