org.ojalgo.array

Class Array1D<N extends Number>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<N>

org.ojalgo.array.Array1D<N>

All Implemented Interfaces:

Iterable<N>, Collection<N>, Consumer<Access1D<?>>, List<N>, RandomAccess, Access1D<N>, Access1D.Aggregatable<N>, Access1D.Elements, Access1D.IndexOf, Access1D.Sliceable<N>, Access1D.Visitable<N>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Mixable<N>, Mutate1D.Modifiable<N>, Mutate1D.ModifiableReceiver<N>, Mutate1D.Receiver<N>, Mutate1D.Sortable, Structure1D

public final class Array1D<N extends Number>
extends AbstractList<N>
implements Access1D<N>, Access1D.Visitable<N>, Access1D.Aggregatable<N>, Access1D.Sliceable<N>, Access1D.Elements, Access1D.IndexOf, Mutate1D.ModifiableReceiver<N>, Mutate1D.Mixable<N>, Mutate1D.Sortable, RandomAccess

Array1D

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Array1D.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 Array1D.Factory<BigDecimal>	BIG
static Array1D.Factory<ComplexNumber>	COMPLEX
static Array1D.Factory<Double>	DIRECT32
static Array1D.Factory<Double>	DIRECT64
long	length
static Array1D.Factory<Double>	PRIMITIVE32
static Array1D.Factory<Double>	PRIMITIVE64
static Array1D.Factory<Quaternion>	QUATERNION
static Array1D.Factory<RationalNumber>	RATIONAL

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method and Description
void	add(long index, double addend)
void	add(long index, Number addend)
N	aggregateRange(long first, long limit, Aggregator aggregator)
void	clear()
boolean	contains(Object obj)
Array1D<N>	copy()
Array1D<N>	copy(int... indices) Creates a copy of this containing only the selected elements, in the specified order.
long	count()
double	doubleValue(long index)
static <N extends Number> Array1D.Factory<N>	factory(DenseArray.Factory<N> denseFactory)
void	fillAll(N value)
void	fillAll(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)
N	get(int index)
N	get(long index)
int	indexOf(Object obj)
long	indexOfLargest()
long	indexOfLargestInRange(long first, long limit)
boolean	isAbsolute(long index)
boolean	isAllSmall(double comparedTo)
boolean	isEmpty()
boolean	isSmall(long index, double comparedTo)
double	mix(long index, BinaryFunction<N> mixer, double addend)
N	mix(long index, BinaryFunction<N> mixer, N addend)
void	modifyAll(UnaryFunction<N> modifier)
void	modifyAny(Transformation1D<N> modifier)
void	modifyMatching(Access1D<N> left, BinaryFunction<N> function)
void	modifyMatching(BinaryFunction<N> function, Access1D<N> right)
void	modifyOne(long index, UnaryFunction<N> modifier)
void	modifyRange(long first, long limit, UnaryFunction<N> modifier)
N	set(int index, Number value)
void	set(long index, double value)
void	set(long index, Number value)
int	size()
Array1D<N>	sliceRange(long first, long limit)
void	sortAscending()
void	sortDescending()
Array1D<N>	subList(int first, int limit)
String	toString()
void	visitAll(VoidFunction<N> visitor)
void	visitOne(long index, VoidFunction<N> visitor)
void	visitRange(long first, long limit, VoidFunction<N> visitor)

Methods inherited from class java.util.AbstractList

add, add, addAll, equals, hashCode, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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.Aggregatable

aggregateAll

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

accept, isAcceptable

Methods inherited from interface org.ojalgo.structure.Mutate1D

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

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface java.util.List

addAll, containsAll, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

BIG

public static final Array1D.Factory<BigDecimal> BIG

COMPLEX

public static final Array1D.Factory<ComplexNumber> COMPLEX

DIRECT32

public static final Array1D.Factory<Double> DIRECT32

DIRECT64

public static final Array1D.Factory<Double> DIRECT64

PRIMITIVE32

public static final Array1D.Factory<Double> PRIMITIVE32

PRIMITIVE64

public static final Array1D.Factory<Double> PRIMITIVE64

QUATERNION

public static final Array1D.Factory<Quaternion> QUATERNION

RATIONAL

public static final Array1D.Factory<RationalNumber> RATIONAL

length

public final long length

Method Detail

factory

public static <N extends Number> Array1D.Factory<N> factory(DenseArray.Factory<N> denseFactory)

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

aggregateRange

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

Specified by:

aggregateRange in interface Access1D.Aggregatable<N extends Number>

clear

public void clear()

Specified by:

clear in interface Collection<N extends Number>

Specified by:

clear in interface List<N extends Number>

Overrides:

clear in class AbstractList<N extends Number>

contains

public boolean contains(Object obj)

Specified by:

contains in interface Collection<N extends Number>

Specified by:

contains in interface List<N extends Number>

Overrides:

contains in class AbstractCollection<N extends Number>

copy

public Array1D<N> copy()

copy

public Array1D<N> copy(int... indices)

Creates a copy of this containing only the selected elements, in the specified order.

count

public long count()

Specified by:

count in interface Structure1D

Returns:

The total number of elements in this structure.

doubleValue

public double doubleValue(long index)

Specified by:

doubleValue in interface Access1D<N extends Number>

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>

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>

get

public N get(int index)

Specified by:

get in interface List<N extends Number>

Specified by:

get in class AbstractList<N extends Number>

get

public N get(long index)

Specified by:

get in interface Access1D<N extends Number>

indexOf

public int indexOf(Object obj)

Specified by:

indexOf in interface List<N extends Number>

Overrides:

indexOf in class AbstractList<N extends Number>

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()

isAllSmall

public boolean isAllSmall(double comparedTo)

Specified by:

isAllSmall in interface Access1D.Elements

See Also:

NormedVectorSpace.isSmall(double)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<N extends Number>

Specified by:

isEmpty in interface List<N extends Number>

Overrides:

isEmpty in class AbstractCollection<N extends Number>

isSmall

public boolean isSmall(long index,
                       double comparedTo)

Specified by:

isSmall in interface Access1D.Elements

See Also:

NormedVectorSpace.isSmall(double)

mix

public double mix(long index,
                  BinaryFunction<N> mixer,
                  double addend)

Specified by:

mix in interface Mutate1D.Mixable<N extends Number>

Returns:

The new/mixed value

mix

public N mix(long index,
             BinaryFunction<N> mixer,
             N addend)

Specified by:

mix in interface Mutate1D.Mixable<N extends Number>

modifyAll

public void modifyAll(UnaryFunction<N> modifier)

Specified by:

modifyAll in interface Mutate1D.Modifiable<N extends Number>

modifyAny

public void modifyAny(Transformation1D<N> modifier)

Specified by:

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

modifyOne

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

Specified by:

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

set

public N set(int index,
             Number value)

Specified by:

set in interface List<N extends Number>

Overrides:

set in class AbstractList<N extends Number>

set

public void set(long index,
                double value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
                Number value)

Specified by:

set in interface Mutate1D

size

public int size()

Specified by:

size in interface Collection<N extends Number>

Specified by:

size in interface List<N extends Number>

Specified by:

size in interface Structure1D

Specified by:

size in class AbstractCollection<N extends Number>

sliceRange

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

Specified by:

sliceRange in interface Access1D.Sliceable<N extends Number>

sortAscending

public void sortAscending()

Specified by:

sortAscending in interface Mutate1D.Sortable

sortDescending

public void sortDescending()

Specified by:

sortDescending in interface Mutate1D.Sortable

subList

public Array1D<N> subList(int first,
                          int limit)

Specified by:

subList in interface List<N extends Number>

Overrides:

subList in class AbstractList<N extends Number>

toString

public String toString()

Overrides:

toString in class AbstractCollection<N extends Number>

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>

visitRange

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

Specified by:

visitRange in interface Access1D.Visitable<N extends Number>