Module ojalgo

Package org.ojalgo.array

Class PlainArray<N extends Comparable<N>>

java.lang.Object

org.ojalgo.array.BasicArray<N>

org.ojalgo.array.DenseArray<N>

org.ojalgo.array.PlainArray<N>

All Implemented Interfaces:

RandomAccess, Access1D<N>, Access1D.Aggregatable<N>, Access1D.Collectable<N,Mutate1D>, Access1D.Visitable<N>, Factory1D.Builder<DenseArray<N>>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Modifiable<N>, Structure1D

Direct Known Subclasses:

BufferArray, PrimitiveArray, ReferenceTypeArray

public abstract class PlainArray<N extends Comparable<N>>
extends DenseArray<N>
implements RandomAccess

Array class limited by integer (int, not long) indices. Typically this will be a plain java array as in double[]. This class terminates/implements all methods with long arguments, casts the long arguments to int and delegates to new protected abstract methods with the int arguments. No new public methods are declared here.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlainArray.Factory<N extends Comparable<N>,A extends PlainArray<N>>

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

Access1D.Aggregatable<N extends Comparable<N>>, Access1D.Collectable<N extends Comparable<N>,R extends Mutate1D>, Access1D.ElementView<N extends Comparable<N>>, Access1D.SelectionView<N extends Comparable<N>>, Access1D.Sliceable<N extends Comparable<N>>, Access1D.Visitable<N extends Comparable<N>>

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

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_SIZE	Exists as a private constant in ArrayList.

Method Summary

Modifier and Type	Method	Description
void	add(int index, byte addend)
void	add(int index, float addend)
void	add(int index, int addend)
void	add(int index, long addend)
void	add(int index, short addend)
protected abstract void	add(int index, Comparable<?> addend)
final void	add(long index, byte addend)
final void	add(long index, double addend)
final void	add(long index, float addend)
final void	add(long index, int addend)
final void	add(long index, long addend)
final void	add(long index, short addend)
final void	add(long index, Comparable<?> addend)
abstract byte	byteValue(int index)
final byte	byteValue(long index)
final long	count()	The total number of elements in this structure.
double	doubleValue(int index)
final double	doubleValue(long index)
protected abstract void	exchange(int firstA, int firstB, int step, int count)
protected final void	exchange(long firstA, long firstB, long step, long count)
protected abstract void	fill(int first, int limit, int step, N value)
protected abstract void	fill(int first, int limit, int step, NullaryFunction<?> supplier)
protected final void	fill(long first, long limit, long step, N value)
protected final void	fill(long first, long limit, long step, NullaryFunction<?> supplier)
final void	fillAll(N number)
final void	fillAll(NullaryFunction<?> supplier)
protected abstract void	fillOne(int index, N value)
protected abstract void	fillOne(int index, NullaryFunction<?> supplier)
protected abstract void	fillOne(int index, Access1D<?> values, long valueIndex)
final void	fillRange(long first, long limit, N number)
final void	fillRange(long first, long limit, NullaryFunction<?> supplier)
abstract float	floatValue(int index)
final float	floatValue(long index)
protected abstract N	get(int index)
final N	get(long index)
protected abstract int	indexOfLargest(int first, int limit, int step)
protected final long	indexOfLargest(long first, long limit, long step)
int	intValue(int index)
final int	intValue(long index)
protected abstract boolean	isAbsolute(int index)
protected abstract boolean	isSmall(int index, double comparedTo)
long	longValue(int index)
final long	longValue(long index)
protected abstract void	modify(int first, int limit, int step, BinaryFunction<N> function, Access1D<N> right)
protected abstract void	modify(int first, int limit, int step, UnaryFunction<N> function)
protected abstract void	modify(int first, int limit, int step, Access1D<N> left, BinaryFunction<N> function)
protected final void	modify(long first, long limit, long step, BinaryFunction<N> function, Access1D<N> right)
protected final void	modify(long first, long limit, long step, UnaryFunction<N> function)
protected final void	modify(long first, long limit, long step, Access1D<N> left, BinaryFunction<N> function)
protected abstract void	modifyOne(int index, UnaryFunction<N> modifier)
final void	modifyOne(long index, UnaryFunction<N> modifier)
protected abstract int	searchAscending(N number)
void	set(int index, byte value)
abstract void	set(int index, double value)
void	set(int index, float value)
void	set(int index, int value)
abstract void	set(int index, long value)
void	set(int index, short value)
protected abstract void	set(int index, Comparable<?> number)
final void	set(long index, byte value)
final void	set(long index, double value)
final void	set(long index, float value)
final void	set(long index, int value)
final void	set(long index, long value)
final void	set(long index, short value)
final void	set(long index, Comparable<?> number)
short	shortValue(int index)
final short	shortValue(long index)
final int	size()	The total number of elements in this structure.
protected abstract void	sortAscending()
protected abstract void	sortDescending()
protected abstract void	visit(int first, int limit, int step, VoidFunction<N> visitor)
protected final void	visit(long first, long limit, long step, VoidFunction<N> visitor)
protected abstract void	visitOne(int index, VoidFunction<N> visitor)
final void	visitOne(long index, VoidFunction<N> visitor)

Methods inherited from class org.ojalgo.array.DenseArray

build

Methods inherited from class org.ojalgo.array.BasicArray

aggregateRange, equals, getMathType, hashCode, indexOfLargest, isPrimitive, modifyAll, modifyMatching, modifyMatching, modifyRange, supplyTo, 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.Access1D

asCollectable1D, asKeyed1D, asList, axpy, dot, elements, nonzeros, select, supplyTo, toList, toRawCopy1D

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

aggregateAll

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

collect

Methods inherited from interface org.ojalgo.structure.Mutate1D

reset

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

fillCompatible, fillMatching, fillMatching, fillMatching, fillMatching

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

add

Field Details

MAX_SIZE

public static final int MAX_SIZE

Exists as a private constant in ArrayList. The Oracle JVM seems to actually be limited at Integer.MAX_VALUE - 2, but other JVM:s may have different limits.

See Also:

• Constant Field Values

Method Details

add

public void add(int index,
 byte addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public void add(int index,
 float addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public void add(int index,
 int addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public void add(int index,
 long addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public void add(int index,
 short addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public final void add(long index,
 byte addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public final void add(long index,
 Comparable<?> addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public final void add(long index,
 double addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public final void add(long index,
 float addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public final void add(long index,
 int addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public final void add(long index,
 long addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

add

public final void add(long index,
 short addend)

Specified by:

add in interface Mutate1D.Modifiable<N extends Comparable<N>>

byteValue

public abstract byte byteValue(int index)

Specified by:

byteValue in interface Access1D<N extends Comparable<N>>

byteValue

public final byte byteValue(long index)

Specified by:

byteValue in interface Access1D<N extends Comparable<N>>

count

public final long count()

Description copied from interface: Structure1D

The total number of elements in this structure.

You only need to implement this method if the structure can contain more than Integer.MAX_VALUE elements.

Specified by:

count in interface Structure1D

doubleValue

public double doubleValue(int index)

Specified by:

doubleValue in interface Access1D<N extends Comparable<N>>

doubleValue

public final double doubleValue(long index)

Specified by:

doubleValue in interface Access1D<N extends Comparable<N>>

fillAll

public final void fillAll(N number)

Specified by:

fillAll in interface Mutate1D.Fillable<N extends Comparable<N>>

fillAll

public final void fillAll(NullaryFunction<?> supplier)

Specified by:

fillAll in interface Mutate1D.Fillable<N extends Comparable<N>>

fillRange

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

Specified by:

fillRange in interface Mutate1D.Fillable<N extends Comparable<N>>

fillRange

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

Specified by:

fillRange in interface Mutate1D.Fillable<N extends Comparable<N>>

floatValue

public abstract float floatValue(int index)

Specified by:

floatValue in interface Access1D<N extends Comparable<N>>

floatValue

public final float floatValue(long index)

Specified by:

floatValue in interface Access1D<N extends Comparable<N>>

get

public final N get(long index)

Specified by:

get in interface Access1D<N extends Comparable<N>>

intValue

public int intValue(int index)

Specified by:

intValue in interface Access1D<N extends Comparable<N>>

intValue

public final int intValue(long index)

Specified by:

intValue in interface Access1D<N extends Comparable<N>>

longValue

public long longValue(int index)

Specified by:

longValue in interface Access1D<N extends Comparable<N>>

longValue

public final long longValue(long index)

Specified by:

longValue in interface Access1D<N extends Comparable<N>>

modifyOne

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

Specified by:

modifyOne in interface Mutate1D.Modifiable<N extends Comparable<N>>

set

public void set(int index,
 byte value)

Specified by:

set in interface Mutate1D

set

public abstract void set(int index,
 double value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 float value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 int value)

Specified by:

set in interface Mutate1D

set

public abstract void set(int index,
 long value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 short value)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
 byte value)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
 Comparable<?> number)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
 double value)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
 float value)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
 int value)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
 long value)

Specified by:

set in interface Mutate1D

set

public final void set(long index,
 short value)

Specified by:

set in interface Mutate1D

shortValue

public short shortValue(int index)

Specified by:

shortValue in interface Access1D<N extends Comparable<N>>

shortValue

public final short shortValue(long index)

Specified by:

shortValue in interface Access1D<N extends Comparable<N>>

size

public final int size()

Description copied from interface: Structure1D

The total number of elements in this structure.

Specified by:

size in interface Structure1D

visitOne

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

Specified by:

visitOne in interface Access1D.Visitable<N extends Comparable<N>>

add

protected abstract void add(int index,
 Comparable<?> addend)

exchange

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

exchange

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

Overrides:

exchange in class BasicArray<N extends Comparable<N>>

fill

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

fill

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

fill

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

Overrides:

fill in class BasicArray<N extends Comparable<N>>

fill

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

Overrides:

fill in class BasicArray<N extends Comparable<N>>

fillOne

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

fillOne

protected abstract void fillOne(int index,
 N value)

fillOne

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

get

protected abstract N get(int index)

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 Comparable<N>>

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)

modify

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

modify

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

modify

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

modify

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

Overrides:

modify in class BasicArray<N extends Comparable<N>>

modify

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

Overrides:

modify in class BasicArray<N extends Comparable<N>>

modify

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

Overrides:

modify in class BasicArray<N extends Comparable<N>>

modifyOne

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

searchAscending

protected abstract int searchAscending(N number)

set

protected abstract void set(int index,
 Comparable<?> number)

sortAscending

protected abstract void sortAscending()

sortDescending

protected abstract void sortDescending()

visit

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

visit

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

Overrides:

visit in class BasicArray<N extends Comparable<N>>

visitOne

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