com.google.ortools.modelbuilder

Class ModelBuilder

java.lang.Object

com.google.ortools.modelbuilder.ModelBuilder

public final class ModelBuilder
extends java.lang.Object

Main modeling class.

Proposes a factory to create all modeling objects understood by the SAT solver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelBuilder.MismatchedArrayLengths Exception thrown when parallel arrays have mismatched lengths.
static class	ModelBuilder.WrongLength Exception thrown when an array has a wrong length.

Constructor Summary

Constructors

Constructor and Description
ModelBuilder() Main constructor

Method Summary

Modifier and Type	Method and Description
EnforcedLinearConstraint	addEnforcedEquality(LinearArgument expr, double value, Variable iVar, boolean iValue) Adds ivar == iValue => expr == value.
EnforcedLinearConstraint	addEnforcedEquality(LinearArgument left, LinearArgument right, Variable iVar, boolean iValue) Adds ivar == iValue => left == right.
EnforcedLinearConstraint	addEnforcedGreaterOrEqual(LinearArgument expr, double value, Variable iVar, boolean iValue) Adds ivar == iValue => expr >= value.
EnforcedLinearConstraint	addEnforcedGreaterOrEqual(LinearArgument left, LinearArgument right, Variable iVar, boolean iValue) Adds ivar == iValue => left >= right.
EnforcedLinearConstraint	addEnforcedLessOrEqual(LinearArgument expr, double value, Variable iVar, boolean iValue) Adds ivar == iValue => expr <= value.
EnforcedLinearConstraint	addEnforcedLessOrEqual(LinearArgument left, LinearArgument right, Variable iVar, boolean iValue) Adds ivar == iValue => left <= right.
EnforcedLinearConstraint	addEnforcedLinearConstraint(LinearArgument expr, double lb, double ub, Variable iVar, boolean iValue) Adds ivar == iValue => lb <= expr <= ub.
LinearConstraint	addEquality(LinearArgument expr, double value) Adds expr == value.
LinearConstraint	addEquality(LinearArgument left, LinearArgument right) Adds left == right.
LinearConstraint	addGreaterOrEqual(LinearArgument expr, double value) Adds expr >= value.
LinearConstraint	addGreaterOrEqual(LinearArgument left, LinearArgument right) Adds left >= right.
LinearConstraint	addLessOrEqual(LinearArgument expr, double value) Adds expr <= value.
LinearConstraint	addLessOrEqual(LinearArgument left, LinearArgument right) Adds left <= right.
LinearConstraint	addLinearConstraint(LinearArgument expr, double lb, double ub) Adds lb <= expr <= ub.
LinearConstraint	constraintFromIndex(int index) Rebuilds a linear constraint from its index.
EnforcedLinearConstraint	enforcedConstraintFromIndex(int index) Rebuilds a linear constraint from its index.
boolean	exportToFile(java.lang.String file) Write the model as a protocol buffer to 'file'.
java.lang.String	exportToLpString(boolean obfuscate)
java.lang.String	exportToMpsString(boolean obfuscate)
ModelBuilder	getClone() Returns a cloned model
ModelBuilderHelper	getHelper() Returns the model builder helper.
java.lang.String	getName() Returns the name of the model.
boolean	importFromFile(java.lang.String file) import the model from protocol buffer 'file'.
boolean	importFromLpFile(java.lang.String lpFile)
boolean	importFromLpString(java.lang.String lpString)
boolean	importFromMpsFile(java.lang.String mpsFile)
boolean	importFromMpsString(java.lang.String mpsString)
void	maximize(LinearArgument obj) Minimize expression
void	minimize(LinearArgument obj) Minimize expression
Variable	newBoolVar(java.lang.String name) Creates a Boolean variable with the given name.
Variable	newConstant(double value) Creates a constant variable.
Variable	newIntVar(double lb, double ub, java.lang.String name) Creates an integer variable with domain [lb, ub].
Variable	newNumVar(double lb, double ub, java.lang.String name) Creates a continuous variable with domain [lb, ub].
Variable	newVar(double lb, double ub, boolean isIntegral, java.lang.String name) Creates a variable with domain [lb, ub].
int	numConstraints() Returns the number of constraints in the model.
int	numVariables() Returns the number of variables in the model.
void	optimize(LinearArgument obj, boolean maximize) Sets the objective expression.
void	setName(java.lang.String name) Sets the name of the model.
Variable	varFromIndex(int index) Rebuilds a variable from its index.
boolean	writeToMpsFile(java.lang.String filename, boolean obfuscate)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelBuilder

public ModelBuilder()

Main constructor

Method Detail

getClone

public ModelBuilder getClone()

Returns a cloned model

newVar

public Variable newVar(double lb,
                       double ub,
                       boolean isIntegral,
                       java.lang.String name)

Creates a variable with domain [lb, ub].

newNumVar

public Variable newNumVar(double lb,
                          double ub,
                          java.lang.String name)

Creates a continuous variable with domain [lb, ub].

newIntVar

public Variable newIntVar(double lb,
                          double ub,
                          java.lang.String name)

Creates an integer variable with domain [lb, ub].

newBoolVar

public Variable newBoolVar(java.lang.String name)

Creates a Boolean variable with the given name.

newConstant

public Variable newConstant(double value)

Creates a constant variable.

varFromIndex

public Variable varFromIndex(int index)

Rebuilds a variable from its index.

addLinearConstraint

public LinearConstraint addLinearConstraint(LinearArgument expr,
                                            double lb,
                                            double ub)

Adds lb <= expr <= ub.

addEquality

public LinearConstraint addEquality(LinearArgument expr,
                                    double value)

Adds expr == value.

addEquality

public LinearConstraint addEquality(LinearArgument left,
                                    LinearArgument right)

Adds left == right.

addLessOrEqual

public LinearConstraint addLessOrEqual(LinearArgument expr,
                                       double value)

Adds expr <= value.

addLessOrEqual

public LinearConstraint addLessOrEqual(LinearArgument left,
                                       LinearArgument right)

Adds left <= right.

addGreaterOrEqual

public LinearConstraint addGreaterOrEqual(LinearArgument expr,
                                          double value)

Adds expr >= value.

addGreaterOrEqual

public LinearConstraint addGreaterOrEqual(LinearArgument left,
                                          LinearArgument right)

Adds left >= right.

constraintFromIndex

public LinearConstraint constraintFromIndex(int index)

Rebuilds a linear constraint from its index.

addEnforcedLinearConstraint

public EnforcedLinearConstraint addEnforcedLinearConstraint(LinearArgument expr,
                                                            double lb,
                                                            double ub,
                                                            Variable iVar,
                                                            boolean iValue)

Adds ivar == iValue => lb <= expr <= ub.

addEnforcedEquality

public EnforcedLinearConstraint addEnforcedEquality(LinearArgument expr,
                                                    double value,
                                                    Variable iVar,
                                                    boolean iValue)

Adds ivar == iValue => expr == value.

addEnforcedEquality

public EnforcedLinearConstraint addEnforcedEquality(LinearArgument left,
                                                    LinearArgument right,
                                                    Variable iVar,
                                                    boolean iValue)

Adds ivar == iValue => left == right.

addEnforcedLessOrEqual

public EnforcedLinearConstraint addEnforcedLessOrEqual(LinearArgument expr,
                                                       double value,
                                                       Variable iVar,
                                                       boolean iValue)

Adds ivar == iValue => expr <= value.

addEnforcedLessOrEqual

public EnforcedLinearConstraint addEnforcedLessOrEqual(LinearArgument left,
                                                       LinearArgument right,
                                                       Variable iVar,
                                                       boolean iValue)

Adds ivar == iValue => left <= right.

addEnforcedGreaterOrEqual

public EnforcedLinearConstraint addEnforcedGreaterOrEqual(LinearArgument expr,
                                                          double value,
                                                          Variable iVar,
                                                          boolean iValue)

Adds ivar == iValue => expr >= value.

addEnforcedGreaterOrEqual

public EnforcedLinearConstraint addEnforcedGreaterOrEqual(LinearArgument left,
                                                          LinearArgument right,
                                                          Variable iVar,
                                                          boolean iValue)

Adds ivar == iValue => left >= right.

enforcedConstraintFromIndex

public EnforcedLinearConstraint enforcedConstraintFromIndex(int index)

Rebuilds a linear constraint from its index.

minimize

public void minimize(LinearArgument obj)

Minimize expression

maximize

public void maximize(LinearArgument obj)

Minimize expression

optimize

public void optimize(LinearArgument obj,
                     boolean maximize)

Sets the objective expression.

numVariables

public int numVariables()

Returns the number of variables in the model.

numConstraints

public int numConstraints()

Returns the number of constraints in the model.

getName

public java.lang.String getName()

Returns the name of the model.

setName

public void setName(java.lang.String name)

Sets the name of the model.

exportToFile

public boolean exportToFile(java.lang.String file)

Write the model as a protocol buffer to 'file'.

Parameters:

file - file to write the model to. If the filename ends with 'txt', the model will be written as a text file, otherwise, the binary format will be used.

Returns:

true if the model was correctly written.

importFromFile

public boolean importFromFile(java.lang.String file)

import the model from protocol buffer 'file'.

Parameters:

file - file to read the model from.

Returns:

true if the model was correctly loaded.

exportToMpsString

public java.lang.String exportToMpsString(boolean obfuscate)

exportToLpString

public java.lang.String exportToLpString(boolean obfuscate)

writeToMpsFile

public boolean writeToMpsFile(java.lang.String filename,
                              boolean obfuscate)

importFromMpsString

public boolean importFromMpsString(java.lang.String mpsString)

importFromMpsFile

public boolean importFromMpsFile(java.lang.String mpsFile)

importFromLpString

public boolean importFromLpString(java.lang.String lpString)

importFromLpFile

public boolean importFromLpFile(java.lang.String lpFile)

getHelper

public ModelBuilderHelper getHelper()

Returns the model builder helper.