All Classes and Interfaces
Class
Description
1-dimensional accessor (get) methods.
This interface complements Access1D.Visitable but does not extend it.
2-dimensional accessor methods
N-dimensional accessor methods
[l]T[x] + c
Do not cache instances of this class!
Deprecated.
https://www.alphavantage.co/documentation/
Alternator
(currency) amount as in "amount = price * quatity"
Array1D
Array2D
ArrayAnyD
A one- and/or arbitrary-dimensional array of ComplexNumber.
A one- and/or arbitrary-dimensional array of Quaternion.
A one- and/or arbitrary-dimensional array of RationalNumber.
A one- and/or arbitrary-dimensional array of double.
A one- and/or arbitrary-dimensional array of double.
A one- and/or arbitrary-dimensional array of Quadruple.
A one- and/or arbitrary-dimensional array of BigDecimal.
A one- and/or arbitrary-dimensional array of double.
A one- and/or arbitrary-dimensional array of double.
A one- and/or arbitrary-dimensional array of double.
A one- and/or arbitrary-dimensional array of double.
https://en.wikipedia.org/wiki/Activation_function
ASCII codes
0
1
2
3
4
5
6
7
0
NUL
SOH
STX
ETX
EOT
ENQ
ACK
BEL
8
BS
HT
LF
VT
FF
CR
SO
SI
16
DLE
DC1
DC2
DC3
DC4
NAK
SYN
ETB
24
CAN
EM
SUB
ESC
FS
GS
RS
US
32
SP
!
A BasicArray is 1-dimensional, but designed to easily be extended or encapsulated, and then treated as
arbitrary-dimensional.
For when you want to emphasise that something is a (mathematical) function.
BasicLogger is not meant to replace any other logging library.
Temporarily store data/text.
How much memory, and how many threads share that memory.
A base class for, easy to use, immutable (thread safe) matrices with a rich feature set.
A (CSV) parser interface.
A BasicSeries is a SortedMap with:
Keys restricted to Comparable (the keys have a natural order)
Values restricted to Comparable (the values are "numeric" as in extending
Number
or implementing NumberDefinition.A series with naturally sequenced keys - given any key there is a natural "next" key, e.g. with a
series of daily values the natural next key is the next day.
When you're going to instantiate multiple
BatchNode:s and you want them to share some properties,
this is a convenient alternative.A batch processing data node for when there's no way to fit the data in memory.
A general matrix [A] can be factorized by similarity transformations into the form [A]=[LQ][D][RQ]
-1 where:
[A] (m-by-n) is any, real or complex, matrix
[D] (r-by-r) or (m-by-n) is, upper or lower, bidiagonal
[LQ] (m-by-r) or (m-by-m) is orthogonal
[RQ] (n-by-r) or (n-by-n) is orthogonal
r = min(m,n)
Only the reference type parameter (BigDecimal) methods are actually implemented.
A
BigDecimal based implementation of the Scalar interface.A BinaryFunction with a set/fixed first argument.
A BinaryFunction with a set/fixed second argument.
The frequency in count indepedent trials, each with probability probability, has a binomial distribution.
BooleanFormat doesn't do anything useful, but it was needed for BooleanContext (that doesn't
do much either).
The odd member among the array implementations.
Each/every business object interface should extends this
BusinessObject interface (and
preferably nothing else).
Designed to complement CalendarDate.
Designed to complement CalendarDate.
https://en.wikipedia.org/wiki/Cauchy_distribution
A circular char buffer - an Appendable CharSequence that always hold exactly
65536 characters.
Cholesky: [A] = [L][L]H (or [R]H[R])
Strategy interface for clustering algorithms.
Sparse columns – columns can be added and removed.
https://reference.wolfram.com/language/tutorial/CombinatorialFunctions.html
ComplexNumber is an immutable complex number class.
Conjugate Gradient solver for symmetric positive-definite systems [A][x]=[b].
Constant valued function - always returns the same value.
1/2 [x]T[Q][x] - [l]T[x]
ConvexSolver solves optimisation problems of the form:
A
CoordinationSet is used to coordinate a set of CalendarDateSeries instances.A reusable data batch.
Various data processors that could be useful when doing data science or similar.
A
DataInput based FromFileReader.DataTransform is a functional interface that can be used to transform data.
A
DataOutput based ToFileWriter.This
TypeContext deals with the old Date.Will switch between any/all known parsers producing
DatePrice subclasses.
Only classes that will act as a delegate to a MatrixDecomposition implementation from this
package should implement this interface.
Each and every element occupies memory and holds a value.
Will detect which delegate parser to use.
The discrete Fourier transform (DFT) converts a finite sequence of equally-spaced samples of a function
into a same-length sequence of equally-spaced samples of the discrete-time Fourier transform (DTFT), which
is a complex-valued function of frequency.
Enumeration of common distance and dissimilarity measures for coordinate feature vectors.
Distribution
Divide an index (int) range into smaller parts, and conquer each part in parallel.
A conquerer is a function that will be called with a range of indices to conquer.
A configurable divider that can be used to divide a range of indices and conquer each part in parallel.
Represents a portfolio on the efficient fronter.
[A] = [V][D][V]-1 ([A][V] = [V][D])
[A] = any square matrix.
[V] = contains the eigenvectors as columns.
[D] = a diagonal matrix with the eigenvalues on the diagonal (possibly in blocks).
“Spectral decomposition” refers specifically to the orthogonal/unitary eigen-decomposition of a normal
matrix (most commonly Hermitian / symmetric).
An
ElementsSupplier is not necessarily (or not yet) a matrix, but something from which the elements
of a matrix can be derived.Singleton (immutable)
Map:s with primitive valued specialisations.Allows you to wrap and treat two arrays as a
Collection of key-value pairs.Distribution of the sum of aCount random variables with an exponential distribution with parameter aLambda.
To help implement exact decimal numbers with a fixed number of decimal places (fixed scale).
Distribution of length of life when no aging.
Expression represents a mathematical expression in the optimization model that can serve as either a
constraint or a component of the objective function.
Lets you construct optimisation problems by combining (mathematical) expressions in terms of variables.
Counts of different kinds of model entities.
Connects solver constraints and variables back to model entities.
Optimisation.Solver:s that should be usabale from ExpressionsBasedModel needs to
implement a subclass of this.Various switches that can be set by solver integrations to control its own behaviour.
Execute submitted tasks/methods in external JVM processes with arbitrary
Serializable
arguments/return.For when the structures can be either dense or sparse.
For when the structures can be either dense or sparse.
For when the structures can be either dense or sparse.
Facade for clustering objects represented by float feature vectors.
A field is a commutative ring (even the multiplication operation) with notions of addition, subtraction,
multiplication, and division.
A source of (historical) financial time series data.
A FinancePortfolio is primarily a set of portfolio asset weights.
An array (double[] or float[]) builder/converter.
A
Map that can forget entries after a specified period of time – a cache in other words.The specifications of
TypeCache to allow for another implementation.Abstract base class for TypeContext implementations backed by Format.
This is the real coefficient trigonometric form of the Fourier series.
Count the occurrence of different keys
A predefined/standard set of functions.
Distribution of the sum of aCount random variables with an exponential distribution with parameter aLambda.
This GaussianField class is a generalization, as well as the underlying implementation, of
GaussianProcess.
A Gaussian process is a
RandomProcess where each variable has a normal distribution.Stationary Gauss–Seidel iteration for solving [A][x]=[b] with non-zero diagonal entries.
Contains the outline of the k-means algorithm, but designed for customisation.
A generic implementation of PhysicalStore.
The number of required trials until an event with probability aProbability occurs has a geometric
distribution.
Diffusion process defined by a stochastic differential equation:
An alternative MIP solver using Gomory Mixed Integer (GMI) cuts – purely iterative with no branching.
Greedy clustering algorithm.
A group is a set of elements paired with a binary operation.
The first element in the array should correspond to total system resources; the total amount of RAM and
the total number of threads (Typically the same as what is returned by
Runtime.availableProcessors()).
Hessenberg: [A] = [Q][H][Q]T A general square matrix [A] can be decomposed by orthogonal
similarity transformations into the form [A]=[Q][H][Q]T where
[H] is upper (or lower) hessenberg matrix
[Q] is orthogonal/unitary
Reads IDX-files as described at THE MNIST DATABASE page.
Deprecated.
It needs to be updated to function...
https://iextrading.com/developer/docs/#chart
Treats an image as a matrix.
Wrap two arrays (of keys and values) and treat the result as a
Map.An array of int:s (indices) that are partitioned to be either "included" or "excluded".
An in-memory "file" that can be used with some
implementations instead of a
ToFileWriter and/or
invalid reference
FromFileReaderrFile.Apart from being able to configure various standard properties, you can also provide your own
ModelStrategy factory.Gomory Mixed Integer Cut Configuration
A
Optimisation.Solver implementation that wraps an ExpressionsBasedModel.A chainable and reversible in-place (equation system) solver.
Base class for iterative solvers of large linear systems [A][x]=[b].
Simple diagonal (Jacobi) preconditioner: M = diag(A), apply M^{-1} x = x ./ diag(A).
Stationary Jacobi iteration for solving [A][x]=[b] with non-zero diagonal entries.
B byte signed byte
C char Unicode character code point in the Basic Multilingual Plane,
encoded with UTF-16
D double double-precision floating-point value
F float single-precision floating-point value
I int integer
J long long integer
L ClassName ; reference an instance of class ClassName
S short signed short
Z boolean true or false
[ reference one array dimension
A pair, like
Map.Entry without Map.Entry.setValue(Object).A pair of the same type.
LDL: [A] = [L][D][L]H (or [R]H[D][R])
LDU: [A] = [L][D][U] ( [PL][L][D][U][PU] )
[l]T[x]
Compared to
this builder:
1) Accepts inequality constraints
2) Has relaxed the requiremnt on the RHS to be non-negative (both equalities and inequalities)
invalid reference
LinearSolver.StandardBuilder1) Accepts inequality constraints
2) Has relaxed the requiremnt on the RHS to be non-negative (both equalities and inequalities)
A continuous distribution in which the logarithm of a variable has a normal distribution.
A
SortedMap with primitive valued long keys and Comparable values (incl. possibly primitive
double values).LU: [A] = [L][U]
MarketEquilibrium translates between the market portfolio weights and the equilibrium excess returns.
The Markowitz model, in this class, is defined as:
The number sets supported by ojAlgo, paired with a declaration of how they are implemented/approximated.
Definition of what's common to
BasicMatrix and MatrixStore.A matrix (linear algebra) with Complex
NumberSet.C elements, implemented using dual 64-bit double
values. (2 x 64 = 128)Notation used to describe the various matrix decompositions:
[A] could be any matrix.
Several matrix decompositions can be expressed "economy sized" - some rows or columns of the decomposed
matrix parts are not needed for the most releveant use cases, and can therefore be left out.
Some matrix decompositions are only available with hermitian (symmetric) matrices or different
decomposition algorithms could be used depending on if the matrix is hemitian or not.
The pivot or pivot element is the element of a matrix, or an array, which is selected first by an
algorithm (e.g.
A rank-revealing matrix decomposition of a matrix [A] is a decomposition that is, or can be transformed
to be, on the form [A]=[X][D][Y]T where:
[X] and [Y] are square and well conditioned.
[D] is diagonal with nonnegative and non-increasing values on the diagonal.
Eigenvalue and Singular Value decompositions can calculate the "values" only.
MatrixFactory creates instances of classes that implement the BasicMatrix
interface and have a constructor that takes a MatrixStore as input.
A matrix (linear algebra) with Quaternion
NumberSet.H elements, implemented using four 64-bit
double values. (4 x 64 = 256)A matrix (linear algebra) with Rational
NumberSet.Q elements, implemented using dual 64-bit long
values. (2 x 64 = 128)A matrix (linear algebra) with Real
NumberSet.R elements, approximated by 32-bit float.A matrix (linear algebra) with Real
NumberSet.R elements, approximated by 64-bit double.A matrix (linear algebra) with Real
NumberSet.R elements, approximated by 128-bit floating-point
values (implemented using dual 64-bit double). (2 x 64 = 128)
A MatrixStore is a two dimensional store of numbers/scalars.
MemoryEstimator
Description of a (static) method to invoke in a child JVM.
Approximate Minimum Degree (AMD) style ordering for pre-ordering a symmetric sparse matrix prior to
numerical factorisation (Cholesky or LDL).
Minimal Residual (MINRES) solver for symmetric (possibly indefinite) square systems.
Math utilities missing from
Math.ModelEntity is the abstract base class for optimization model components such as variables and expressions
in ojAlgo's optimization framework.
This base class contains some model/problem specific data required by the
IntegerSolver.When implementing your own
ModelStrategy extending this abstract class is a good starting
point.An example
ExactDecimal implementation corresponding to the SQL data type MONEY or DECIMAL(19,4).Twice (Continuously) Differentiable Multiary Function
Lightweight mutable wrapper around a list of
Equation rows that delegates solving to an
IterativeSolverTask.1-dimensional mutator methods
Fills the target
Mix/combine the previously existing value, at index, with the supplied addend.
Anything/everything that does not require interaction with already existing elements.
2-dimensional mutator methods
A few operations with no 1D or AnyD counterpart.
Apart from extending
Mutate2D.Receiver this interface extends
Mutate2D.Modifiable and Mutate2D.Exchangeable which both imply access to
existing elements as well as Access2D that dictates explicit access.N-dimensional mutator methods
An Artificial Neural Network (ANN) builder.
An Artificial Neural Network (ANN) builder/trainer.
Under general conditions, the sum of a large number of random variables is approximately normally
distributed (the central limit theorem).
Think of this as a MathContext that specifies both precision and scale.
An interface defining a "Number".
Think of this as an
ArrayList that can only contain numbers, but with a few extra features.Some special sets of numbers commonly used in mathematics
Off heap memory array.
To be implemented by classes that are not directly mutable themselves, but that can operate on the elements
of some internal/future 2D data structure – similar to streams in some sense.
Constraint
An
Optimisation.Model implementation should not depend on any specific
Optimisation.Solver, and Optimisation.Solver implementations should be usable
independently of any Optimisation.Model.Objective
Basic description of the size/structure of an optimisation problem.
An Optimisation.Solver instance implements a specific optimisation algorithm.
Basic usage:
Put optimisation problems on the solve queue by calling
OptimisationService.putOnQueue(Sense, byte[], FileFormat)
Check the status of the optimisation by calling OptimisationService.getStatus(String) – is it OptimisationService.Status.DONE
or still OptimisationService.Status.PENDING?Experimental parallelised stationary iteration based on Gauss–Seidel-style in-place updates.
A set of standard levels of parallelism derived from the number of available cores and optionally capped by
reserving a specified amount of memory per thread.
A ParameterFunction with a set/fixed parameter.
Password
A periodic function is a function that repeats its values in regular intervals or periods.
PhysicalStore:s, as opposed to MatrixStore:s, are mutable.
Array class limited by integer (int, not long) indices.
http://mathworld.wolfram.com/PochhammerSymbol.html
https://en.wikipedia.org/wiki/Falling_and_rising_factorials
Immutable coordinate point used by the clustering utilities.
Simple factory that generates consecutive ids and ensures consistent dimensionality.
The Poisson distribution is a discrete probability distribution that expresses the probability of a given
number of events occurring in a fixed interval of time and/or space if these events occur with a known
average rate and independently of the time since the last event.
A Poisson process is a stochastic process which counts the number of events in a given time interval.
BigPolynomial
Pluggable preconditioner for iterative linear system solvers.
price or exchange rate as in "amount = price * quatity" or "amount = rate * amount"
Only the primitive parameter (double) methods are actually implemented.
Intended as a "boxed" version of any/all primitive numeric types.
Drive a set of processes simultaneously – correlated or uncorrelated.
A simple wrapper around an
ExecutorService that makes it easier to process collections of items in
parallel.Options to control the child JVM process used by ProcessExecutorService.
Child JVM entrypoint.
Incorrect use of the API.
[x]T[Q][x] + c
Quasi-Minimal Residual (QMR) solver for general nonsymmetric square systems.
QR: [A] = [Q][R] Decomposes [this] into [Q] and [R] where:
[Q] is an orthogonal matrix (orthonormal columns).
[x]T[Q][x] + [l]T[x] + c
https://stackoverflow.com/questions/66962567/how-to-emulate-double-precision-using-two-floats-in-opengl-es
RationalFunction
quantity as in "amount = price * quatity"
A
implementation of PhysicalStore.
invalid reference
float
A compressed sparse column (CSC) matrix store implementation for double precision values.
A builder for constructing
R064CSR instances.A compressed sparse row (CSR) matrix store implementation for double precision values.
A builder for constructing CSR matrix stores. the dimensions of the matrix are determined by the
highest row and column indices set.
A
implementation of PhysicalStore.
invalid reference
double
RandomNumber
A random/stochastic process (a series of random variables indexed by time or space) representing the
evolution of some random value.
RationalFunction
Uses double[][] internally.
A simple container for a pair of double (R064) arrays, one holding values and the other their reciprocal.
Something that potentially could go wrong, actually did go wrong.
A one- and/or arbitrary-dimensional array of Comparable.
Locate/fetch resources such as csv, json or text/html.
A ring is a commutative group (addition operation) with a second binary operation (multiplication) that is
distributive over the commutative group operation and is associative.
Sparse rows – rows can be added and removed.
A Scalar is:
A one- and/or arbitrary-dimensional array of Scalar.
Divides a large file in segments and then reads those (in parallel) using memory mapped files (memory
mapped file segments).
An extrapolator produces new data points to existing series.
A forecaster is restricted to CalendarDate keys and is intended to predict something related
to future keys/dates.
A function that maps from a (collection of) series and one or more keys to a series of numbers.
An interpolator produces new data points to existing series, inbetween existing keys.
Make http/https calls.
This is actually a wrapper of a future response.
When you need to make a sequence of calls maintaining some state inbetween calls.
Similarity / distance utilities commonly used in ML and information retrieval.
Similarity measures quantify how alike two items are.
SimpleAsset is used to describe 1 asset (portfolio member).
Singular Value: [A] = [U][S][V]T Decomposes [this] into [U], [S] and [V] where:
[U] is an orthogonal matrix.
Only stores nonzero elements and/or elements specifically set by the user.
Quasi-Definite LDL (QDLDL) sparse decomposition.
Symbolic elimination tree
A sparse matrix (this implementation) is not thread safe.
May be a preferable way to build a sparse matrix if:
You don't know the number of nonzero elements in advance.
Additional methods for sparse matrix implementations that store only non-zero elements.
Symmetric Successive Over-Relaxation (SSOR) preconditioner with relaxation factor omega (ω).
Process with fixed mean and (possibly) fluctuating variance given by a
ScedasticityModel.This stopwatch is always running.
StringContext
A (fixed size) 1-dimensional data structure.
A (fixed size) 2-dimensional data structure.
A (fixed size) any-dimensional data structure.
An implementation of
TypeContext that is implemented in terms of DateTimeFormatter and
TemporalAdjuster.An n:th-rank tensor in m-dimensional space is a mathematical object that has n indices and m^n components
and obeys certain transformation rules.
A reusable delimited "text line" builder.
A transformable 2D (sub)region.
Represents an in-place transformation of a 1D data structure – the transformable is mutated.
Represents an in-place transformation of a 2D data structure – the transformable is mutated.
Represents an in-place transformation of a AnyD data structure – the transformable is mutated.
Tridiagonal: [A] = [Q][D][Q]H Any square symmetric (hermitian) matrix [A] can be factorized by
similarity transformations into the form, [A]=[Q][D][Q]-1 where [Q] is an orthogonal (unitary)
matrix and [D] is a real symmetric tridiagonal matrix.
A
TwoStepMapper is a mapper/reducer that is used in 2 steps – TwoStepMapper.consume(Object) and
TwoStepMapper.getResults().Enables combining the state of multiple instances.
A frequency counter that optionally filters some elements when merging subresults.
Enables merging the results from multiple instances.
Will calculate the function value for each input item, and cache the result.
Deprecated.
v56 Use
ForgetfulMap.newValueCache(Object, java.util.function.Function) instead.A type context provides two basic services:
It enforces some sort of rule/limit regarding size, accuracy or similar.
Certain waiting times.
Variable represents a decision variable in an optimization model.
A vector space is a set of objects called vectors, where a vector is a tuple of fields/scalars/numbers.
Useful as length of life distribution in reliability theory.
Deprecated.
This class implements the Z-transform for a given complex number z.