edu.ucla.sspace.util

Interface SparseNumericArray<T extends Number>

All Superinterfaces:

SparseArray<T>

All Known Implementing Classes:

SparseDoubleArray, SparseIntArray, SparseLongArray

public interface SparseNumericArray<T extends Number>
extends SparseArray<T>

A interface for array-like classes that use a sparse internal representation for numeric values. This interface exposes additional methods for manipulating the array values, which may offer performance improvements when compound operations are done in the internal reprentation. The exact details of performance are specified by the implementation themselves.

In addition, it is suggested that instances that wrap Java primitive-type arrays provide additional methods that operate directly on the primitive types rather than their object equivalents. This allows users to save any performance costs from auto-boxing the primitives.

Method Summary

Methods

Modifier and Type	Method and Description
T	add(int index, T delta) Adds the specified value to the value at the index and stores the result (just as array[index] += delta).
T	divide(int index, T value) Divides the specified value to the index by the provided value and stores the result at the index (just as array[index] /= value)
T	multiply(int index, T value) Multiplies the value to the index by the provided value and saves the result at the index (just as array[index] *= value)

Methods inherited from interface edu.ucla.sspace.util.SparseArray

cardinality, get, getElementIndices, length, set, toArray

Method Detail

add

T add(int index,
    T delta)

Adds the specified value to the value at the index and stores the result (just as array[index] += delta). Note that this can be used with negative delta values to achieve equivalent -= functionality.

Parameters:

index - the position in the array

delta - the change in value at the index

Returns:

the new value stored at the index

multiply

T multiply(int index,
         T value)

Multiplies the value to the index by the provided value and saves the result at the index (just as array[index] *= value)

Parameters:

index - the position in the array

delta - the change in value at the index

Returns:

the new value stored at the index

divide

T divide(int index,
       T value)

Divides the specified value to the index by the provided value and stores the result at the index (just as array[index] /= value)

Parameters:

index - the position in the array

delta - the change in value at the index

Returns:

the new value stored at the index