org.ojalgo.array

Class NumberList<N extends Number>

java.lang.Object

org.ojalgo.array.NumberList<N>

All Implemented Interfaces:

Iterable<N>, Collection<N>, List<N>, RandomAccess, Access1D<N>, Access1D.Visitable<N>, Mutate1D, Mutate1D.Mixable<N>, Structure1D

public final class NumberList<N extends Number>
extends Object
implements List<N>, RandomAccess, Access1D<N>, Access1D.Visitable<N>, Mutate1D, Mutate1D.Mixable<N>

Think of this as an ArrayList that can only contain numbers, but with a few extra features. Among other things it can be arbitrarily large (using long indices rather than int) and contain primitive double values. And of course it integrates perfectly with everything else in ojAlgo.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumberList.ListFactory<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

Method Summary

Modifier and Type	Method and Description
boolean	add(double element)
void	add(int index, N element)
void	add(long index, double addend)
void	add(long index, Number addend)
boolean	add(N element)
boolean	addAll(Collection<? extends N> elements)
boolean	addAll(double[] elements)
boolean	addAll(int index, Collection<? extends N> elements)
N	aggregateRange(long first, long limit, Aggregator aggregator)
long	capacity() The current capacity of the underlying data structure.
void	clear()
static <N extends Number> Collector<N,NumberList<N>,NumberList<N>>	collector(DenseArray.Factory<N> arrayFactory)
boolean	contains(Object object)
boolean	containsAll(Collection<?> c)
long	count()
double	doubleValue(long index)
static <N extends Number> NumberList.ListFactory<N>	factory(DenseArray.Factory<N> arrayFactory)
N	get(int index)
N	get(long index)
int	indexOf(Object object)
boolean	isEmpty()
Iterator<N>	iterator()
int	lastIndexOf(Object object)
ListIterator<N>	listIterator()
ListIterator<N>	listIterator(int index)
double	mix(long index, BinaryFunction<N> mixer, double addend)
N	mix(long index, BinaryFunction<N> mixer, N addend)
N	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> onlyKeep)
N	set(int index, N element)
void	set(long index, double value)
void	set(long index, Number value)
int	size()
NumberList<N>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] array)
String	toString()
void	visitOne(long index, VoidFunction<N> visitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

visitAll, visitRange

Methods inherited from interface org.ojalgo.structure.Mutate1D

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

Methods inherited from interface org.ojalgo.structure.Structure1D

index, loopAll, loopMatching, loopRange, mapper

Method Detail

collector

public static <N extends Number> Collector<N,NumberList<N>,NumberList<N>> collector(DenseArray.Factory<N> arrayFactory)

factory

public static <N extends Number> NumberList.ListFactory<N> factory(DenseArray.Factory<N> arrayFactory)

add

public boolean add(double element)

add

public void add(int index,
                N element)

Specified by:

add in interface List<N extends Number>

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

add

public boolean add(N element)

Specified by:

add in interface Collection<N extends Number>

Specified by:

add in interface List<N extends Number>

addAll

public boolean addAll(Collection<? extends N> elements)

Specified by:

addAll in interface Collection<N extends Number>

Specified by:

addAll in interface List<N extends Number>

addAll

public boolean addAll(double[] elements)

addAll

public boolean addAll(int index,
                      Collection<? extends N> elements)

Specified by:

addAll in interface List<N extends Number>

aggregateRange

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

capacity

public long capacity()

The current capacity of the underlying data structure. The capacity is always greater than or equal to the current number of items in the list. When you add items to the list the capacity may have to grow.

clear

public void clear()

Specified by:

clear in interface Collection<N extends Number>

Specified by:

clear in interface List<N extends Number>

contains

public boolean contains(Object object)

Specified by:

contains in interface Collection<N extends Number>

Specified by:

contains in interface List<N extends Number>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<N extends Number>

Specified by:

containsAll in interface List<N extends Number>

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>

get

public N get(int index)

Specified by:

get in interface List<N extends Number>

get

public N get(long index)

Specified by:

get in interface Access1D<N extends Number>

indexOf

public int indexOf(Object object)

Specified by:

indexOf in interface List<N extends Number>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<N extends Number>

Specified by:

isEmpty in interface List<N extends Number>

iterator

public Iterator<N> iterator()

Specified by:

iterator in interface Iterable<N extends Number>

Specified by:

iterator in interface Collection<N extends Number>

Specified by:

iterator in interface List<N extends Number>

lastIndexOf

public int lastIndexOf(Object object)

Specified by:

lastIndexOf in interface List<N extends Number>

listIterator

public ListIterator<N> listIterator()

Specified by:

listIterator in interface List<N extends Number>

listIterator

public ListIterator<N> listIterator(int index)

Specified by:

listIterator in interface List<N extends Number>

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>

remove

public N remove(int index)

Specified by:

remove in interface List<N extends Number>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<N extends Number>

Specified by:

remove in interface List<N extends Number>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<N extends Number>

Specified by:

removeAll in interface List<N extends Number>

retainAll

public boolean retainAll(Collection<?> onlyKeep)

Specified by:

retainAll in interface Collection<N extends Number>

Specified by:

retainAll in interface List<N extends Number>

set

public N set(int index,
             N element)

Specified by:

set in interface List<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

subList

public NumberList<N> subList(int fromIndex,
                             int toIndex)

Specified by:

subList in interface List<N extends Number>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<N extends Number>

Specified by:

toArray in interface List<N extends Number>

toArray

public <T> T[] toArray(T[] array)

Specified by:

toArray in interface Collection<N extends Number>

Specified by:

toArray in interface List<N extends Number>

toString

public String toString()

Overrides:

toString in class Object

visitOne

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

Specified by:

visitOne in interface Access1D.Visitable<N extends Number>