Module ojalgo

Package org.ojalgo.optimisation

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 java.lang.Object
implements Optimisation.ProblemStructure

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.optimisation.Optimisation

Optimisation.Constraint, Optimisation.ConstraintType, Optimisation.Integration<M extends Optimisation.Model,S extends Optimisation.Solver>, 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 PhysicalStore.Factory<java.lang.Double,R064Store>	FACTORY
private java.util.Map<java.lang.String,MultiaryFunction.TwiceDifferentiable<java.lang.Double>>	myAdditionalConstraints	Assumed constrained to be <= 0.0
private RowsSupplier<java.lang.Double>	myAE
private RowsSupplier<java.lang.Double>	myAI
private MatrixStore<java.lang.Double>	myBE
private MatrixStore<java.lang.Double>	myBI
private R064Store	myLowerBounds
private int	myNumberOfVariables
private MultiaryFunction.TwiceDifferentiable<java.lang.Double>	myObjective
private R064Store	myUpperBounds

Fields inherited from interface org.ojalgo.optimisation.Optimisation.ProblemStructure

DEBUG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
private static MatrixStore<java.lang.Double>	add(RowsSupplier<java.lang.Double> baseA, MatrixStore<java.lang.Double> baseB, Access2D<?> addA, Access1D<?> addB)
(package private) void	addConstraint(java.lang.String key, MultiaryFunction.TwiceDifferentiable<java.lang.Double> value)
(package private) void	addEqualities(MatrixStore<?> mtrxAE, MatrixStore<?> mtrxBE)
(package private) void	addInequalities(MatrixStore<?> mtrxAI, MatrixStore<?> mtrxBI)
protected void	append(java.lang.StringBuilder builder)
protected static void	append(java.lang.StringBuilder builder, java.lang.String label, MatrixStore<java.lang.Double> matrix)
S	build()
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<java.lang.Double>	getAE()	Equality constraints body: [AE][X] == [BE]
protected SparseArray<java.lang.Double>	getAE(int row)
protected RowsSupplier<java.lang.Double>	getAE(int... rows)
protected MatrixStore<java.lang.Double>	getAI()	Inequality constraints body: [AI][X] <= [BI]
protected SparseArray<java.lang.Double>	getAI(int row)
protected RowsSupplier<java.lang.Double>	getAI(int... rows)
protected MatrixStore<java.lang.Double>	getBE()	Equality constraints RHS: [AE][X] == [BE]
protected double	getBE(int row)
protected MatrixStore<java.lang.Double>	getBI()	Inequality constraints RHS: [AI][X] <= [BI]
protected double	getBI(int row)
protected MatrixStore<java.lang.Double>	getC()
protected PhysicalStore.Factory<java.lang.Double,R064Store>	getFactory()
protected R064Store	getLowerBounds(double defaultValue)
protected MultiaryFunction.TwiceDifferentiable<java.lang.Double>	getObjective()
protected <T extends MultiaryFunction.TwiceDifferentiable<java.lang.Double>> T	getObjective(java.lang.Class<T> type)
protected Access2D.RowView<java.lang.Double>	getRowsAE()
protected Access2D.RowView<java.lang.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<java.lang.Double> lower, Access1D<java.lang.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<java.lang.Double> objective)
Optimisation.Result	solve()
java.lang.String	toString()
(package private) void	validate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.optimisation.Optimisation.ProblemStructure

countConstraints

Field Detail

FACTORY

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

myAdditionalConstraints

private java.util.Map<java.lang.String,MultiaryFunction.TwiceDifferentiable<java.lang.Double>> myAdditionalConstraints

Assumed constrained to be <= 0.0

myAE

private RowsSupplier<java.lang.Double> myAE

myAI

private RowsSupplier<java.lang.Double> myAI

myBE

private MatrixStore<java.lang.Double> myBE

myBI

private MatrixStore<java.lang.Double> myBI

myLowerBounds

private R064Store myLowerBounds

myNumberOfVariables

private transient int myNumberOfVariables

myObjective

private MultiaryFunction.TwiceDifferentiable<java.lang.Double> myObjective

myUpperBounds

private R064Store myUpperBounds

Constructor Detail

Builder

protected Builder()

Method Detail

add

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

append

protected static final void append(java.lang.StringBuilder builder,
                                   java.lang.String label,
                                   MatrixStore<java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

append

protected void append(java.lang.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<java.lang.Double> getAE()

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

getAE

protected SparseArray<java.lang.Double> getAE(int row)

getAE

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

getAI

protected MatrixStore<java.lang.Double> getAI()

Inequality constraints body: [AI][X] <= [BI]

getAI

protected SparseArray<java.lang.Double> getAI(int row)

getAI

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

getBE

protected MatrixStore<java.lang.Double> getBE()

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

getBE

protected double getBE(int row)

getBI

protected MatrixStore<java.lang.Double> getBI()

Inequality constraints RHS: [AI][X] <= [BI]

getBI

protected double getBI(int row)

getC

protected MatrixStore<java.lang.Double> getC()

getFactory

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

getLowerBounds

protected R064Store getLowerBounds(double defaultValue)

getObjective

protected MultiaryFunction.TwiceDifferentiable<java.lang.Double> getObjective()

getObjective

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

getRowsAE

protected Access2D.RowView<java.lang.Double> getRowsAE()

getRowsAI

protected Access2D.RowView<java.lang.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<java.lang.Double> objective)

addConstraint

void addConstraint(java.lang.String key,
                   MultiaryFunction.TwiceDifferentiable<java.lang.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<java.lang.Double> lower,
               Access1D<java.lang.Double> upper)

setEqualities

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

setInequalities

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

validate

void validate()