org.ojalgo.array

Class ArrayAnyD<N extends Number>

java.lang.Object

org.ojalgo.array.ArrayAnyD<N>

All Implemented Interfaces:

Serializable, Iterable<N>, Access1D<N>, Access1D.Aggregatable<N>, Access1D.Elements, Access1D.IndexOf, Access1D.Sliceable<N>, Access1D.Visitable<N>, AccessAnyD<N>, AccessAnyD.Aggregatable<N>, AccessAnyD.Elements, AccessAnyD.IndexOf, AccessAnyD.Sliceable<N>, AccessAnyD.Visitable<N>, Mutate1D, Mutate1D.BiModifiable<N>, Mutate1D.Fillable<N>, Mutate1D.Mixable<N>, Mutate1D.Modifiable<N>, MutateAnyD, MutateAnyD.BiModifiable<N>, MutateAnyD.Fillable<N>, MutateAnyD.Mixable<N>, MutateAnyD.Modifiable<N>, Structure1D, StructureAnyD, StructureAnyD.ReducibleTo1D<Array1D<N>>, StructureAnyD.ReducibleTo2D<Array2D<N>>

public final class ArrayAnyD<N extends Number>
extends Object
implements AccessAnyD<N>, AccessAnyD.Elements, AccessAnyD.IndexOf, AccessAnyD.Visitable<N>, AccessAnyD.Aggregatable<N>, StructureAnyD.ReducibleTo1D<Array1D<N>>, StructureAnyD.ReducibleTo2D<Array2D<N>>, AccessAnyD.Sliceable<N>, MutateAnyD, MutateAnyD.Fillable<N>, MutateAnyD.Modifiable<N>, MutateAnyD.BiModifiable<N>, MutateAnyD.Mixable<N>, Serializable

ArrayAnyD

Author:

apete

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArrayAnyD.Factory<N extends Number>

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

AccessAnyD.Aggregatable<N extends Number>, AccessAnyD.Collectable<N extends Number,R extends MutateAnyD.Receiver<N>>, AccessAnyD.Elements, AccessAnyD.IndexOf, AccessAnyD.Sliceable<N extends Number>, AccessAnyD.Visitable<N extends Number>

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

Access1D.ElementView<N extends Number>

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

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

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

Mutate1D.Sortable

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

StructureAnyD.IntReference, StructureAnyD.LongReference, StructureAnyD.ReducibleTo1D<R extends Structure1D>, StructureAnyD.ReducibleTo2D<R extends Structure2D>, StructureAnyD.ReferenceCallback, StructureAnyD.ReferenceMapper

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayAnyD.Factory<BigDecimal>	BIG
static ArrayAnyD.Factory<ComplexNumber>	COMPLEX
static ArrayAnyD.Factory<Double>	DIRECT32
static ArrayAnyD.Factory<Double>	DIRECT64
static ArrayAnyD.Factory<Double>	PRIMITIVE32
static ArrayAnyD.Factory<Double>	PRIMITIVE64
static ArrayAnyD.Factory<Quaternion>	QUATERNION
static ArrayAnyD.Factory<RationalNumber>	RATIONAL

Method Summary

Modifier and Type	Method and Description
void	add(long[] reference, double addend)
void	add(long[] reference, Number addend)
void	add(long index, double addend)
void	add(long index, Number addend)
N	aggregateRange(long first, long limit, Aggregator aggregator)
Number	aggregateSet(int dimension, long dimensionalIndex, Aggregator aggregator)
Number	aggregateSet(long[] initial, int dimension, Aggregator aggregator)
Array1D<N>	asArray1D() Deprecated. v39 Not needed
void	clear()
long	count() count() == count(0) * count(1) * count(2) * count(3) * ...
long	count(int dimension)
double	doubleValue(long index) Will pass through each matching element position calling the through function.
double	doubleValue(long[] ref)
boolean	equals(Object obj)
static <N extends Number> ArrayAnyD.Factory<N>	factory(DenseArray.Factory<N> denseArray)
void	fillAll(N value)
void	fillAll(NullaryFunction<N> supplier)
void	fillOne(long[] reference, N value)
void	fillOne(long[] reference, 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)
void	fillSet(int dimension, long dimensionalIndex, N value)
void	fillSet(int dimension, long dimensionalIndex, NullaryFunction<N> supplier)
void	fillSet(long[] initial, int dimension, N value)
void	fillSet(long[] initial, int dimension, NullaryFunction<N> supplier)
N	get(long index)
N	get(long[] ref)
int	hashCode()
long	indexOfLargest()
long	indexOfLargestInRange(long first, long limit)
boolean	isAbsolute(long index)
boolean	isAbsolute(long[] reference)
boolean	isSmall(long[] reference, double comparedTo)
boolean	isSmall(long index, double comparedTo)
double	mix(long[] reference, BinaryFunction<N> mixer, double addend)
N	mix(long[] reference, BinaryFunction<N> mixer, N addend)
void	modifyAll(UnaryFunction<N> modifier)
void	modifyMatching(Access1D<N> left, BinaryFunction<N> function)
void	modifyMatching(BinaryFunction<N> function, Access1D<N> right)
void	modifyOne(long[] reference, UnaryFunction<N> modifier)
void	modifyOne(long index, UnaryFunction<N> modifier)
void	modifyRange(long first, long limit, UnaryFunction<N> modifier)
void	modifySet(int dimension, long dimensionalIndex, UnaryFunction<N> modifier)
void	modifySet(long[] initial, int dimension, UnaryFunction<N> modifier)
int	rank()
Array1D<N>	reduce(int dimension, Aggregator aggregator)
Array2D<N>	reduce(int rowDimension, int columnDimension, Aggregator aggregator)
void	set(long[] reference, double value)
void	set(long[] reference, Number value)
void	set(long index, double value)
void	set(long index, Number value)
long[]	shape()
Array1D<N>	sliceRange(long first, long limit)
Array1D<N>	sliceSet(long[] initial, int dimension)
String	toString()
void	visitAll(VoidFunction<N> visitor)
void	visitOne(long[] reference, VoidFunction<N> visitor)
void	visitOne(long index, VoidFunction<N> visitor)
void	visitRange(long first, long limit, VoidFunction<N> visitor)
void	visitSet(int dimension, long dimensionalIndex, VoidFunction<N> visitor)
void	visitSet(long[] initial, int dimension, VoidFunction<N> visitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.access.AccessAnyD

asCollectableAnyD, asPrimitiveAnyD, equals

Methods inherited from interface org.ojalgo.access.Access1D

asCollectable1D, asPrimitive1D, axpy, dot, elements, equals, hashCode, iterator, nonzeros, 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.AccessAnyD.Aggregatable

reduce

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

aggregateAll

Methods inherited from interface org.ojalgo.access.Mutate1D

reset

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

fillMatching, fillMatching, fillMatching

Methods inherited from interface org.ojalgo.access.MutateAnyD.Mixable

mix, mix

Methods inherited from interface org.ojalgo.access.StructureAnyD

count, count, count, count, index, index, index, loop, loop, loop, loopAll, loopMatching, mapperOf, reference, shape, step, step, step, step

Methods inherited from interface org.ojalgo.access.Structure1D

loopAll, loopMatching, loopRange, mapper

Field Detail

BIG

public static final ArrayAnyD.Factory<BigDecimal> BIG

COMPLEX

public static final ArrayAnyD.Factory<ComplexNumber> COMPLEX

DIRECT32

public static final ArrayAnyD.Factory<Double> DIRECT32

DIRECT64

public static final ArrayAnyD.Factory<Double> DIRECT64

PRIMITIVE32

public static final ArrayAnyD.Factory<Double> PRIMITIVE32

PRIMITIVE64

public static final ArrayAnyD.Factory<Double> PRIMITIVE64

QUATERNION

public static final ArrayAnyD.Factory<Quaternion> QUATERNION

RATIONAL

public static final ArrayAnyD.Factory<RationalNumber> RATIONAL

Method Detail

factory

public static <N extends Number> ArrayAnyD.Factory<N> factory(DenseArray.Factory<N> denseArray)

add

public void add(long index,
                double addend)

Specified by:

add in interface Mutate1D

Specified by:

add in interface MutateAnyD

add

public void add(long index,
                Number addend)

Specified by:

add in interface Mutate1D

Specified by:

add in interface MutateAnyD

add

public void add(long[] reference,
                double addend)

Specified by:

add in interface MutateAnyD

add

public void add(long[] reference,
                Number addend)

Specified by:

add in interface MutateAnyD

aggregateRange

public N aggregateRange(long first,
                        long limit,
                        Aggregator aggregator)

Specified by:

aggregateRange in interface Access1D.Aggregatable<N extends Number>

aggregateSet

public Number aggregateSet(int dimension,
                           long dimensionalIndex,
                           Aggregator aggregator)

Specified by:

aggregateSet in interface AccessAnyD.Aggregatable<N extends Number>

aggregateSet

public Number aggregateSet(long[] initial,
                           int dimension,
                           Aggregator aggregator)

Specified by:

aggregateSet in interface AccessAnyD.Aggregatable<N extends Number>

asArray1D

@Deprecated
public Array1D<N> asArray1D()

Deprecated. v39 Not needed

Flattens this abitrary dimensional array to a one dimensional array. The (internal/actual) array is not copied, it is just accessed through a different adaptor.

clear

public void clear()

count

public long count()

Description copied from interface: StructureAnyD

count() == count(0) * count(1) * count(2) * count(3) * ...

Specified by:

count in interface Structure1D

Specified by:

count in interface StructureAnyD

Returns:

The total number of elements in this structure.

count

public long count(int dimension)

Specified by:

count in interface StructureAnyD

doubleValue

public double doubleValue(long index)

Description copied from interface: AccessAnyD

Will pass through each matching element position calling the through function. What happens is entirely dictated by how you implement the callback.

Specified by:

doubleValue in interface Access1D<N extends Number>

Specified by:

doubleValue in interface AccessAnyD<N extends Number>

doubleValue

public double doubleValue(long[] ref)

Specified by:

doubleValue in interface AccessAnyD<N extends Number>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

fillAll

public void fillAll(N value)

Specified by:

fillAll in interface Mutate1D.Fillable<N extends Number>

fillAll

public void fillAll(NullaryFunction<N> supplier)

Specified by:

fillAll in interface Mutate1D.Fillable<N extends Number>

fillOne

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

fillOne

public void fillOne(long[] reference,
                    N value)

Specified by:

fillOne in interface MutateAnyD.Fillable<N extends Number>

fillOne

public void fillOne(long[] reference,
                    NullaryFunction<N> supplier)

Specified by:

fillOne in interface MutateAnyD.Fillable<N extends Number>

fillRange

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

Specified by:

fillRange in interface Mutate1D.Fillable<N extends Number>

fillRange

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

Specified by:

fillRange in interface Mutate1D.Fillable<N extends Number>

fillSet

public void fillSet(int dimension,
                    long dimensionalIndex,
                    N value)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Number>

fillSet

public void fillSet(int dimension,
                    long dimensionalIndex,
                    NullaryFunction<N> supplier)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Number>

fillSet

public void fillSet(long[] initial,
                    int dimension,
                    N value)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Number>

fillSet

public void fillSet(long[] initial,
                    int dimension,
                    NullaryFunction<N> supplier)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Number>

get

public N get(long index)

Specified by:

get in interface Access1D<N extends Number>

Specified by:

get in interface AccessAnyD<N extends Number>

get

public N get(long[] ref)

Specified by:

get in interface AccessAnyD<N extends Number>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

indexOfLargest

public long indexOfLargest()

Specified by:

indexOfLargest in interface Access1D.IndexOf

indexOfLargestInRange

public long indexOfLargestInRange(long first,
                                  long limit)

Specified by:

indexOfLargestInRange in interface Access1D.IndexOf

isAbsolute

public boolean isAbsolute(long index)

Specified by:

isAbsolute in interface Access1D.Elements

See Also:

Scalar.isAbsolute()

isAbsolute

public boolean isAbsolute(long[] reference)

Specified by:

isAbsolute in interface AccessAnyD.Elements

See Also:

Scalar.isAbsolute()

isSmall

public boolean isSmall(long index,
                       double comparedTo)

Specified by:

isSmall in interface Access1D.Elements

See Also:

NormedVectorSpace.isSmall(double)

isSmall

public boolean isSmall(long[] reference,
                       double comparedTo)

Specified by:

isSmall in interface AccessAnyD.Elements

See Also:

NormedVectorSpace.isSmall(double)

mix

public double mix(long[] reference,
                  BinaryFunction<N> mixer,
                  double addend)

Specified by:

mix in interface MutateAnyD.Mixable<N extends Number>

mix

public N mix(long[] reference,
             BinaryFunction<N> mixer,
             N addend)

Specified by:

mix in interface MutateAnyD.Mixable<N extends Number>

modifyAll

public void modifyAll(UnaryFunction<N> modifier)

Specified by:

modifyAll in interface Mutate1D.Modifiable<N extends Number>

modifyMatching

public void modifyMatching(Access1D<N> left,
                           BinaryFunction<N> function)

Specified by:

modifyMatching in interface Mutate1D.BiModifiable<N extends Number>

modifyMatching

public void modifyMatching(BinaryFunction<N> function,
                           Access1D<N> right)

Specified by:

modifyMatching in interface Mutate1D.BiModifiable<N extends Number>

modifyOne

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

Specified by:

modifyOne in interface Mutate1D.Modifiable<N extends Number>

modifyOne

public void modifyOne(long[] reference,
                      UnaryFunction<N> modifier)

Specified by:

modifyOne in interface MutateAnyD.Modifiable<N extends Number>

modifyRange

public void modifyRange(long first,
                        long limit,
                        UnaryFunction<N> modifier)

Specified by:

modifyRange in interface Mutate1D.Modifiable<N extends Number>

modifySet

public void modifySet(int dimension,
                      long dimensionalIndex,
                      UnaryFunction<N> modifier)

Specified by:

modifySet in interface MutateAnyD.Modifiable<N extends Number>

modifySet

public void modifySet(long[] initial,
                      int dimension,
                      UnaryFunction<N> modifier)

Specified by:

modifySet in interface MutateAnyD.Modifiable<N extends Number>

rank

public int rank()

Specified by:

rank in interface StructureAnyD

Returns:

The number of dimensions (the number of indices used to reference one element)

reduce

public Array1D<N> reduce(int dimension,
                         Aggregator aggregator)

Specified by:

reduce in interface StructureAnyD.ReducibleTo1D<Array1D<N extends Number>>

Parameters:

dimension - Which of the AnyD-dimensions should be mapped to the resulting 1D structure.

aggregator - How to aggregate the values of the reduction

Returns:

A 1D data structure with aggregated values

reduce

public Array2D<N> reduce(int rowDimension,
                         int columnDimension,
                         Aggregator aggregator)

Specified by:

reduce in interface StructureAnyD.ReducibleTo2D<Array2D<N extends Number>>

Parameters:

rowDimension - Which of the AnyD-dimensions should be mapped to the rows of the resulting 2D structure.

columnDimension - Which of the AnyD-dimensions should be mapped to the columns of the resulting 2D structure.

aggregator - How to aggregate the values of the reduction

Returns:

A 2D data structure with aggregated values

set

public void set(long index,
                double value)

Specified by:

set in interface Mutate1D

Specified by:

set in interface MutateAnyD

set

public void set(long index,
                Number value)

Specified by:

set in interface Mutate1D

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
                double value)

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
                Number value)

Specified by:

set in interface MutateAnyD

shape

public long[] shape()

Specified by:

shape in interface StructureAnyD

sliceRange

public Array1D<N> sliceRange(long first,
                             long limit)

Specified by:

sliceRange in interface Access1D.Sliceable<N extends Number>

sliceSet

public Array1D<N> sliceSet(long[] initial,
                           int dimension)

Specified by:

sliceSet in interface AccessAnyD.Sliceable<N extends Number>

toString

public String toString()

Overrides:

toString in class Object

visitAll

public void visitAll(VoidFunction<N> visitor)

Specified by:

visitAll in interface Access1D.Visitable<N extends Number>

visitOne

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

Specified by:

visitOne in interface Access1D.Visitable<N extends Number>

visitOne

public void visitOne(long[] reference,
                     VoidFunction<N> visitor)

Specified by:

visitOne in interface AccessAnyD.Visitable<N extends Number>

visitRange

public void visitRange(long first,
                       long limit,
                       VoidFunction<N> visitor)

Specified by:

visitRange in interface Access1D.Visitable<N extends Number>

visitSet

public void visitSet(int dimension,
                     long dimensionalIndex,
                     VoidFunction<N> visitor)

Specified by:

visitSet in interface AccessAnyD.Visitable<N extends Number>

visitSet

public void visitSet(long[] initial,
                     int dimension,
                     VoidFunction<N> visitor)

Specified by:

visitSet in interface AccessAnyD.Visitable<N extends Number>