org.ojalgo.access

Interface Access1D<N extends Number>

All Superinterfaces:

Iterable<N>, Structure1D

All Known Subinterfaces:

Access2D<N>, AccessAnyD<N>, BasicMatrix, BasicSeries.NaturallySequenced<K,V>, DecompositionStore<N>, Householder<N>, HouseholderReference<N>, MatrixStore<N>, PhysicalStore<N>, PolynomialFunction<N>, Tensor<N>, TransformationMatrix.Transformable<N>

All Known Implementing Classes:

Array1D, Array2D, ArrayAnyD, BasicArray, BigArray, BigDenseStore, BigMatrix, BigPolynomial, BufferArray, CalendarDateSeries, ColumnsSupplier, ColumnView, ComplexArray, ComplexDenseStore, ComplexMatrix, ComplexNumber, ComplexNumber.Normalised, ComplexPolynomial, DataSeries, DenseArray, Equation, ExplicitTimeSeries, GenericDenseStore, Householder.Big, Householder.Complex, Householder.Generic, Householder.Primitive, ImplicitTimeSeries, LongToNumberMap, NumberList, Optimisation.Result, Primitive32Array, Primitive32Vector2, Primitive32Vector3, Primitive32Vector4, Primitive64Array, Primitive64Vector2, Primitive64Vector3, Primitive64Vector4, PrimitiveArray, PrimitiveDenseStore, PrimitiveMatrix, PrimitivePolynomial, PrimitiveSeries, PrimitiveTimeSeries, Quaternion, Quaternion.Versor, QuaternionArray, QuaternionMatrix, RationalArray, RationalMatrix, RationalPolynomial, RawStore, ReferenceTypeArray, RowsSupplier, RowView, SampleSet, ScalarArray, SparseArray, SparseStore

public interface Access1D<N extends Number>
extends Structure1D, Iterable<N>

1-dimensional accessor (get) methods. The nested interfaces declare additional methods that indirectly requires that the elements has been accessed, but they do not extends the main/outer interface. A 1D-structure can be vistiable, aggregatable and/or expose various element properties without allowing explicit access to its elements.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Access1D.Aggregatable<N extends Number> This interface complements Access1D.Visitable but does not extend it.
static interface	Access1D.Collectable<N extends Number,R extends Mutate1D.Receiver<N>>
static interface	Access1D.Elements
static class	Access1D.ElementView<N extends Number>
static interface	Access1D.IndexOf
static interface	Access1D.Sliceable<N extends Number>
static interface	Access1D.Visitable<N extends Number>

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

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Method Summary

Modifier and Type	Method and Description
default <NN extends Number,R extends Mutate1D.Receiver<NN>> Access1D.Collectable<NN,R>	asCollectable1D() Transforms this Access1D to a Access1D.Collectable of a different Number type.
static Access1D<Double>	asPrimitive1D(Access1D<?> access)
default void	axpy(double a, Mutate1D y) Will calculate y = y + a x, will add "a" times "this" to "y"
default double	dot(Access1D<?> vector) Will calculate and return the dot product of this 1D-structure and another input 1D-vector.
double	doubleValue(long index)
default ElementView1D<N,?>	elements() Returns an Iterable of ElementView1D.
static boolean	equals(Access1D<?> accessA, Access1D<?> accessB, NumberContext context)
N	get(long index)
static int	hashCode(Access1D<?> access)
default Iterator<N>	iterator()
default ElementView1D<N,?>	nonzeros()
default BaseStream<N,? extends BaseStream<N,?>>	stream(boolean parallel)
default void	supplyTo(double[] receiver)
default double[]	toRawCopy1D()
static Access1D<Double>	wrap(double[] target)
static <N extends Number> Access1D<N>	wrap(List<? extends N> target)
static <N extends Number> Access1D<N>	wrap(N[] target)
static Access1D<Double>	wrapAccess1D(double[] target) Deprecated. v45 Use wrap(double[]) instead
static <N extends Number> Access1D<N>	wrapAccess1D(List<? extends N> target) Deprecated. v45 Use wrap(List<? extends N>) instead
static <N extends Number> Access1D<N>	wrapAccess1D(N[] target) Deprecated. v45 Use #wrap(N[]) instead

Methods inherited from interface org.ojalgo.access.Structure1D

count, loopAll, loopMatching, loopRange, mapper

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

asPrimitive1D

static Access1D<Double> asPrimitive1D(Access1D<?> access)

equals

static boolean equals(Access1D<?> accessA,
                      Access1D<?> accessB,
                      NumberContext context)

hashCode

static int hashCode(Access1D<?> access)

wrap

static Access1D<Double> wrap(double[] target)

wrap

static <N extends Number> Access1D<N> wrap(List<? extends N> target)

wrap

static <N extends Number> Access1D<N> wrap(N[] target)

wrapAccess1D

@Deprecated
static Access1D<Double> wrapAccess1D(double[] target)

Deprecated. v45 Use wrap(double[]) instead

wrapAccess1D

@Deprecated
static <N extends Number> Access1D<N> wrapAccess1D(List<? extends N> target)

Deprecated. v45 Use wrap(List<? extends N>) instead

wrapAccess1D

@Deprecated
static <N extends Number> Access1D<N> wrapAccess1D(N[] target)

Deprecated. v45 Use #wrap(N[]) instead

asCollectable1D

default <NN extends Number,R extends Mutate1D.Receiver<NN>> Access1D.Collectable<NN,R> asCollectable1D()

Transforms this Access1D to a Access1D.Collectable of a different Number type.

axpy

default void axpy(double a,
                  Mutate1D y)

Will calculate y = y + a x, will add "a" times "this" to "y"

Parameters:

a - The scale

y - The "vector" to update

dot

default double dot(Access1D<?> vector)

Will calculate and return the dot product of this 1D-structure and another input 1D-vector.

Parameters:

vector - Another 1D-structure

Returns:

The dot product

doubleValue

double doubleValue(long index)

elements

default ElementView1D<N,?> elements()

Returns an Iterable of ElementView1D. It allows to iterate over the instance's element "positions" without actually extracting the elements (unless you explicitly do so).

get

N get(long index)

iterator

default Iterator<N> iterator()

Specified by:

iterator in interface Iterable<N extends Number>

nonzeros

default ElementView1D<N,?> nonzeros()

stream

default BaseStream<N,? extends BaseStream<N,?>> stream(boolean parallel)

supplyTo

default void supplyTo(double[] receiver)

toRawCopy1D

default double[] toRawCopy1D()