Detailed Description

Main modeling class.

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

Definition at line 24 of file ModelBuilder.java.

Classes
class	MismatchedArrayLengths
	Exception thrown when parallel arrays have mismatched lengths. More...

class	ModelBuilderException

class	WrongLength
	Exception thrown when an array has a wrong length. More...

Public Member Functions
	ModelBuilder ()

Variable	newVar (double lb, double ub, boolean isIntegral, String name)
	Creates a variable with domain [lb, ub]. More...

Variable	newNumVar (double lb, double ub, String name)
	Creates an continuous variable with domain [lb, ub]. More...

Variable	newIntVar (double lb, double ub, String name)
	Creates an integer variable with domain [lb, ub]. More...

Variable	newBoolVar (String name)
	Creates a Boolean variable with the given name. More...

Variable	newConstant (double value)
	Creates a constant variable. More...

Variable	varFromIndex (int index)
	Rebuilds a variable from its index. More...

LinearConstraint	addLinearConstraint (LinearArgument expr, double lb, double ub)
	Adds. More...

int	numVariables ()
	Returns the number of variables in the model. More...

LinearConstraint	addEquality (LinearArgument expr, double value)
	Adds. More...

LinearConstraint	addEquality (LinearArgument left, LinearArgument right)
	Adds. More...

LinearConstraint	addLessOrEqual (LinearArgument expr, double value)
	Adds. More...

LinearConstraint	addLessOrEqual (LinearArgument left, LinearArgument right)
	Adds. More...

LinearConstraint	addGreaterOrEqual (LinearArgument expr, double value)
	Adds. More...

LinearConstraint	addGreaterOrEqual (LinearArgument left, LinearArgument right)
	Adds. More...

int	numConstraints ()
	Returns the number of constraints in the model. More...

void	minimize (LinearArgument obj)
	Minimize expression. More...

void	maximize (LinearArgument obj)
	Minimize expression. More...

void	optimize (LinearArgument obj, boolean maximize)
	Sets the objective expression. More...

String	getName ()
	Returns the name of the model. More...

void	setName (String name)
	Sets the name of the model. More...

boolean	exportToFile (String file)
	Write the model as a protocol buffer to 'file'. More...

String	exportToMpsString (boolean obfuscate)

String	exportToLpString (boolean obfuscate)

boolean	importFromMpsString (String mpsString)

boolean	importFromMpsFile (String mpsFile)

boolean	importFromLpString (String lpString)

boolean	importFromLpFile (String lpFile)

ModelBuilderHelper	getHelper ()
	Returns the model builder helper. More...

Constructor & Destructor Documentation

◆ ModelBuilder()

ModelBuilder ( )

Definition at line 46 of file ModelBuilder.java.

Member Function Documentation

◆ addEquality() [1/2]

LinearConstraint addEquality	(	LinearArgument	expr,
		double	value
	)

Adds.

expr == value

.

Definition at line 117 of file ModelBuilder.java.

◆ addEquality() [2/2]

LinearConstraint addEquality	(	LinearArgument	left,
		LinearArgument	right
	)

Adds.

left == right

.

Definition at line 122 of file ModelBuilder.java.

◆ addGreaterOrEqual() [1/2]

LinearConstraint addGreaterOrEqual	(	LinearArgument	expr,
		double	value
	)

Adds.

expr >= value

.

Definition at line 143 of file ModelBuilder.java.

◆ addGreaterOrEqual() [2/2]

LinearConstraint addGreaterOrEqual	(	LinearArgument	left,
		LinearArgument	right
	)

Adds.

left >= right

.

Definition at line 148 of file ModelBuilder.java.

◆ addLessOrEqual() [1/2]

LinearConstraint addLessOrEqual	(	LinearArgument	expr,
		double	value
	)

Adds.

expr <= value

.

Definition at line 130 of file ModelBuilder.java.

◆ addLessOrEqual() [2/2]

LinearConstraint addLessOrEqual	(	LinearArgument	left,
		LinearArgument	right
	)

Adds.

left <= right

.

Definition at line 135 of file ModelBuilder.java.

◆ addLinearConstraint()

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

Adds.

lb <= expr <= ub

.

Definition at line 91 of file ModelBuilder.java.

◆ exportToFile()

boolean exportToFile ( 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.

Definition at line 216 of file ModelBuilder.java.

◆ exportToLpString()

String exportToLpString ( boolean obfuscate )

Definition at line 224 of file ModelBuilder.java.

◆ exportToMpsString()

String exportToMpsString ( boolean obfuscate )

Definition at line 220 of file ModelBuilder.java.

◆ getHelper()

ModelBuilderHelper getHelper ( )

Returns the model builder helper.

Definition at line 246 of file ModelBuilder.java.

◆ getName()

String getName ( )

Returns the name of the model.

Definition at line 200 of file ModelBuilder.java.

◆ importFromLpFile()

boolean importFromLpFile ( String lpFile )

Definition at line 240 of file ModelBuilder.java.

◆ importFromLpString()

boolean importFromLpString ( String lpString )

Definition at line 236 of file ModelBuilder.java.

◆ importFromMpsFile()

boolean importFromMpsFile ( String mpsFile )

Definition at line 232 of file ModelBuilder.java.

◆ importFromMpsString()

boolean importFromMpsString ( String mpsString )

Definition at line 228 of file ModelBuilder.java.

◆ maximize()

void maximize ( LinearArgument obj )

Minimize expression.

Definition at line 166 of file ModelBuilder.java.

◆ minimize()

void minimize ( LinearArgument obj )

Minimize expression.

Definition at line 161 of file ModelBuilder.java.

◆ newBoolVar()

Variable newBoolVar ( String name )

Creates a Boolean variable with the given name.

Definition at line 69 of file ModelBuilder.java.

◆ newConstant()

Variable newConstant ( double value )

Creates a constant variable.

Definition at line 74 of file ModelBuilder.java.

◆ newIntVar()

Variable newIntVar	(	double	lb,
		double	ub,
		String	name
	)

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

Definition at line 64 of file ModelBuilder.java.

◆ newNumVar()

Variable newNumVar	(	double	lb,
		double	ub,
		String	name
	)

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

Definition at line 59 of file ModelBuilder.java.

◆ newVar()

Variable newVar	(	double	lb,
		double	ub,
		boolean	isIntegral,
		String	name
	)

Creates a variable with domain [lb, ub].

Definition at line 54 of file ModelBuilder.java.

◆ numConstraints()

int numConstraints ( )

Returns the number of constraints in the model.

Definition at line 156 of file ModelBuilder.java.

◆ numVariables()

int numVariables ( )

Returns the number of variables in the model.

Definition at line 112 of file ModelBuilder.java.

◆ optimize()

void optimize	(	LinearArgument	obj,
		boolean	maximize
	)

Sets the objective expression.

Definition at line 171 of file ModelBuilder.java.

◆ setName()

void setName ( String name )

Sets the name of the model.

Definition at line 205 of file ModelBuilder.java.

◆ varFromIndex()

Variable varFromIndex ( int index )

Rebuilds a variable from its index.

Definition at line 84 of file ModelBuilder.java.

The documentation for this class was generated from the following file:

ModelBuilder.java

Java Reference

Java Reference

Detailed Description

Classes

Public Member Functions

Constructor & Destructor Documentation

◆ ModelBuilder()

Member Function Documentation

◆ addEquality() [1/2]

◆ addEquality() [2/2]

◆ addGreaterOrEqual() [1/2]

◆ addGreaterOrEqual() [2/2]

◆ addLessOrEqual() [1/2]

◆ addLessOrEqual() [2/2]

◆ addLinearConstraint()

◆ exportToFile()

◆ exportToLpString()

◆ exportToMpsString()

◆ getHelper()

◆ getName()

◆ importFromLpFile()

◆ importFromLpString()

◆ importFromMpsFile()

◆ importFromMpsString()

◆ maximize()

◆ minimize()

◆ newBoolVar()

◆ newConstant()

◆ newIntVar()

◆ newNumVar()

◆ newVar()

◆ numConstraints()

◆ numVariables()

◆ optimize()

◆ setName()

◆ varFromIndex()