Class GenericSolver.Builder<B extends GenericSolver.Builder<B,S>, S extends GenericSolver>

java.lang.Object

org.ojalgo.optimisation.GenericSolver.Builder<B,S>

All Implemented Interfaces:

Optimisation, Optimisation.ProblemStructure

Direct Known Subclasses:

ConvexSolver.Builder, LinearSolver.Builder

Enclosing class:

GenericSolver

public abstract static class GenericSolver.Builder<B extends GenericSolver.Builder<B,S>, S extends GenericSolver>
extends Object
implements Optimisation.ProblemStructure

Nested Class Summary

Nested classes/interfaces inherited from interface Optimisation

Optimisation.Constraint, Optimisation.ConstraintType, Optimisation.Integration<M,S>, Optimisation.Model, Optimisation.Objective, Optimisation.Options, Optimisation.ProblemStructure, Optimisation.Result, Optimisation.Sense, Optimisation.Solver, Optimisation.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final PhysicalStore.Factory<Double, R064Store>	FACTORY
private Map<String, MultiaryFunction.TwiceDifferentiable<Double>>	myAdditionalConstraints	Assumed constrained to be invalid input: '<'= 0.0
private RowsSupplier<Double>	myAE
private RowsSupplier<Double>	myAI
private MatrixStore<Double>	myBE
private MatrixStore<Double>	myBI
private R064Store	myLowerBounds
private int	myNumberOfVariables
private MultiaryFunction.TwiceDifferentiable<Double>	myObjective
private R064Store	myUpperBounds

Fields inherited from interface Optimisation.ProblemStructure

DEBUG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
private static MatrixStore<Double>	add(RowsSupplier<Double> baseA, MatrixStore<Double> baseB, Access2D<?> addA, Access1D<?> addB)
(package private) void	addConstraint(String key, MultiaryFunction.TwiceDifferentiable<Double> value)
(package private) void	addEqualities(MatrixStore<?> mtrxAE, MatrixStore<?> mtrxBE)
(package private) void	addInequalities(MatrixStore<?> mtrxAI, MatrixStore<?> mtrxBI)
protected void	append(StringBuilder builder)
protected static final void	append(StringBuilder builder, String label, MatrixStore<Double> matrix)
final S	build()
final S	build(Optimisation.Options options)
int	countAdditionalConstraints()	Not included in Optimisation.ProblemStructure.countConstraints() (because they are not simple linear equality or inequality constraints),
int	countEqualityConstraints()
int	countInequalityConstraints()
int	countVariables()
protected abstract S	doBuild(Optimisation.Options options)
protected int	doCountVariables()
protected B	equalities(Access2D<?> mtrxAE, Access1D<?> mtrxBE)
protected B	equality(double rhs, double... factors)
protected MatrixStore<Double>	getAE()	Equality constraints body: [AE][X] == [BE]
protected SparseArray<Double>	getAE(int row)
protected RowsSupplier<Double>	getAE(int... rows)
protected MatrixStore<Double>	getAI()	Inequality constraints body: [AI][X] invalid input: '<'= [BI]
protected SparseArray<Double>	getAI(int row)
protected RowsSupplier<Double>	getAI(int... rows)
protected MatrixStore<Double>	getBE()	Equality constraints RHS: [AE][X] == [BE]
protected double	getBE(int row)
protected MatrixStore<Double>	getBI()	Inequality constraints RHS: [AI][X] invalid input: '<'= [BI]
protected double	getBI(int row)
protected MatrixStore<Double>	getC()
protected PhysicalStore.Factory<Double, R064Store>	getFactory()
protected R064Store	getLowerBounds(double defaultValue)
protected MultiaryFunction.TwiceDifferentiable<Double>	getObjective()
protected <T extends MultiaryFunction.TwiceDifferentiable<Double>> T	getObjective(Class<T> type)
protected Access2D.RowView<Double>	getRowsAE()
protected Access2D.RowView<Double>	getRowsAI()
protected R064Store	getUpperBounds(double defaultValue)
protected B	inequalities(Access2D<?> mtrxAI, Access1D<?> mtrxBI)
protected B	inequality(double rhs, double... factors)
(package private) void	newEqualities(int nbEqualities, int nbVariables)
(package private) void	newInequalities(int nbInequalities, int nbVariables)
void	reset()
(package private) void	setBounds(Access1D<Double> lower, Access1D<Double> upper)
(package private) void	setEqualities(Access2D<?> mtrxAE, Access1D<?> mtrxBE)
(package private) void	setInequalities(Access2D<?> mtrxAI, Access1D<?> mtrxBI)
protected void	setNumberOfVariables(int numberOfVariables)
protected void	setObjective(MultiaryFunction.TwiceDifferentiable<Double> objective)
final Optimisation.Result	solve()
final String	toString()
(package private) void	validate()

Methods inherited from class Object

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

Methods inherited from interface Optimisation.ProblemStructure

countConstraints

Field Details

FACTORY

private static final PhysicalStore.Factory<Double, R064Store> FACTORY

myAdditionalConstraints

private Map<String, MultiaryFunction.TwiceDifferentiable<Double>> myAdditionalConstraints

Assumed constrained to be invalid input: '<'= 0.0

myAE

private RowsSupplier<Double> myAE

myAI

private RowsSupplier<Double> myAI

myBE

private MatrixStore<Double> myBE

myBI

private MatrixStore<Double> myBI

myLowerBounds

private R064Store myLowerBounds

myNumberOfVariables

private transient int myNumberOfVariables

myObjective

private MultiaryFunction.TwiceDifferentiable<Double> myObjective

myUpperBounds

private R064Store myUpperBounds

Constructor Details

Builder

protected Builder()

Method Details

add

private static MatrixStore<Double> add(RowsSupplier<Double> baseA,
 MatrixStore<Double> baseB,
 Access2D<?> addA,
 Access1D<?> addB)

append

protected static final void append(StringBuilder builder,
 String label,
 MatrixStore<Double> matrix)

build

public final S build()

build

public final S build(Optimisation.Options options)

countAdditionalConstraints

public int countAdditionalConstraints()

Description copied from interface: Optimisation.ProblemStructure

Not included in Optimisation.ProblemStructure.countConstraints() (because they are not simple linear equality or inequality constraints),

Specified by:

countAdditionalConstraints in interface Optimisation.ProblemStructure

countEqualityConstraints

public int countEqualityConstraints()

Specified by:

countEqualityConstraints in interface Optimisation.ProblemStructure

countInequalityConstraints

public int countInequalityConstraints()

Specified by:

countInequalityConstraints in interface Optimisation.ProblemStructure

countVariables

public int countVariables()

Specified by:

countVariables in interface Optimisation.ProblemStructure

reset

public void reset()

solve

public final Optimisation.Result solve()

toString

public final String toString()

Overrides:

toString in class Object

append

protected void append(StringBuilder builder)

doBuild

protected abstract S doBuild(Optimisation.Options options)

doCountVariables

protected int doCountVariables()

equalities

protected B equalities(Access2D<?> mtrxAE,
 Access1D<?> mtrxBE)

equality

protected B equality(double rhs,
 double... factors)

getAE

protected MatrixStore<Double> getAE()

Equality constraints body: [AE][X] == [BE]

getAE

protected SparseArray<Double> getAE(int row)

getAE

protected RowsSupplier<Double> getAE(int... rows)

getAI

protected MatrixStore<Double> getAI()

Inequality constraints body: [AI][X] invalid input: '<'= [BI]

getAI

protected SparseArray<Double> getAI(int row)

getAI

protected RowsSupplier<Double> getAI(int... rows)

getBE

protected MatrixStore<Double> getBE()

Equality constraints RHS: [AE][X] == [BE]

getBE

protected double getBE(int row)

getBI

protected MatrixStore<Double> getBI()

Inequality constraints RHS: [AI][X] invalid input: '<'= [BI]

getBI

protected double getBI(int row)

getC

protected MatrixStore<Double> getC()

getFactory

protected PhysicalStore.Factory<Double, R064Store> getFactory()

getLowerBounds

protected R064Store getLowerBounds(double defaultValue)

getObjective

protected MultiaryFunction.TwiceDifferentiable<Double> getObjective()

getObjective

protected <T extends MultiaryFunction.TwiceDifferentiable<Double>>
T getObjective(Class<T> type)

getRowsAE

protected Access2D.RowView<Double> getRowsAE()

getRowsAI

protected Access2D.RowView<Double> getRowsAI()

getUpperBounds

protected R064Store getUpperBounds(double defaultValue)

inequalities

protected B inequalities(Access2D<?> mtrxAI,
 Access1D<?> mtrxBI)

inequality

protected B inequality(double rhs,
 double... factors)

setNumberOfVariables

protected void setNumberOfVariables(int numberOfVariables)

setObjective

protected void setObjective(MultiaryFunction.TwiceDifferentiable<Double> objective)

addConstraint

void addConstraint(String key,
 MultiaryFunction.TwiceDifferentiable<Double> value)

addEqualities

void addEqualities(MatrixStore<?> mtrxAE,
 MatrixStore<?> mtrxBE)

addInequalities

void addInequalities(MatrixStore<?> mtrxAI,
 MatrixStore<?> mtrxBI)

newEqualities

void newEqualities(int nbEqualities,
 int nbVariables)

newInequalities

void newInequalities(int nbInequalities,
 int nbVariables)

setBounds

void setBounds(Access1D<Double> lower,
 Access1D<Double> upper)

setEqualities

void setEqualities(Access2D<?> mtrxAE,
 Access1D<?> mtrxBE)

setInequalities

void setInequalities(Access2D<?> mtrxAI,
 Access1D<?> mtrxBI)

validate

void validate()