Class NumberList<N extends Comparable<N>>

java.lang.Object

org.ojalgo.array.NumberList<N>

All Implemented Interfaces:

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

public final class NumberList<N extends Comparable<N>>
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NumberList.ListFactory<N extends Comparable<N>>

Nested classes/interfaces inherited from interface Access1D

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

Nested classes/interfaces inherited from interface Mutate1D

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

Nested classes/interfaces inherited from interface Structure1D

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

Field Summary

Fields

Modifier and Type	Field	Description
private long	myActualCount
private final DenseArray.Factory<N,?>	myDenseFactory
private final GrowthStrategy	myGrowthStrategy
private BasicArray<N>	myStorage

Constructor Summary

Constructors

Constructor	Description
NumberList(DenseArray.Factory<N,?> denseFactory, GrowthStrategy growthStrategy)
NumberList(DenseArray.Factory<N,?> denseFactory, GrowthStrategy growthStrategy, BasicArray<N> storage, long actualCount)

Method Summary

Modifier and Type	Method	Description
boolean	add(double element)
boolean	add(float element)
void	add(int index, N element)
boolean	add(N element)
boolean	addAll(double[] elements)
boolean	addAll(int index, Collection<? extends N> elements)
boolean	addAll(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 Comparable<N>> Collector<N, NumberList<N>, NumberList<N>>	collector(DenseArray.Factory<N,?> arrayFactory)
boolean	contains(Object object)
boolean	containsAll(Collection<?> c)
long	count()	The total number of elements in this structure.
double	doubleValue(int index)
double	doubleValue(long index)
private void	ensureCapacity()
static <N extends Comparable<N>> 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)
void	set(int index, double value)
N	set(int index, N element)
void	set(long index, double value)
void	set(long index, float value)
void	set(long index, Comparable<?> value)
int	size()	The total number of elements in this structure.
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 Object

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

Methods inherited from interface Access1D

asCollectable1D, asKeyed1D, asList, axpy, byteValue, byteValue, dot, elements, floatValue, floatValue, intValue, intValue, longValue, longValue, nonzeros, select, shortValue, shortValue, supplyTo, toList, toRawCopy1D

Methods inherited from interface Access1D.Visitable

visitAll, visitRange

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface Mutate1D

reset, set, set, set, set, set, set, set, set, set

Field Details

myActualCount

private long myActualCount

myDenseFactory

private final DenseArray.Factory<N extends Comparable<N>, ?> myDenseFactory

myGrowthStrategy

private final GrowthStrategy myGrowthStrategy

myStorage

private BasicArray<N extends Comparable<N>> myStorage

Constructor Details

NumberList

NumberList(DenseArray.Factory<N,?> denseFactory,
 GrowthStrategy growthStrategy)

NumberList

NumberList(DenseArray.Factory<N,?> denseFactory,
 GrowthStrategy growthStrategy,
 BasicArray<N> storage,
 long actualCount)

Method Details

collector

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

factory

public static <N extends Comparable<N>>
NumberList.ListFactory<N> factory(DenseArray.Factory<N,?> arrayFactory)

add

public boolean add(double element)

add

public boolean add(float element)

add

public void add(int index,
 N element)

Specified by:

add in interface List<N extends Comparable<N>>

add

public boolean add(N element)

Specified by:

add in interface Collection<N extends Comparable<N>>

Specified by:

add in interface List<N extends Comparable<N>>

addAll

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

Specified by:

addAll in interface Collection<N extends Comparable<N>>

Specified by:

addAll in interface List<N extends Comparable<N>>

addAll

public boolean addAll(double[] elements)

addAll

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

Specified by:

addAll in interface List<N extends Comparable<N>>

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

Specified by:

clear in interface List<N extends Comparable<N>>

contains

public boolean contains(Object object)

Specified by:

contains in interface Collection<N extends Comparable<N>>

Specified by:

contains in interface List<N extends Comparable<N>>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<N extends Comparable<N>>

Specified by:

containsAll in interface List<N extends Comparable<N>>

count

public 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 double doubleValue(long index)

Specified by:

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

get

public N get(int index)

Specified by:

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

get

public N get(long index)

Specified by:

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

indexOf

public int indexOf(Object object)

Specified by:

indexOf in interface List<N extends Comparable<N>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<N extends Comparable<N>>

Specified by:

isEmpty in interface List<N extends Comparable<N>>

iterator

public Iterator<N> iterator()

Specified by:

iterator in interface Collection<N extends Comparable<N>>

Specified by:

iterator in interface Iterable<N extends Comparable<N>>

Specified by:

iterator in interface List<N extends Comparable<N>>

lastIndexOf

public int lastIndexOf(Object object)

Specified by:

lastIndexOf in interface List<N extends Comparable<N>>

listIterator

public ListIterator<N> listIterator()

Specified by:

listIterator in interface List<N extends Comparable<N>>

listIterator

public ListIterator<N> listIterator(int index)

Specified by:

listIterator in interface List<N extends Comparable<N>>

mix

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

Specified by:

mix in interface Mutate1D.Mixable<N extends Comparable<N>>

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

remove

public N remove(int index)

Specified by:

remove in interface List<N extends Comparable<N>>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<N extends Comparable<N>>

Specified by:

remove in interface List<N extends Comparable<N>>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<N extends Comparable<N>>

Specified by:

removeAll in interface List<N extends Comparable<N>>

retainAll

public boolean retainAll(Collection<?> onlyKeep)

Specified by:

retainAll in interface Collection<N extends Comparable<N>>

Specified by:

retainAll in interface List<N extends Comparable<N>>

set

public void set(int index,
 double value)

Specified by:

set in interface Mutate1D

set

public N set(int index,
 N element)

Specified by:

set in interface List<N extends Comparable<N>>

set

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

Specified by:

set in interface Mutate1D

set

public void set(long index,
 double value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
 float value)

Specified by:

set in interface Mutate1D

size

public int size()

Description copied from interface: Structure1D

The total number of elements in this structure.

Specified by:

size in interface Collection<N extends Comparable<N>>

Specified by:

size in interface List<N extends Comparable<N>>

Specified by:

size in interface Structure1D

subList

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

Specified by:

subList in interface List<N extends Comparable<N>>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<N extends Comparable<N>>

Specified by:

toArray in interface List<N extends Comparable<N>>

toArray

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

Specified by:

toArray in interface Collection<N extends Comparable<N>>

Specified by:

toArray in interface List<N extends Comparable<N>>

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

ensureCapacity

private void ensureCapacity()