BufferArray (ojAlgo 47.2.0 API)

java.lang.Object
- org.ojalgo.array.BasicArray<N>
- - org.ojalgo.array.DenseArray<N>
  - - org.ojalgo.array.BufferArray

All Implemented Interfaces:

RandomAccess, Access1D<Double>, Access1D.Elements, Access1D.IndexOf, Access1D.Visitable<Double>, Mutate1D, Mutate1D.Fillable<Double>, Mutate1D.Modifiable<Double>, Structure1D
```
public abstract class BufferArray
extends DenseArray<N>
```
The odd member among the array implementations. It allows to create arrays based on memory mapped files or direct buffers.

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

Field Summary

Fields
Modifier and Type Field and Description

static DenseArray.Factory<Double> DIRECT32

static DenseArray.Factory<Double> DIRECT64
- Fields inherited from class org.ojalgo.array.DenseArray
  MAX_ARRAY_SIZE

Fields
Modifier and Type	Field and Description
`static DenseArray.Factory<Double>`	`DIRECT32`
`static DenseArray.Factory<Double>`	`DIRECT64`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
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`	`close()`
`long`	`count()`
`protected abstract double`	`doubleValue(int index)`
`double`	`doubleValue(long index)`
`protected void`	`exchange(int firstA, int firstB, int step, int count)`
`protected void`	`exchange(long firstA, long firstB, long step, long count)`
`protected static void`	`fill(BufferArray data, Access1D<?> value)`
`protected static void`	`fill(BufferArray data, int first, int limit, int step, double value)`
`protected static void`	`fill(BufferArray data, int first, int limit, int step, NullaryFunction<?> supplier)`
`protected void`	`fill(int first, int limit, Access1D<Double> left, BinaryFunction<Double> function, Access1D<Double> right)`
`protected void`	`fill(int first, int limit, Access1D<Double> left, BinaryFunction<Double> function, Double right)`
`protected void`	`fill(int first, int limit, Double left, BinaryFunction<Double> function, Access1D<Double> right)`
`protected void`	`fill(int first, int limit, int step, Double value)`
`protected void`	`fill(int first, int limit, int step, NullaryFunction<Double> supplier)`
`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)`
`protected void`	`fillOne(int index, Access1D<?> values, long valueIndex)`
`protected void`	`fillOne(int index, Double value)`
`protected void`	`fillOne(int index, NullaryFunction<Double> 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 Double`	`get(int index)`
`N`	`get(long index)`
`protected int`	`indexOfLargest(int first, int limit, int step)`
`protected long`	`indexOfLargest(long first, long limit, long step)`
`protected static void`	`invoke(BufferArray data, int first, int limit, int step, Access1D<Double> left, BinaryFunction<Double> function, Access1D<Double> right)`
`protected static void`	`invoke(BufferArray data, int first, int limit, int step, Access1D<Double> left, BinaryFunction<Double> function, double right)`
`protected static void`	`invoke(BufferArray data, int first, int limit, int step, Access1D<Double> value, ParameterFunction<Double> function, int aParam)`
`protected static void`	`invoke(BufferArray data, int first, int limit, int step, Access1D<Double> value, UnaryFunction<Double> function)`
`protected static void`	`invoke(BufferArray data, int first, int limit, int step, double left, BinaryFunction<Double> function, Access1D<Double> right)`
`protected static void`	`invoke(BufferArray data, int first, int limit, int step, VoidFunction<Double> visitor)`
`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)`
`static ArrayAnyD<Double>`	`make(File file, long... structure)`
`static Array1D<Double>`	`make(File file, long count)`
`static Array2D<Double>`	`make(File file, long rows, long columns)`
`static BufferArray`	`make(int capacity)`
`protected void`	`modify(int first, int limit, int step, Access1D<Double> left, BinaryFunction<Double> function)`
`protected void`	`modify(int first, int limit, int step, BinaryFunction<Double> function, Access1D<Double> right)`
`protected void`	`modify(int first, int limit, int step, BinaryFunction<Double> function, Double right)`
`protected void`	`modify(int first, int limit, int step, Double left, BinaryFunction<Double> function)`
`protected void`	`modify(int first, int limit, int step, ParameterFunction<Double> function, int parameter)`
`protected void`	`modify(int first, int limit, int step, UnaryFunction<Double> 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<Double> modifier)`
`void`	`modifyOne(long index, UnaryFunction<N> modifier)`
`void`	`reset()` Reset this mutable structure to some standard (all zeros) initial state.
`protected int`	`searchAscending(Double number)`
`protected abstract 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 void`	`sortAscending()`
`protected void`	`sortDescending()`
`protected void`	`visit(int first, int limit, int step, VoidFunction<Double> visitor)`
`protected void`	`visit(long first, long limit, long step, VoidFunction<N> visitor)`
`protected void`	`visitOne(int index, VoidFunction<Double> visitor)`
`void`	`visitOne(long index, VoidFunction<N> visitor)`
`static BufferArray`	`wrap(DoubleBuffer data)`
`static BufferArray`	`wrap(FloatBuffer data)`

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

Field Detail

DIRECT32

public static final DenseArray.Factory<Double> DIRECT32

DIRECT64

public static final DenseArray.Factory<Double> DIRECT64

Method Detail

make

public static Array1D<Double> make(File file,
                                   long count)

make

public static ArrayAnyD<Double> make(File file,
                                     long... structure)

make

public static Array2D<Double> make(File file,
                                   long rows,
                                   long columns)

make

public static BufferArray make(int capacity)

wrap

public static BufferArray wrap(DoubleBuffer data)

wrap

public static BufferArray wrap(FloatBuffer data)

fill

protected static void fill(BufferArray data,
                           Access1D<?> value)

fill

protected static void fill(BufferArray data,
                           int first,
                           int limit,
                           int step,
                           double value)

fill

protected static void fill(BufferArray data,
                           int first,
                           int limit,
                           int step,
                           NullaryFunction<?> supplier)

invoke

protected static void invoke(BufferArray data,
                             int first,
                             int limit,
                             int step,
                             Access1D<Double> left,
                             BinaryFunction<Double> function,
                             Access1D<Double> right)

invoke

protected static void invoke(BufferArray data,
                             int first,
                             int limit,
                             int step,
                             Access1D<Double> left,
                             BinaryFunction<Double> function,
                             double right)

invoke

protected static void invoke(BufferArray data,
                             int first,
                             int limit,
                             int step,
                             Access1D<Double> value,
                             ParameterFunction<Double> function,
                             int aParam)

invoke

protected static void invoke(BufferArray data,
                             int first,
                             int limit,
                             int step,
                             Access1D<Double> value,
                             UnaryFunction<Double> function)

invoke

protected static void invoke(BufferArray data,
                             int first,
                             int limit,
                             int step,
                             double left,
                             BinaryFunction<Double> function,
                             Access1D<Double> right)

invoke

protected static void invoke(BufferArray data,
                             int first,
                             int limit,
                             int step,
                             VoidFunction<Double> visitor)

close
```
public void close()
```

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.

size
```
public int size()
```

add

protected void add(int index,
                   double addend)

add

protected void add(int index,
                   Number addend)

exchange

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

fill

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

fill

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

fill

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

fill

protected void fill(int first,
                    int limit,
                    int step,
                    Double value)

fill

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

fillOne

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

fillOne

protected void fillOne(int index,
                       Double value)

fillOne

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

get
```
protected Double get(int index)
```

indexOfLargest

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

isAbsolute

protected boolean isAbsolute(int index)

See Also:: Scalar.isAbsolute()

isSmall

protected boolean isSmall(int index,
                          double comparedTo)

See Also:: NormedVectorSpace.isSmall(double)

modify

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

modify

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

modify

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

modify

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

modify

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

modify

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

modifyOne

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

searchAscending

protected int searchAscending(Double number)

set

protected void set(int index,
                   Number value)

sortAscending
```
protected void sortAscending()
```

sortDescending
```
protected void sortDescending()
```

visit

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

visitOne

protected void visitOne(int index,
                        VoidFunction<Double> 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>

doubleValue

protected abstract double doubleValue(int index)

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>

set

protected abstract void set(int index,
                            double value)

visit

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

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

Class BufferArray

Nested Class Summary

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

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

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

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

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.Access1D

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

Methods inherited from interface org.ojalgo.structure.Mutate1D

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

Methods inherited from interface org.ojalgo.structure.Structure1D

Field Detail

DIRECT32

DIRECT64

Method Detail

make

make

make

make

wrap

wrap

fill

fill

fill

invoke

invoke

invoke

invoke

invoke

invoke

close

reset

size

add

add

exchange

fill

fill

fill

fill

fill

fillOne

fillOne

fillOne

get

indexOfLargest

isAbsolute

isSmall

modify

modify

modify

modify

modify

modify

modifyOne

searchAscending

set

sortAscending

sortDescending

visit

visitOne

add

add

count

doubleValue

fillAll

fillAll

fillOne

fillOne

fillOne

fillRange

fillRange

get

isAbsolute

isSmall