org.ojalgo.array

Class SparseArray<N extends Number>

java.lang.Object

org.ojalgo.array.BasicArray<N>

org.ojalgo.array.SparseArray<N>

All Implemented Interfaces:

Serializable, Iterable<N>, Access1D<N>, Access1D.Elements, Access1D.IndexOf, Access1D.Visitable<N>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Modifiable<N>, Structure1D

public final class SparseArray<N extends Number>
extends BasicArray<N>

Only stores nonzero elements and/or elements specifically set by the user. The nonzero elements are stored internally in a DenseArray.

Author:

apete

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SparseArray.NonzeroView<N extends Number>
static class	SparseArray.SparseFactory<N extends Number>

Nested classes/interfaces inherited from class org.ojalgo.array.BasicArray

BasicArray.Factory<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.access.Access1D

Access1D.Aggregatable<N extends Number>, Access1D.Collectable<N extends Number,R extends Mutate1D.Receiver<N>>, Access1D.Elements, Access1D.ElementView<N extends Number>, Access1D.IndexOf, Access1D.Sliceable<N extends Number>, Access1D.Visitable<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.access.Mutate1D

Mutate1D.BiModifiable<N extends Number>, Mutate1D.Fillable<N extends Number>, Mutate1D.Mixable<N extends Number>, Mutate1D.Modifiable<N extends Number>, Mutate1D.Receiver<N extends Number>, Mutate1D.Sortable

Nested classes/interfaces inherited from interface org.ojalgo.access.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Method Summary

Modifier and Type	Method and Description
void	add(long index, double addend)
void	add(long index, Number addend)
void	axpy(double a, Mutate1D y) Will calculate y = y + a x, will add "a" times "this" to "y"
long	count()
long	countNonzeros()
long	countZeros()
double	dot(Access1D<?> vector) Will calculate and return the dot product of this 1D-structure and another input 1D-vector.
double	doubleValue(long index)
protected void	exchange(long firstA, long firstB, long step, long count)
static <N extends Number> SparseArray.SparseFactory<N>	factory(DenseArray.Factory<N> denseFactory, long count)
protected void	fill(long first, long limit, long step, N value)
protected void	fill(long first, long limit, long step, NullaryFunction<N> supplier)
void	fillAll(N value)
void	fillAll(NullaryFunction<N> supplier)
void	fillOne(long index, Access1D<?> values, long valueIndex)
void	fillOne(long index, N value)
void	fillOne(long index, NullaryFunction<N> supplier)
void	fillRange(long first, long limit, N value)
void	fillRange(long first, long limit, NullaryFunction<N> supplier)
long	firstInRange(long rangeFirst, long rangeLimit)
N	get(long index)
protected long	indexOfLargest(long first, long limit, long step)
boolean	isAbsolute(long index)
boolean	isSmall(long index, double comparedTo)
protected boolean	isSmall(long first, long limit, long step, double comparedTo)
long	limitOfRange(long rangeFirst, long rangeLimit)
protected void	modify(long first, long limit, long step, Access1D<N> left, BinaryFunction<N> function)
protected void	modify(long first, long limit, long step, BinaryFunction<N> function, Access1D<N> right)
protected void	modify(long first, long limit, long step, UnaryFunction<N> function)
void	modifyAll(UnaryFunction<N> modifier)
void	modifyOne(long index, UnaryFunction<N> modifier)
SparseArray.NonzeroView<N>	nonzeros()
void	reset() Reset this mutable structure to some standard (all zeros) initial state.
void	set(long index, double value)
void	set(long index, Number value)
void	supplyNonZerosTo(Mutate1D consumer)
protected void	visit(long first, long limit, long step, VoidFunction<N> visitor)
void	visitOne(long index, VoidFunction<N> visitor)

Methods inherited from class org.ojalgo.array.BasicArray

factory, indexOfLargest, indexOfLargestInRange, makeDecreasingRange, makeDecreasingRange, makeIncreasingRange, makeIncreasingRange, modifyRange, toString, visitAll, visitRange, wrapInArray1D, wrapInArray2D, wrapInArrayAnyD

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.access.Access1D

asCollectable1D, asPrimitive1D, elements, equals, hashCode, iterator, stream, supplyTo, toRawCopy1D, wrap, wrap, wrap, wrapAccess1D, wrapAccess1D, wrapAccess1D

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.ojalgo.access.Access1D.Elements

isAllSmall

Methods inherited from interface org.ojalgo.access.Mutate1D.Fillable

fillMatching, fillMatching, fillMatching

Methods inherited from interface org.ojalgo.access.Structure1D

loopAll, loopMatching, loopRange, mapper

Method Detail

factory

public static <N extends Number> SparseArray.SparseFactory<N> factory(DenseArray.Factory<N> denseFactory,
                                                                      long count)

add

public void add(long index,
                double addend)

add

public void add(long index,
                Number addend)

axpy

public void axpy(double a,
                 Mutate1D y)

Description copied from interface: Access1D

Will calculate y = y + a x, will add "a" times "this" to "y"

Parameters:

a - The scale

y - The "vector" to update

count

public final long count()

Returns:

The total number of elements in this structure.

countNonzeros

public final long countNonzeros()

countZeros

public final long countZeros()

dot

public double dot(Access1D<?> vector)

Description copied from interface: Access1D

Will calculate and return the dot product of this 1D-structure and another input 1D-vector.

Parameters:

vector - Another 1D-structure

Returns:

The dot product

doubleValue

public double doubleValue(long index)

fillAll

public void fillAll(N value)

fillAll

public void fillAll(NullaryFunction<N> supplier)

fillOne

public void fillOne(long index,
                    Access1D<?> values,
                    long valueIndex)

fillOne

public void fillOne(long index,
                    N value)

fillOne

public void fillOne(long index,
                    NullaryFunction<N> supplier)

fillRange

public void fillRange(long first,
                      long limit,
                      N value)

fillRange

public void fillRange(long first,
                      long limit,
                      NullaryFunction<N> supplier)

firstInRange

public long firstInRange(long rangeFirst,
                         long rangeLimit)

get

public N get(long index)

isAbsolute

public boolean isAbsolute(long index)

See Also:

Scalar.isAbsolute()

isSmall

public boolean isSmall(long index,
                       double comparedTo)

See Also:

NormedVectorSpace.isSmall(double)

limitOfRange

public long limitOfRange(long rangeFirst,
                         long rangeLimit)

modifyAll

public void modifyAll(UnaryFunction<N> modifier)

Specified by:

modifyAll in interface Mutate1D.Modifiable<N extends Number>

Overrides:

modifyAll in class BasicArray<N extends Number>

modifyOne

public void modifyOne(long index,
                      UnaryFunction<N> modifier)

nonzeros

public SparseArray.NonzeroView<N> nonzeros()

reset

public void reset()

Description copied from interface: Mutate1D

Reset this mutable structure to some standard (all zeros) initial state. It must still be usuable after this call, and the structure/size/shape must not change.

set

public void set(long index,
                double value)

set

public void set(long index,
                Number value)

supplyNonZerosTo

public void supplyNonZerosTo(Mutate1D consumer)

visitOne

public void visitOne(long index,
                     VoidFunction<N> visitor)

exchange

protected void exchange(long firstA,
                        long firstB,
                        long step,
                        long count)

Specified by:

exchange in class BasicArray<N extends Number>

fill

protected void fill(long first,
                    long limit,
                    long step,
                    N value)

Specified by:

fill in class BasicArray<N extends Number>

fill

protected void fill(long first,
                    long limit,
                    long step,
                    NullaryFunction<N> supplier)

Specified by:

fill in class BasicArray<N extends Number>

indexOfLargest

protected long indexOfLargest(long first,
                              long limit,
                              long step)

Overrides:

indexOfLargest in class BasicArray<N extends Number>

isSmall

protected boolean isSmall(long first,
                          long limit,
                          long step,
                          double comparedTo)

Specified by:

isSmall in class BasicArray<N extends Number>

modify

protected void modify(long first,
                      long limit,
                      long step,
                      Access1D<N> left,
                      BinaryFunction<N> function)

Specified by:

modify in class BasicArray<N extends Number>

modify

protected void modify(long first,
                      long limit,
                      long step,
                      BinaryFunction<N> function,
                      Access1D<N> right)

Specified by:

modify in class BasicArray<N extends Number>

modify

protected void modify(long first,
                      long limit,
                      long step,
                      UnaryFunction<N> function)

Specified by:

modify in class BasicArray<N extends Number>

visit

protected void visit(long first,
                     long limit,
                     long step,
                     VoidFunction<N> visitor)

Specified by:

visit in class BasicArray<N extends Number>