ReferenceTypeArray (ojAlgo 47.2.0 API)

java.lang.Object
- org.ojalgo.array.BasicArray<N>
- - org.ojalgo.array.DenseArray<N>
  - - org.ojalgo.array.ReferenceTypeArray<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:

BigArray, ScalarArray
```
public abstract class ReferenceTypeArray<N extends Number>
extends DenseArray<N>
implements Mutate1D.Sortable
```
A one- and/or arbitrary-dimensional array of Number.

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
Modifier and Type Field and Description

N[] data
- Fields inherited from class org.ojalgo.array.DenseArray
  MAX_ARRAY_SIZE

Fields
Modifier and Type	Field and Description
`N[]`	`data`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`add(int index, double addend)`
`protected abstract void`	`add(int index, Number addend)`
`void`	`add(long index, double addend)`
`void`	`add(long index, Number addend)`
`protected N[]`	`copyOfData()`
`long`	`count()`
`protected double`	`doubleValue(int index)`
`double`	`doubleValue(long index)`
`boolean`	`equals(Object anObj)`
`protected void`	`exchange(int firstA, int firstB, int step, int count)`
`protected void`	`exchange(long firstA, long firstB, long step, long count)`
`protected static <N extends Number> void`	`exchange(N[] data, int firstA, int firstB, int step, int aCount)`
`protected void`	`fill(int first, int limit, Access1D<N> left, BinaryFunction<N> function, Access1D<N> right)`
`protected void`	`fill(int first, int limit, Access1D<N> left, BinaryFunction<N> function, N right)`
`protected void`	`fill(int first, int limit, int step, N value)`
`protected void`	`fill(int first, int limit, int step, NullaryFunction<N> supplier)`
`protected void`	`fill(int first, int limit, N left, BinaryFunction<N> function, Access1D<N> right)`
`protected void`	`fill(long first, long limit, long step, N value)`
`protected void`	`fill(long first, long limit, long step, NullaryFunction<N> supplier)`
`protected static <N extends Number> void`	`fill(N[] data, int first, int limit, int step, N value)`
`protected static <N extends Number> void`	`fill(N[] data, int first, int limit, int step, NullaryFunction<N> supplier)`
`void`	`fillAll(N number)`
`void`	`fillAll(NullaryFunction<N> supplier)`
`void`	`fillMatching(Access1D<?> values)` Will fill the elements of [this] with the corresponding input values, and in the process (if necessary) convert the elements to the correct type:
`void`	`fillMatching(Access1D<N> left, BinaryFunction<N> function, Access1D<N> right)`
`void`	`fillMatching(UnaryFunction<N> function, Access1D<N> arguments)`
`protected void`	`fillOne(int index, Access1D<?> values, long valueIndex)`
`protected void`	`fillOne(int index, N value)`
`protected void`	`fillOne(int index, 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)`
`protected N`	`get(int index)`
`N`	`get(long index)`
`int`	`hashCode()`
`protected abstract int`	`indexOfLargest(int first, int limit, int step)`
`protected long`	`indexOfLargest(long first, long limit, long step)`
`protected static <N extends Number> void`	`invoke(N[] data, int first, int limit, int step, Access1D<N> left, BinaryFunction<N> function, Access1D<N> right)`
`protected static <N extends Number> void`	`invoke(N[] data, int first, int limit, int step, Access1D<N> left, BinaryFunction<N> function, N right)`
`protected static <N extends Number> void`	`invoke(N[] data, int first, int limit, int step, Access1D<N> value, ParameterFunction<N> function, int aParam)`
`protected static <N extends Number> void`	`invoke(N[] data, int first, int limit, int step, Access1D<N> value, UnaryFunction<N> function)`
`protected static <N extends Number> void`	`invoke(N[] data, int first, int limit, int step, N left, BinaryFunction<N> function, Access1D<N> right)`
`protected static <N extends Number> void`	`invoke(N[] data, int first, int limit, int step, VoidFunction<N> aVisitor)`
`protected abstract boolean`	`isAbsolute(int index)`
`boolean`	`isAbsolute(long index)`
`protected abstract 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(int first, int limit, int step, Access1D<N> left, BinaryFunction<N> function)`
`protected void`	`modify(int first, int limit, int step, BinaryFunction<N> function, Access1D<N> right)`
`protected void`	`modify(int first, int limit, int step, BinaryFunction<N> function, N right)`
`protected void`	`modify(int first, int limit, int step, N left, BinaryFunction<N> function)`
`protected void`	`modify(int first, int limit, int step, ParameterFunction<N> function, int parameter)`
`protected void`	`modify(int first, int limit, int step, UnaryFunction<N> function)`
`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)`
`protected void`	`modifyOne(int index, UnaryFunction<N> modifier)`
`void`	`modifyOne(long index, UnaryFunction<N> modifier)`
`void`	`reset()` Reset this mutable structure to some standard (all zeros) initial state.
`protected int`	`searchAscending(N value)`
`protected void`	`set(int index, double value)`
`protected void`	`set(int index, Number value)`
`void`	`set(long index, double value)`
`void`	`set(long index, Number number)`
`int`	`size()`
`protected abstract void`	`sortAscending()`
`protected abstract void`	`sortDescending()`
`Spliterator<N>`	`spliterator()`
`protected void`	`visit(int first, int limit, int step, VoidFunction<N> visitor)`
`protected void`	`visit(long first, long limit, long step, VoidFunction<N> visitor)`
`protected void`	`visitOne(int index, VoidFunction<N> visitor)`
`void`	`visitOne(long index, VoidFunction<N> visitor)`

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.Mutate1D.Sortable
sortAscending, sortDescending

Methods inherited from interface org.ojalgo.structure.Structure1D
count, index, loopAll, loopMatching, loopRange, mapper

Methods inherited from interface org.ojalgo.structure.Access1D
asCollectable1D, asPrimitive1D, axpy, 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

Field Detail
- data
```
public final N extends Number[] data
```

Method Detail

exchange

protected static <N extends Number> void exchange(N[] data,
                                                  int firstA,
                                                  int firstB,
                                                  int step,
                                                  int aCount)

fill

protected static <N extends Number> void fill(N[] data,
                                              int first,
                                              int limit,
                                              int step,
                                              N value)

fill

protected static <N extends Number> void fill(N[] data,
                                              int first,
                                              int limit,
                                              int step,
                                              NullaryFunction<N> supplier)

invoke

protected static <N extends Number> void invoke(N[] data,
                                                int first,
                                                int limit,
                                                int step,
                                                Access1D<N> left,
                                                BinaryFunction<N> function,
                                                Access1D<N> right)

invoke

protected static <N extends Number> void invoke(N[] data,
                                                int first,
                                                int limit,
                                                int step,
                                                Access1D<N> left,
                                                BinaryFunction<N> function,
                                                N right)

invoke

protected static <N extends Number> void invoke(N[] data,
                                                int first,
                                                int limit,
                                                int step,
                                                Access1D<N> value,
                                                ParameterFunction<N> function,
                                                int aParam)

invoke

protected static <N extends Number> void invoke(N[] data,
                                                int first,
                                                int limit,
                                                int step,
                                                Access1D<N> value,
                                                UnaryFunction<N> function)

invoke

protected static <N extends Number> void invoke(N[] data,
                                                int first,
                                                int limit,
                                                int step,
                                                N left,
                                                BinaryFunction<N> function,
                                                Access1D<N> right)

invoke

protected static <N extends Number> void invoke(N[] data,
                                                int first,
                                                int limit,
                                                int step,
                                                VoidFunction<N> aVisitor)

equals
```
public boolean equals(Object anObj)
```
Overrides:

equals in class Object

fillMatching
```
public void fillMatching(Access1D<?> values)
```
Description copied from interface: Mutate1D.Fillable

Will fill the elements of [this] with the corresponding input values, and in the process (if necessary) convert the elements to the correct type:
this(i) = values(i)

Specified by:

fillMatching in interface Mutate1D.Fillable<N extends Number>

fillMatching

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

Specified by:: fillMatching in interface Mutate1D.Fillable<N extends Number>

fillMatching

public void fillMatching(UnaryFunction<N> function,
                         Access1D<N> arguments)

Specified by:: fillMatching in interface Mutate1D.Fillable<N extends Number>

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

reset
```
public final 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.

Specified by:

reset in interface Mutate1D

size
```
public final int size()
```
Specified by:

size in interface Structure1D

spliterator

public final Spliterator<N> spliterator()

copyOfData
```
protected final N[] copyOfData()
```

doubleValue

protected final double doubleValue(int index)

exchange

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

fill

protected final void fill(int first,
                          int limit,
                          Access1D<N> left,
                          BinaryFunction<N> function,
                          Access1D<N> right)

fill

protected final void fill(int first,
                          int limit,
                          Access1D<N> left,
                          BinaryFunction<N> function,
                          N right)

fill

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

fill

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

fill

protected final void fill(int first,
                          int limit,
                          N left,
                          BinaryFunction<N> function,
                          Access1D<N> right)

fillOne

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

fillOne

protected final void fillOne(int index,
                             N value)

fillOne

protected final void fillOne(int index,
                             NullaryFunction<N> supplier)

get
```
protected final N get(int index)
```

modify

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

modify

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

modify

protected final void modify(int first,
                            int limit,
                            int step,
                            BinaryFunction<N> function,
                            N right)

modify

protected final void modify(int first,
                            int limit,
                            int step,
                            N left,
                            BinaryFunction<N> function)

modify

protected final void modify(int first,
                            int limit,
                            int step,
                            ParameterFunction<N> function,
                            int parameter)

modify

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

modifyOne

protected final void modifyOne(int index,
                               UnaryFunction<N> modifier)

searchAscending

protected final int searchAscending(N value)

set

protected final void set(int index,
                         double value)

set

protected final void set(int index,
                         Number value)

visit

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

visitOne

protected void visitOne(int index,
                        VoidFunction<N> visitor)

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>

add

protected abstract void add(int index,
                            double addend)

add

protected abstract void add(int index,
                            Number addend)

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 abstract int indexOfLargest(int first,
                                      int limit,
                                      int step)

indexOfLargest

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

Overrides:: indexOfLargest in class BasicArray<N extends Number>

isAbsolute

protected abstract boolean isAbsolute(int index)

See Also:: Scalar.isAbsolute()

isSmall

protected abstract boolean isSmall(int index,
                                   double comparedTo)

See Also:: NormedVectorSpace.isSmall(double)

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>

sortAscending

protected abstract void sortAscending()

sortDescending

protected abstract void sortDescending()

visit

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

Specified by:: visit in class BasicArray<N extends Number>

Class ReferenceTypeArray<N extends Number>

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class org.ojalgo.array.DenseArray

Method Summary

Methods inherited from class org.ojalgo.array.BasicArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.structure.Structure1D

Methods inherited from interface org.ojalgo.structure.Access1D

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

Methods inherited from interface org.ojalgo.structure.Mutate1D

Field Detail

data

Method Detail

exchange

fill

fill

invoke

invoke

invoke

invoke

invoke

invoke

equals

fillMatching

fillMatching

fillMatching

hashCode

reset

size

spliterator

copyOfData

doubleValue

exchange

fill

fill

fill

fill

fill

fillOne

fillOne

fillOne

get

modify

modify

modify

modify

modify

modify

modifyOne

searchAscending

set

set

visit

visitOne

add

add

count

doubleValue

fillAll

fillAll

fillOne

fillOne

fillOne

fillRange

fillRange

get

isAbsolute

isSmall

modifyOne

set

set

visitOne

add

add