Class MutableSolver

java.lang.Object

org.ojalgo.matrix.task.iterative.MutableSolver

All Implemented Interfaces:

MatrixTask<Double>, SolverTask<Double>

Direct Known Subclasses:

IterativeASS.SchurComplementSolver

public abstract class MutableSolver
extends Object
implements SolverTask<Double>

Lightweight mutable wrapper around a list of Equation rows that delegates solving to an IterativeSolverTask.

Purpose

• Build and update an equation system incrementally by adding/removing Equation rows.
• Reuse an iterative solver across solves without rebuilding matrices.
• Support workflows where the active rows/columns change between iterations.

How it works

• Subclass to define the problem size and to provide the delegate iterative solver.
• Call add(Equation) and remove(Equation) to maintain the active set of rows. Rows are kept sorted by their Equation.index.
• Call resolve(PhysicalStore) (or resolve(PhysicalStore, Access1D)) to solve [A][x]=[b] using the current rows and right-hand sides stored in each Equation.
• All methods that solve or preallocate simply forward to the delegate.

Contract

• Every added Equation must have Equation.size() equal to the problem size passed to the constructor; otherwise an IllegalArgumentException is thrown.
• The provided solution vector represents the active variable subspace; residuals are formed against that vector and the current row bodies only.
• Thread-safety: instances are not thread-safe; do not mutate the row set while solving.

Example usage

• A subclass can also implement MatrixStore and dynamically assemble a Schur-complement-style system by adding/removing rows, and then call resolve(PhysicalStore) to compute the unknowns.

Nested Class Summary

Nested classes/interfaces inherited from interface SolverTask

SolverTask.Factory<N>

Field Summary

Fields

Modifier and Type	Field	Description
private final IterativeSolverTask	myDelegate
private final List<Equation>	myRows
private final int	mySize

Fields inherited from interface SolverTask

C128, H256, Q128, R064, R128

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MutableSolver(IterativeSolverTask delegate, int size)

Method Summary

Modifier and Type	Method	Description
boolean	add(Equation row)
void	clear()
protected double	doubleValue(int row, int col)
protected Stream<Equation>	equations()
protected final IterativeSolverTask	getDelegate()
PhysicalStore<Double>	preallocate(int nbEquations, int nbVariables, int nbSolutions)
boolean	remove(Equation row)
double	resolve(PhysicalStore<Double> solution)	A variation of solve(Access2D, Access2D, PhysicalStore) where the system body has already been set up using add(Equation).
double	resolve(PhysicalStore<Double> solution, Access1D<?> rhs)	Same as resolve(PhysicalStore) but replaces the RHS values before solving.
MatrixStore<Double>	solve(Access2D<?> body, Access2D<?> rhs, PhysicalStore<Double> current)	Exactly how (if at all) a specific implementation makes use of preallocated is not specified by this interface.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface SolverTask

preallocate, solve, toSolutionProvider

Field Details

myDelegate

private final IterativeSolverTask myDelegate

myRows

private final List<Equation> myRows

mySize

private final int mySize

Constructor Details

MutableSolver

protected MutableSolver(IterativeSolverTask delegate,
 int size)

Method Details

add

public boolean add(Equation row)

clear

public void clear()

preallocate

public PhysicalStore<Double> preallocate(int nbEquations,
 int nbVariables,
 int nbSolutions)

Specified by:

preallocate in interface SolverTask<Double>

remove

public boolean remove(Equation row)

resolve

public double resolve(PhysicalStore<Double> solution)

A variation of solve(Access2D, Access2D, PhysicalStore) where the system body has already been set up using add(Equation). Solves the current [A][x]=[b] using the delegate iterative solver.

resolve

public double resolve(PhysicalStore<Double> solution,
 Access1D<?> rhs)

Same as resolve(PhysicalStore) but replaces the RHS values before solving.

solve

public MatrixStore<Double> solve(Access2D<?> body,
 Access2D<?> rhs,
 PhysicalStore<Double> current)
                          throws RecoverableCondition

Description copied from interface: SolverTask

Exactly how (if at all) a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling SolverTask.solve(Access2D, Access2D).

Use SolverTask.preallocate(Structure2D, Structure2D) to obtain a suitbale preallocated.

Specified by:

solve in interface SolverTask<Double>

Parameters:

rhs - The Right Hand Side, wont be modfied

current - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/ /correct solution.

Returns:

The solution

Throws:

RecoverableCondition

doubleValue

protected double doubleValue(int row,
 int col)

equations

protected Stream<Equation> equations()

getDelegate

protected final IterativeSolverTask getDelegate()