org.ojalgo.array

Class ScalarArray<N extends Number & Scalar<N>>

java.lang.Object

org.ojalgo.array.BasicArray<N>

org.ojalgo.array.DenseArray<N>

org.ojalgo.array.ReferenceTypeArray<N>

org.ojalgo.array.ScalarArray<N>

All Implemented Interfaces:

RandomAccess, Access1D<N>, Access1D.Elements, Access1D.IndexOf, Access1D.Visitable<N>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Modifiable<N>, Mutate1D.Sortable, Structure1D

Direct Known Subclasses:

ComplexArray, GenericDenseStore, QuaternionArray, RationalArray

public abstract class ScalarArray<N extends Number & Scalar<N>>
extends ReferenceTypeArray<N>

A one- and/or arbitrary-dimensional array of Scalar.

Author:

apete

Nested Class Summary

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

DenseArray.Factory<N extends Number>

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

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S extends Structure1D,B extends Structure1D.Logical<S,?>>, Structure1D.LongIndex, Structure1D.LoopCallback

Nested classes/interfaces inherited from interface org.ojalgo.structure.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.structure.Mutate1D

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

Field Summary

Fields inherited from class org.ojalgo.array.ReferenceTypeArray

data

Fields inherited from class org.ojalgo.array.DenseArray

MAX_ARRAY_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScalarArray(DenseArray.Factory<N> factory, int length)
protected	ScalarArray(DenseArray.Factory<N> factory, N[] data)

Method Summary

Modifier and Type	Method and Description
protected void	add(int index, double addend)
protected void	add(int index, Number addend)
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()
double	doubleValue(long index)
protected void	exchange(long firstA, long firstB, long step, 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 number)
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 number)
void	fillRange(long first, long limit, NullaryFunction<N> supplier)
N	get(long index)
protected int	indexOfLargest(int first, int limit, int step)
protected long	indexOfLargest(long first, long limit, long step)
protected boolean	isAbsolute(int index)
boolean	isAbsolute(long index)
protected boolean	isSmall(int index, double comparedTo)
boolean	isSmall(long index, double comparedTo)
protected boolean	isSmall(long first, long limit, long step, double comparedTo)
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	modifyOne(long index, UnaryFunction<N> modifier)
void	set(long index, double value)
void	set(long index, Number number)
void	sortAscending()
void	sortDescending()
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.ReferenceTypeArray

copyOfData, doubleValue, equals, exchange, exchange, fill, fill, fill, fill, fill, fill, fill, fillMatching, fillMatching, fillMatching, fillOne, fillOne, fillOne, get, hashCode, invoke, invoke, invoke, invoke, invoke, invoke, modify, modify, modify, modify, modify, modify, modifyOne, reset, searchAscending, set, set, size, spliterator, visit, visitOne

Methods inherited from class org.ojalgo.array.BasicArray

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ojalgo.structure.Structure1D

count, index, loopAll, loopMatching, loopRange, mapper

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asPrimitive1D, byteValue, dot, elements, equals, floatValue, hashCode, intValue, longValue, nonzeros, shortValue, supplyTo, toRawCopy1D, toString, wrap, wrap, wrap

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

isAllSmall

Methods inherited from interface org.ojalgo.structure.Mutate1D

copyComplexArgument, copyComplexImaginary, copyComplexModulus, copyComplexModulusAndArgument, copyComplexReal, copyComplexRealAndImaginary

Constructor Detail

ScalarArray

protected ScalarArray(DenseArray.Factory<N> factory,
                      int length)

ScalarArray

protected ScalarArray(DenseArray.Factory<N> factory,
                      N[] data)

Method Detail

axpy

public final 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

sortAscending

public final void sortAscending()

Specified by:

sortAscending in interface Mutate1D.Sortable

sortDescending

public final void sortDescending()

Specified by:

sortDescending in interface Mutate1D.Sortable

add

protected final void add(int index,
                         double addend)

add

protected final void add(int index,
                         Number addend)

indexOfLargest

protected final int indexOfLargest(int first,
                                   int limit,
                                   int step)

isAbsolute

protected final boolean isAbsolute(int index)

See Also:

Scalar.isAbsolute()

isSmall

protected final boolean isSmall(int index,
                                double comparedTo)

See Also:

NormedVectorSpace.isSmall(double)

add

public void add(long index,
                double addend)

Specified by:

add in interface Mutate1D

add

public void add(long index,
                Number addend)

Specified by:

add in interface Mutate1D

count

public final long count()

Specified by:

count in interface Structure1D

Returns:

The total number of elements in this structure.

doubleValue

public final double doubleValue(long index)

Specified by:

doubleValue in interface Access1D<N extends Number>

fillAll

public final void fillAll(N number)

Specified by:

fillAll in interface Mutate1D.Fillable<N extends Number>

fillAll

public final void fillAll(NullaryFunction<N> supplier)

Specified by:

fillAll in interface Mutate1D.Fillable<N extends Number>

fillOne

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

Specified by:

fillOne in interface Mutate1D.Fillable<N extends Number>

fillOne

public void fillOne(long index,
                    N value)

Specified by:

fillOne in interface Mutate1D.Fillable<N extends Number>

fillOne

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

Specified by:

fillOne in interface Mutate1D.Fillable<N extends Number>

fillRange

public final void fillRange(long first,
                            long limit,
                            N number)

Specified by:

fillRange in interface Mutate1D.Fillable<N extends Number>

fillRange

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

Specified by:

fillRange in interface Mutate1D.Fillable<N extends Number>

get

public final N get(long index)

Specified by:

get in interface Access1D<N extends Number>

isAbsolute

public final boolean isAbsolute(long index)

Specified by:

isAbsolute in interface Access1D.Elements

See Also:

Scalar.isAbsolute()

isSmall

public final boolean isSmall(long index,
                             double comparedTo)

Specified by:

isSmall in interface Access1D.Elements

See Also:

NormedVectorSpace.isSmall(double)

modifyOne

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

Specified by:

modifyOne in interface Mutate1D.Modifiable<N extends Number>

set

public final void set(long index,
                      double value)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
                      Number number)

Specified by:

set in interface Mutate1D

visitOne

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

Specified by:

visitOne in interface Access1D.Visitable<N extends Number>

exchange

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

Specified by:

exchange in class BasicArray<N extends Number>

fill

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

Specified by:

fill in class BasicArray<N extends Number>

fill

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

Specified by:

fill in class BasicArray<N extends Number>

indexOfLargest

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

Overrides:

indexOfLargest in class BasicArray<N extends Number>

isSmall

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

Specified by:

isSmall in class BasicArray<N extends Number>

modify

protected final 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 final 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 final void modify(long first,
                            long limit,
                            long step,
                            UnaryFunction<N> function)

Specified by:

modify in class BasicArray<N extends Number>

visit

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

Specified by:

visit in class BasicArray<N extends Number>