org.ojalgo.array
Class Array1D<N extends Number>

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<N>
          extended by org.ojalgo.array.Array1D<N>
All Implemented Interfaces:
Serializable, Iterable<N>, Collection<N>, List<N>, RandomAccess, Access1D<N>

public final class Array1D<N extends Number>
extends AbstractList<N>
implements Access1D<N>, RandomAccess, Serializable

Array1D

Author:
apete
See Also:
Serialized Form

Nested Class Summary
static interface Array1D.Factory<N extends Number>
           
 
Field Summary
static Array1D.Factory<BigDecimal> BIG
           
static Array1D.Factory<ComplexNumber> COMPLEX
           
 int length
           
static Array1D.Factory<Double> PRIMITIVE
           
static Array1D.Factory<RationalNumber> RATIONAL
           
 
Method Summary
 boolean contains(Object anObj)
           
 Array1D<N> copy()
           
 double doubleValue(int anInd)
           
 void fillAll(N aNmbr)
           
 void fillRange(int aFirst, int aLimit, N aNmbr)
           
 N get(int anInd)
           
 int getIndexOfLargestInRange(int aFirst, int aLimit)
           
 int indexOf(Object anObj)
           
 boolean isAbsolute(int anInd)
           
 boolean isAllZeros()
           
 boolean isEmpty()
           
 boolean isPositive(int anInd)
           
 boolean isRangeZeros(int aFirst, int aLimit)
           
 boolean isReal(int anInd)
           
 boolean isZero(int anInd)
           
 Iterator<N> iterator()
           
 void modifyAll(BinaryFunction<N> aFunc, N aNmbr)
           
 void modifyAll(N aNmbr, BinaryFunction<N> aFunc)
           
 void modifyAll(ParameterFunction<N> aFunc, int aParam)
           
 void modifyAll(UnaryFunction<N> aFunc)
           
 void modifyMatching(Access1D<N> anArray, BinaryFunction<N> aFunc)
           
 void modifyMatching(BinaryFunction<N> aFunc, Access1D<N> anArray)
           
 void modifyRange(int aFirst, int aLimit, BinaryFunction<N> aFunc, N aNmbr)
           
 void modifyRange(int aFirst, int aLimit, N aNmbr, BinaryFunction<N> aFunc)
           
 void modifyRange(int aFirst, int aLimit, ParameterFunction<N> aFunc, int aParam)
           
 void modifyRange(int aFirst, int aLimit, UnaryFunction<N> aFunc)
           
 int searchAscending(N aKey)
          Asssumes you have first called sortAscending().
 int searchDescending(N aKey)
          Asssumes you have first called sortDescending().
 void set(int anInd, double aNmbr)
           
 N set(int anInd, N aNmbr)
           
 int size()
           
 void sortAscending()
           
 void sortDescending()
           
 Array1D<N> subList(int aFirst, int aLimit)
           
 double[] toRawCopy()
           
 Scalar<N> toScalar(int anInd)
           
 void visitAll(AggregatorFunction<N> aVisitor)
           
 void visitRange(int aFirst, int aLimit, AggregatorFunction<N> aVisitor)
           
 
Methods inherited from class java.util.AbstractList
add, add, addAll, clear, equals, hashCode, lastIndexOf, listIterator, listIterator, remove
 
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, remove, removeAll, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
addAll, containsAll, remove, removeAll, retainAll, toArray, toArray
 

Field Detail

BIG

public static final Array1D.Factory<BigDecimal> BIG

COMPLEX

public static final Array1D.Factory<ComplexNumber> COMPLEX

PRIMITIVE

public static final Array1D.Factory<Double> PRIMITIVE

RATIONAL

public static final Array1D.Factory<RationalNumber> RATIONAL

length

public final int length
Method Detail

contains

public boolean contains(Object anObj)
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()

doubleValue

public double doubleValue(int anInd)

fillAll

public void fillAll(N aNmbr)

fillRange

public void fillRange(int aFirst,
                      int aLimit,
                      N aNmbr)

get

public N get(int anInd)
Specified by:
get in interface List<N extends Number>
Specified by:
get in class AbstractList<N extends Number>

getIndexOfLargestInRange

public int getIndexOfLargestInRange(int aFirst,
                                    int aLimit)

indexOf

public int indexOf(Object anObj)
Specified by:
indexOf in interface List<N extends Number>
Overrides:
indexOf in class AbstractList<N extends Number>

isAbsolute

public boolean isAbsolute(int anInd)
See Also:
Scalar.isAbsolute()

isAllZeros

public boolean isAllZeros()

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>

isPositive

public boolean isPositive(int anInd)
See Also:
Scalar.isPositive()

isRangeZeros

public boolean isRangeZeros(int aFirst,
                            int aLimit)

isReal

public boolean isReal(int anInd)
See Also:
Scalar.isReal()

isZero

public boolean isZero(int anInd)
See Also:
Scalar.isZero()

iterator

public final 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>
Overrides:
iterator in class AbstractList<N extends Number>

modifyAll

public void modifyAll(BinaryFunction<N> aFunc,
                      N aNmbr)

modifyAll

public void modifyAll(N aNmbr,
                      BinaryFunction<N> aFunc)

modifyAll

public void modifyAll(ParameterFunction<N> aFunc,
                      int aParam)

modifyAll

public void modifyAll(UnaryFunction<N> aFunc)

modifyMatching

public void modifyMatching(Access1D<N> anArray,
                           BinaryFunction<N> aFunc)

modifyMatching

public void modifyMatching(BinaryFunction<N> aFunc,
                           Access1D<N> anArray)

modifyRange

public void modifyRange(int aFirst,
                        int aLimit,
                        BinaryFunction<N> aFunc,
                        N aNmbr)

modifyRange

public void modifyRange(int aFirst,
                        int aLimit,
                        N aNmbr,
                        BinaryFunction<N> aFunc)

modifyRange

public void modifyRange(int aFirst,
                        int aLimit,
                        ParameterFunction<N> aFunc,
                        int aParam)

modifyRange

public void modifyRange(int aFirst,
                        int aLimit,
                        UnaryFunction<N> aFunc)

searchAscending

public int searchAscending(N aKey)
Asssumes you have first called sortAscending().


searchDescending

public int searchDescending(N aKey)
Asssumes you have first called sortDescending().


set

public void set(int anInd,
                double aNmbr)

set

public N set(int anInd,
             N aNmbr)
Specified by:
set in interface List<N extends Number>
Overrides:
set in class AbstractList<N extends Number>

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 class AbstractCollection<N extends Number>
Returns:
The total number of elements contained in this structure

sortAscending

public void sortAscending()

sortDescending

public void sortDescending()

subList

public Array1D<N> subList(int aFirst,
                          int aLimit)
Specified by:
subList in interface List<N extends Number>
Overrides:
subList in class AbstractList<N extends Number>

toRawCopy

public double[] toRawCopy()

toScalar

public Scalar<N> toScalar(int anInd)

visitAll

public void visitAll(AggregatorFunction<N> aVisitor)

visitRange

public void visitRange(int aFirst,
                       int aLimit,
                       AggregatorFunction<N> aVisitor)