org.ojalgo.array

Class BasicArray<N extends Number>

java.lang.Object

org.ojalgo.array.BasicArray<N>

All Implemented Interfaces:

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

Direct Known Subclasses:

DenseArray, SparseArray

public abstract class BasicArray<N extends Number>
extends Object
implements Access1D<N>, Access1D.Elements, Access1D.IndexOf, Access1D.Visitable<N>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Modifiable<N>

A BasicArray is 1-dimensional, but designed to easily be extended or encapsulated, and then treated as arbitrary-dimensional. It stores/handles (any subclass of) Number elements depending on the subclass/implementation.

This abstract class defines a set of methods to access and modify array elements. It does not "know" anything about linear algebra or similar.

Author:

apete

Nested Class Summary

Nested Classes

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

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicArray(org.ojalgo.array.ArrayFactory<N,?> factory)

Method Summary

Modifier and Type	Method and Description
protected abstract void	exchange(long firstA, long firstB, long step, long count)
protected abstract void	fill(long first, long limit, long step, N value)
protected abstract void	fill(long first, long limit, long step, NullaryFunction<N> supplier)
long	indexOfLargest()
protected long	indexOfLargest(long first, long limit, long step)
long	indexOfLargestInRange(long first, long limit)
protected abstract boolean	isSmall(long first, long limit, long step, double comparedTo)
static int[]	makeDecreasingRange(int first, int count)
static long[]	makeDecreasingRange(long first, int count)
static int[]	makeIncreasingRange(int first, int count)
static long[]	makeIncreasingRange(long first, int count)
protected abstract void	modify(long first, long limit, long step, Access1D<N> left, BinaryFunction<N> function)
protected abstract void	modify(long first, long limit, long step, BinaryFunction<N> function, Access1D<N> right)
protected abstract void	modify(long first, long limit, long step, UnaryFunction<N> function)
void	modifyAll(UnaryFunction<N> modifier)
void	modifyMatching(Access1D<N> left, BinaryFunction<N> function)
void	modifyMatching(BinaryFunction<N> function, Access1D<N> right)
void	modifyRange(long first, long limit, UnaryFunction<N> modifier)
String	toString()
protected abstract void	visit(long first, long limit, long step, VoidFunction<N> visitor)
void	visitAll(VoidFunction<N> visitor)
void	visitRange(long first, long limit, VoidFunction<N> visitor)
protected Array1D<N>	wrapInArray1D() A utility facade that conveniently/consistently presents the BasicArray as a one-dimensional array.
protected Array2D<N>	wrapInArray2D(long structure) A utility facade that conveniently/consistently presents the BasicArray as a two-dimensional array.
protected ArrayAnyD<N>	wrapInArrayAnyD(long[] structure) A utility facade that conveniently/consistently presents the BasicArray as a multi-dimensional array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.structure.Access1D

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

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

isAbsolute, isAllSmall, isSmall

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

visitOne

Methods inherited from interface org.ojalgo.structure.Mutate1D

add, add, copyComplexArgument, copyComplexImaginary, copyComplexModulus, copyComplexModulusAndArgument, copyComplexReal, copyComplexRealAndImaginary, reset, set, set

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

fillAll, fillAll, fillMatching, fillMatching, fillMatching, fillOne, fillOne, fillOne, fillRange, fillRange

Methods inherited from interface org.ojalgo.structure.Mutate1D.Modifiable

modifyOne

Methods inherited from interface org.ojalgo.structure.Structure1D

count, index, loopAll, loopMatching, loopRange, mapper, size

Constructor Detail

BasicArray

protected BasicArray(org.ojalgo.array.ArrayFactory<N,?> factory)

Method Detail

makeDecreasingRange

public static int[] makeDecreasingRange(int first,
                                        int count)

makeDecreasingRange

public static long[] makeDecreasingRange(long first,
                                         int count)

makeIncreasingRange

public static int[] makeIncreasingRange(int first,
                                        int count)

makeIncreasingRange

public static long[] makeIncreasingRange(long first,
                                         int count)

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

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.Modifiable<N extends Number>

modifyMatching

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

Specified by:

modifyMatching in interface Mutate1D.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>

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>

visitRange

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

Specified by:

visitRange in interface Access1D.Visitable<N extends Number>

exchange

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

fill

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

fill

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

indexOfLargest

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

isSmall

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

modify

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

modify

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

modify

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

visit

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

wrapInArray1D

protected final Array1D<N> wrapInArray1D()

A utility facade that conveniently/consistently presents the BasicArray as a one-dimensional array. Note that you will modify the actual array by accessing it through this facade.

wrapInArray2D

protected final Array2D<N> wrapInArray2D(long structure)

A utility facade that conveniently/consistently presents the BasicArray as a two-dimensional array. Note that you will modify the actual array by accessing it through this facade.

wrapInArrayAnyD

protected final ArrayAnyD<N> wrapInArrayAnyD(long[] structure)

A utility facade that conveniently/consistently presents the BasicArray as a multi-dimensional array. Note that you will modify the actual array by accessing it through this facade.