Module ojalgo

Package org.ojalgo.structure

Interface Structure1D

All Known Subinterfaces:

Access1D<N>, Access1D.Aggregatable<N>, Access1D.Collectable<N,R>, Access1D.Sliceable<N>, Access1D.Visitable<N>, Access2D<N>, Access2D.Aggregatable<N>, Access2D.Collectable<N,R>, Access2D.Sliceable<N>, Access2D.Visitable<N>, AccessAnyD<N>, AccessAnyD.Aggregatable<N>, AccessAnyD.Collectable<N,R>, AccessAnyD.Sliceable<N>, AccessAnyD.Visitable<N>, BasisRepresentation, Bidiagonal<N>, Cholesky<N>, DecompositionStore<N>, Eigenvalue<N>, Eigenvalue.Generalised<N>, Eigenvalue.Spectral<N>, ElementsSupplier<N>, Factory1D.Builder<I>, Factory2D.Builder<I>, FactoryAnyD.Builder<I>, Hessenberg<N>, Householder<N>, HouseholderReference<N>, InvertibleFactor<N>, LDL<N>, LDU<N>, LU<N>, Matrix2D<N,M>, MatrixDecomposition<N>, MatrixDecomposition.Determinant<N>, MatrixDecomposition.EconomySize<N>, MatrixDecomposition.Hermitian<N>, MatrixDecomposition.Ordered<N>, MatrixDecomposition.Pivoting<N>, MatrixDecomposition.RankRevealing<N>, MatrixDecomposition.Solver<N>, MatrixDecomposition.Updatable<N>, MatrixDecomposition.Values<N>, MatrixStore<N>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Mixable<N>, Mutate1D.Modifiable<N>, Mutate1D.ModifiableReceiver<N>, Mutate1D.Receiver<N>, Mutate1D.Sortable, Mutate2D, Mutate2D.Exchangeable, Mutate2D.Fillable<N>, Mutate2D.Mixable<N>, Mutate2D.Modifiable<N>, Mutate2D.ModifiableReceiver<N>, Mutate2D.Receiver<N>, MutateAnyD, MutateAnyD.Fillable<N>, MutateAnyD.Mixable<N>, MutateAnyD.Modifiable<N>, MutateAnyD.ModifiableReceiver<N>, MutateAnyD.Receiver<N>, Operate2D<N,P>, PhysicalStore<N>, PolynomialFunction<N>, QR<N>, SingularValue<N>, SparseStructure2D, Structure1D.Logical<S,B>, Structure2D, Structure2D.Logical<S,B>, Structure2D.ReducibleTo1D<R>, Structure2D.Reshapable, StructureAnyD, StructureAnyD.Logical<S,B>, StructureAnyD.ReducibleTo1D<R>, StructureAnyD.ReducibleTo2D<R>, StructureAnyD.Reshapable, TransformableRegion<N>, Tridiagonal<N>

All Known Implementing Classes:

AboveBelowStore, AbstractDecomposition, AbstractPolynomial, AbstractStore, Access1D.SelectionView, Access2D.ColumnView, Access2D.RowView, Access2D.SelectionView, AccessAnyD.MatrixView, AccessAnyD.SelectionView, AccessAnyD.VectorView, AccessSeries, AnyTensor, Array1D, Array2D, ArrayAnyD, ArrayC128, ArrayH256, ArrayQ128, ArrayR032, ArrayR064, ArrayR128, ArrayR256, ArrayZ008, ArrayZ016, ArrayZ032, ArrayZ064, BasicArray, BasicMatrix, BinaryFunctionSeries, BufferArray, BufferR032, BufferR064, BufferZ008, BufferZ016, BufferZ032, BufferZ064, ColumnsStore, ColumnsSupplier, ColumnsSupplier.SingleView, ComplexNumber, ComposingStore, CompressedSparseR064, ConjugatedStore, ConstraintsMetaData, DataBatch, DataSeries, DecomposedInverse, DeferredTridiagonal, DeferredTridiagonal.C128, DeferredTridiagonal.H256, DeferredTridiagonal.Q128, DeferredTridiagonal.R064, DeferredTridiagonal.R128, DenseArray, DenseBidiagonal, DenseBidiagonal.C128, DenseBidiagonal.H256, DenseBidiagonal.Q128, DenseBidiagonal.R064, DenseBidiagonal.R128, DenseCholesky, DenseCholesky.C128, DenseCholesky.H256, DenseCholesky.Q128, DenseCholesky.R064, DenseCholesky.R128, DenseEigenvalue, DenseHessenberg, DenseHessenberg.C128, DenseHessenberg.H256, DenseHessenberg.Q128, DenseHessenberg.R064, DenseHessenberg.R128, DenseLDL, DenseLDL.C128, DenseLDL.H256, DenseLDL.Q128, DenseLDL.R064, DenseLDL.R128, DenseLU, DenseLU.C128, DenseLU.H256, DenseLU.Q128, DenseLU.R064, DenseLU.R128, DenseMutator2D, DenseQR, DenseQR.C128, DenseQR.H256, DenseQR.Q128, DenseQR.R064, DenseQR.R128, DenseSingularValue, DenseSingularValue.C128, DenseSingularValue.H256, DenseSingularValue.Q128, DenseSingularValue.R064, DenseSingularValue.R128, DenseTableau, DenseTridiagonal, DiagonalStore, DifferencesSeries, DynamicEvD, DynamicEvD.R064, EntrySet.KeyedPrimitives, EntrySet.ObjectByte, EntrySet.ObjectDouble, EntrySet.ObjectFloat, EntrySet.ObjectInt, EntrySet.ObjectLong, EntrySet.ObjectShort, Equation, ExplicitTimeSeries, FactoryStore, GeneralEvD, GeneralEvD.R064, GeneralisedEvD, GenericStore, HermitianEvD, HermitianEvD.C128, HermitianEvD.H256, HermitianEvD.Q128, HermitianEvD.R064, HermitianEvD.R128, Householder.Generic, Householder.Primitive32, Householder.Primitive64, HouseholderColumn, HouseholderRow, IdentityStore, ImageData, ImageData.SingleChannel, ImplicitTimeSeries, IndexedMap.MappedPrimitives, InPlaceDecomposition, InvertibleFactor.IdentityFactor, Keyed1D, Keyed2D, LeftRightStore, LimitStore, LogicalStore, LongToNumberMap, LowerHessenbergStore, LowerSymmetricStore, LowerTriangularStore, MatrixC128, MatrixC128.DenseReceiver, MatrixC128.SparseReceiver, MatrixH256, MatrixH256.DenseReceiver, MatrixH256.SparseReceiver, MatrixPipeline, MatrixPipeline.BinaryOperatorLeft, MatrixPipeline.BinaryOperatorRight, MatrixPipeline.ColumnsModifier, MatrixPipeline.ColumnsReducer, MatrixPipeline.Multiplication, MatrixPipeline.RowsModifier, MatrixPipeline.RowsReducer, MatrixPipeline.Transformer, MatrixPipeline.Transpose, MatrixPipeline.UnaryOperator, MatrixQ128, MatrixQ128.DenseReceiver, MatrixQ128.SparseReceiver, MatrixR032, MatrixR032.DenseReceiver, MatrixR032.SparseReceiver, MatrixR064, MatrixR064.DenseReceiver, MatrixR064.SparseReceiver, MatrixR128, MatrixR128.DenseReceiver, MatrixR128.SparseReceiver, MatrixTensor, NumberList, OffHeapArray, OffHeapR032, OffHeapR064, OffHeapZ008, OffHeapZ016, OffHeapZ032, OffHeapZ064, OffsetStore, Optimisation.Result, PlainArray, PolynomialC128, PolynomialQ128, PolynomialR032, PolynomialR064, PolynomialR128, PolynomialR256, Primitive1D, Primitive1D.Simple, Primitive1D.Wrapper, Primitive2D, Primitive2D.Simple, Primitive2D.Wrapper, PrimitiveAnyD, PrimitiveAnyD.Simple, PrimitiveAnyD.Wrapper, PrimitiveArray, PrimitiveSeries, PrimitiveTimeSeries, ProductFormInverse, ProductFormInverse.ElementaryFactor, PrunedSeries, Quaternion, QuotientsSeries, R032Store, R064CSC, R064CSR, R064Store, RawCholesky, RawDecomposition, RawEigenvalue, RawEigenvalue.Dynamic, RawEigenvalue.General, RawEigenvalue.Symmetric, RawLU, RawQR, RawSingularValue, RawStore, ReferenceTypeArray, RepeatedColumnsStore, RepeatedRowsStore, RowsStore, RowsSupplier, RowsSupplier.SingleView, SampleSet, ScalarArray, ScalarPolynomial, SegmentedArray, SelectingStore, ShadingStore, SimplexTableau, SimultaneousTridiagonal, SingleStore, SparseArray, SparseLU, SparseLU.PermutationEta, SparseMutator2D, SparseStore, SparseStore.Builder, SparseTableau, Subregion2D, Subregion2D.ColumnsRegion, Subregion2D.LimitRegion, Subregion2D.OffsetRegion, Subregion2D.RowsRegion, Subregion2D.SynchronizedRegion, Subregion2D.TransposedRegion, Subregion2D.WrapperRegion, SuperimposedStore, TransjugatedStore, TransposedStore, UnaryFunctionSeries, UnaryOperatoStore, UpperHessenbergStore, UpperSymmetricStore, UpperTriangularStore, VectorTensor, WrapperStore, ZeroStore

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Structure1D

A (fixed size) 1-dimensional data structure.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Structure1D.BasicMapper<T>
static interface	Structure1D.IndexMapper<T>
static class	Structure1D.IntIndex
static interface	Structure1D.Logical<S extends Structure1D,B extends Structure1D.Logical<S,B>>
static class	Structure1D.LongIndex
static interface	Structure1D.LoopCallback

Method Summary

Modifier and Type	Method	Description
default long	count()	The total number of elements in this structure.
static int	index(long index)
static <T> Structure1D.IndexMapper<T>	mapper()
static int[]	newDecreasingRange(int first, int count)
static long[]	newDecreasingRange(long first, int count)
static int[]	newIncreasingRange(int first, int count)
static long[]	newIncreasingRange(long first, int count)
static long[]	replaceNullOrEmptyWithFull(long[] suggested, int fullSize)
int	size()	The total number of elements in this structure.
static int[]	toIntIndexes(long[] indexes)
static long[]	toLongIndexes(int[] indexes)

Method Detail

index

static int index(long index)

mapper

static <T> Structure1D.IndexMapper<T> mapper()

Returns:

A very simple implementation - you better come up with something else.

newDecreasingRange

static int[] newDecreasingRange(int first,
                                int count)

newDecreasingRange

static long[] newDecreasingRange(long first,
                                 int count)

newIncreasingRange

static int[] newIncreasingRange(int first,
                                int count)

newIncreasingRange

static long[] newIncreasingRange(long first,
                                 int count)

replaceNullOrEmptyWithFull

static long[] replaceNullOrEmptyWithFull(long[] suggested,
                                         int fullSize)

toIntIndexes

static int[] toIntIndexes(long[] indexes)

toLongIndexes

static long[] toLongIndexes(int[] indexes)

count

default long count()

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.

size

int size()

The total number of elements in this structure.