Package org.ojalgo.structure
Interface Access1D<N extends Comparable<N>>
- All Superinterfaces:
Structure1D
- All Known Subinterfaces:
Access2D<N>
,AccessAnyD<N>
,DecompositionStore<N>
,Householder<N>
,HouseholderReference<N>
,Matrix2D<N,
,M> MatrixStore<N>
,Mutate1D.ModifiableReceiver<N>
,Mutate2D.ModifiableReceiver<N>
,MutateAnyD.ModifiableReceiver<N>
,PhysicalStore<N>
,PolynomialFunction<N>
,TransformableRegion<N>
- All Known Implementing Classes:
AboveBelowStore
,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
,ConjugatedStore
,DataBatch
,DataSeries
,DenseArray
,DenseMutator2D
,DenseTableau
,DiagonalStore
,DifferencesSeries
,EntrySet.KeyedPrimitives
,EntrySet.ObjectByte
,EntrySet.ObjectDouble
,EntrySet.ObjectFloat
,EntrySet.ObjectInt
,EntrySet.ObjectLong
,EntrySet.ObjectShort
,Equation
,ExplicitTimeSeries
,FactoryStore
,GenericStore
,Householder.Generic
,Householder.Primitive32
,Householder.Primitive64
,HouseholderColumn
,HouseholderRow
,IdentityStore
,ImageData
,ImageData.SingleChannel
,ImplicitTimeSeries
,IndexedMap.MappedPrimitives
,IterativeASS.SchurComplementSolver
,LeftRightStore
,LimitStore
,LogicalStore
,LongToNumberMap
,LowerHessenbergStore
,LowerSymmetricStore
,LowerTriangularStore
,MatrixC128
,MatrixC128.DenseReceiver
,MatrixH256
,MatrixH256.DenseReceiver
,MatrixQ128
,MatrixQ128.DenseReceiver
,MatrixR032
,MatrixR032.DenseReceiver
,MatrixR064
,MatrixR064.DenseReceiver
,MatrixR128
,MatrixR128.DenseReceiver
,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
,PrunedSeries
,Quaternion
,QuotientsSeries
,R032Store
,R064Store
,RawStore
,ReferenceTypeArray
,RepeatedColumnsStore
,RepeatedRowsStore
,RowsStore
,RowsSupplier
,RowsSupplier.SingleView
,SampleSet
,ScalarArray
,ScalarPolynomial
,SegmentedArray
,SelectingStore
,ShadingStore
,SimplexTableau
,SingleStore
,SparseArray
,SparseStore
,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
1-dimensional accessor (get) methods. The nested interfaces declare additional methods that implicitly
require that the elements have 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.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Access1D.Aggregatable<N extends Comparable<N>>
This interface complements Access1D.Visitable but does not extend it.static interface
Access1D.Collectable<N extends Comparable<N>,
R extends Mutate1D> static final class
Access1D.ElementView<N extends Comparable<N>>
static final class
Access1D.SelectionView<N extends Comparable<N>>
static interface
Access1D.Sliceable<N extends Comparable<N>>
static interface
Access1D.Visitable<N extends Comparable<N>>
Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D
Structure1D.BasicMapper<T>, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S extends Structure1D,
B extends Structure1D.Logical<S, B>>, Structure1D.LongIndex, Structure1D.LoopCallback -
Method Summary
Modifier and TypeMethodDescriptiondefault <NN extends Comparable<NN>,
R extends Mutate1D.Receiver<NN>>
Access1D.Collectable<NN, R> asKeyed1D
(Structure1D.IndexMapper<K> indexMapper) asPrimitive1D
(Access1D<?> access) Deprecated.default void
axpy
(double a, Mutate1D.Modifiable<?> y) Will calculate y = y + a x, will add "a" times "this" to "y"default byte
byteValue
(int index) default byte
byteValue
(long index) default double
Will calculate and return the dot product of this 1D-structure and another input 1D-vector.double
doubleValue
(int index) default double
doubleValue
(long index) default ElementView1D
<N, ?> elements()
Returns an Iterable of ElementView1D.static boolean
equals
(Access1D<?> accessA, Access1D<?> accessB, NumberContext accuracy) Tests if the two data structures are numerically equal to the given accuracy.default float
floatValue
(int index) default float
floatValue
(long index) get
(long index) default int
intValue
(int index) default int
intValue
(long index) default long
longValue
(int index) default long
longValue
(long index) default ElementView1D
<N, ?> nonzeros()
Similar toelements()
but avoids elements that are structurally known to be zero.select
(long... selection) Creates a view of the underlying data structure of only the selected elements.default short
shortValue
(int index) default short
shortValue
(long index) default void
supplyTo
(double[] receiver) default double[]
static String
wrap
(double... target) Deprecated.v54 UsePrimitive1D.of(double...)
orArrayR064.wrap(double...)
insteadstatic <N extends Comparable<N>>
Access1D<N> static <N extends Comparable<N>>
Access1D<N> wrap
(N[] target) Methods inherited from interface org.ojalgo.structure.Structure1D
count, size
-
Method Details
-
asPrimitive1D
Deprecated.v54 UsePrimitive1D.wrap(Structure1D)
instead -
equals
Tests if the two data structures are numerically equal to the given accuracy. (Only works with real numbers, and can't handle more than "double precision".) You have to implement your own version to handle other cases. -
toString
-
wrap
Deprecated.v54 UsePrimitive1D.of(double...)
orArrayR064.wrap(double...)
instead -
wrap
-
wrap
-
asCollectable1D
default <NN extends Comparable<NN>,R extends Mutate1D.Receiver<NN>> Access1D.Collectable<NN,R> asCollectable1D() -
asKeyed1D
-
axpy
Will calculate y = y + a x, will add "a" times "this" to "y"- Parameters:
a
- The scaley
- The "vector" to update
-
byteValue
default byte byteValue(int index) -
byteValue
default byte byteValue(long index) -
dot
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(int index) -
doubleValue
default double doubleValue(long index) -
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). -
floatValue
default float floatValue(int index) -
floatValue
default float floatValue(long index) -
get
-
intValue
default int intValue(int index) -
intValue
default int intValue(long index) -
longValue
default long longValue(int index) -
longValue
default long longValue(long index) -
nonzeros
Similar toelements()
but avoids elements that are structurally known to be zero. (That does not eliminate all zero-values from this view.) With an arbitrary (dense) unstructured implementation thenonzeros()
andelements()
methods do the same thing! Only some specific implementations are able to actually exploit structure/sparsity to view fewer elements. -
select
Creates a view of the underlying data structure of only the selected elements. -
shortValue
default short shortValue(int index) -
shortValue
default short shortValue(long index) -
supplyTo
default void supplyTo(double[] receiver) -
toRawCopy1D
default double[] toRawCopy1D()
-
Primitive1D.wrap(Structure1D)
instead