Detailed Description

Wrapper around the SAT solver.

This class proposes different solve() methods, as well as accessors to get the values of variables in the best solution, as well as general statistics of the search.

Definition at line 28 of file CpSolver.java.

Public Member Functions
	CpSolver ()
CpSolverStatus	solve (CpModel model)
CpSolverStatus	solve (CpModel model, CpSolverSolutionCallback cb)
synchronized void	stopSearch ()
double	objectiveValue ()
double	bestObjectiveBound ()
long	value (LinearArgument expr)
Boolean	booleanValue (Literal var)
CpSolverResponse	response ()
long	numBranches ()
long	numConflicts ()
double	wallTime ()
double	userTime ()
List< Integer >	sufficientAssumptionsForInfeasibility ()
SatParameters.Builder	getParameters ()
void	setLogCallback (Consumer< String > cb)
void	clearLogCallback ()
void	setBestBoundCallback (Consumer< Double > cb)
void	clearBestBoundCallback ()
String	responseStats ()
String	solutionInfo ()
String	getSolutionInfo ()
String	solveLog ()
	CpSolver ()
CpSolverStatus	solve (CpModel model)
CpSolverStatus	solve (CpModel model, CpSolverSolutionCallback cb)
synchronized void	stopSearch ()
double	objectiveValue ()
double	bestObjectiveBound ()
long	value (LinearArgument expr)
Boolean	booleanValue (Literal var)
CpSolverResponse	response ()
long	numBranches ()
long	numConflicts ()
double	wallTime ()
double	userTime ()
List< Integer >	sufficientAssumptionsForInfeasibility ()
SatParameters.Builder	getParameters ()
void	setLogCallback (Consumer< String > cb)
void	clearLogCallback ()
void	setBestBoundCallback (Consumer< Double > cb)
void	clearBestBoundCallback ()
String	responseStats ()
String	solutionInfo ()
String	getSolutionInfo ()
String	solveLog ()

Constructor & Destructor Documentation

◆ CpSolver() [1/2]

com.google.ortools.sat.CpSolver.CpSolver ( )

Main construction of the CpSolver class.

Definition at line 30 of file CpSolver.java.

◆ CpSolver() [2/2]

com.google.ortools.sat.CpSolver.CpSolver ( )

Main construction of the CpSolver class.

Definition at line 30 of file CpSolver.java.

Member Function Documentation

◆ bestObjectiveBound() [1/2]

double com.google.ortools.sat.CpSolver.bestObjectiveBound ( )

Returns the best lower bound found when minimizing, of the best upper bound found when maximizing.

Definition at line 95 of file CpSolver.java.

◆ bestObjectiveBound() [2/2]

double com.google.ortools.sat.CpSolver.bestObjectiveBound ( )

Returns the best lower bound found when minimizing, of the best upper bound found when maximizing.

Definition at line 95 of file CpSolver.java.

◆ booleanValue() [1/2]

Boolean com.google.ortools.sat.CpSolver.booleanValue ( Literal var )

Returns the Boolean value of a literal in the last solution found.

Definition at line 110 of file CpSolver.java.

◆ booleanValue() [2/2]

Boolean com.google.ortools.sat.CpSolver.booleanValue ( Literal var )

Returns the Boolean value of a literal in the last solution found.

Definition at line 110 of file CpSolver.java.

◆ clearBestBoundCallback() [1/2]

void com.google.ortools.sat.CpSolver.clearBestBoundCallback ( )

Clears the best bound callback.

Definition at line 169 of file CpSolver.java.

◆ clearBestBoundCallback() [2/2]

void com.google.ortools.sat.CpSolver.clearBestBoundCallback ( )

Clears the best bound callback.

Definition at line 169 of file CpSolver.java.

◆ clearLogCallback() [1/2]

void com.google.ortools.sat.CpSolver.clearLogCallback ( )

Clears the log callback.

Definition at line 159 of file CpSolver.java.

◆ clearLogCallback() [2/2]

void com.google.ortools.sat.CpSolver.clearLogCallback ( )

Clears the log callback.

Definition at line 159 of file CpSolver.java.

◆ getParameters() [1/2]

SatParameters.Builder com.google.ortools.sat.CpSolver.getParameters ( )

Returns the builder of the parameters of the SAT solver for modification.

Definition at line 149 of file CpSolver.java.

◆ getParameters() [2/2]

SatParameters.Builder com.google.ortools.sat.CpSolver.getParameters ( )

Returns the builder of the parameters of the SAT solver for modification.

Definition at line 149 of file CpSolver.java.

◆ getSolutionInfo() [1/2]

String com.google.ortools.sat.CpSolver.getSolutionInfo ( )

Returns the solution info. @Deprecated

Definition at line 187 of file CpSolver.java.

◆ getSolutionInfo() [2/2]

String com.google.ortools.sat.CpSolver.getSolutionInfo ( )

Returns the solution info. @Deprecated

Definition at line 187 of file CpSolver.java.

◆ numBranches() [1/2]

long com.google.ortools.sat.CpSolver.numBranches ( )

Returns the number of branches explored during search.

Definition at line 125 of file CpSolver.java.

◆ numBranches() [2/2]

long com.google.ortools.sat.CpSolver.numBranches ( )

Returns the number of branches explored during search.

Definition at line 125 of file CpSolver.java.

◆ numConflicts() [1/2]

long com.google.ortools.sat.CpSolver.numConflicts ( )

Returns the number of conflicts created during search.

Definition at line 130 of file CpSolver.java.

◆ numConflicts() [2/2]

long com.google.ortools.sat.CpSolver.numConflicts ( )

Returns the number of conflicts created during search.

Definition at line 130 of file CpSolver.java.

◆ objectiveValue() [1/2]

double com.google.ortools.sat.CpSolver.objectiveValue ( )

Returns the best objective value found during search.

Definition at line 87 of file CpSolver.java.

◆ objectiveValue() [2/2]

double com.google.ortools.sat.CpSolver.objectiveValue ( )

Returns the best objective value found during search.

Definition at line 87 of file CpSolver.java.

◆ response() [1/2]

CpSolverResponse com.google.ortools.sat.CpSolver.response ( )

Returns the internal response protobuf that is returned internally by the SAT solver.

Definition at line 120 of file CpSolver.java.

◆ response() [2/2]

CpSolverResponse com.google.ortools.sat.CpSolver.response ( )

Returns the internal response protobuf that is returned internally by the SAT solver.

Definition at line 120 of file CpSolver.java.

◆ responseStats() [1/2]

String com.google.ortools.sat.CpSolver.responseStats ( )

Returns some statistics on the solution found as a string.

Definition at line 174 of file CpSolver.java.

◆ responseStats() [2/2]

String com.google.ortools.sat.CpSolver.responseStats ( )

Returns some statistics on the solution found as a string.

Definition at line 174 of file CpSolver.java.

◆ setBestBoundCallback() [1/2]

void com.google.ortools.sat.CpSolver.setBestBoundCallback ( Consumer< Double > cb )

Sets the best bound callback for the solver.

Definition at line 164 of file CpSolver.java.

◆ setBestBoundCallback() [2/2]

void com.google.ortools.sat.CpSolver.setBestBoundCallback ( Consumer< Double > cb )

Sets the best bound callback for the solver.

Definition at line 164 of file CpSolver.java.

◆ setLogCallback() [1/2]

void com.google.ortools.sat.CpSolver.setLogCallback ( Consumer< String > cb )

Sets the log callback for the solver.

Definition at line 154 of file CpSolver.java.

◆ setLogCallback() [2/2]

void com.google.ortools.sat.CpSolver.setLogCallback ( Consumer< String > cb )

Sets the log callback for the solver.

Definition at line 154 of file CpSolver.java.

◆ solutionInfo() [1/2]

String com.google.ortools.sat.CpSolver.solutionInfo ( )

Returns some information on how the solution was found, or the reason why the model or the parameters are invalid.

Definition at line 182 of file CpSolver.java.

◆ solutionInfo() [2/2]

String com.google.ortools.sat.CpSolver.solutionInfo ( )

Returns some information on how the solution was found, or the reason why the model or the parameters are invalid.

Definition at line 182 of file CpSolver.java.

◆ solve() [1/4]

CpSolverStatus com.google.ortools.sat.CpSolver.solve ( CpModel model )

Solves the given model, and returns the solve status.

Definition at line 38 of file CpSolver.java.

◆ solve() [2/4]

CpSolverStatus com.google.ortools.sat.CpSolver.solve ( CpModel model )

Solves the given model, and returns the solve status.

Definition at line 38 of file CpSolver.java.

◆ solve() [3/4]

CpSolverStatus com.google.ortools.sat.CpSolver.solve	(	CpModel	model,
		CpSolverSolutionCallback	cb )

Solves the given model, calls the solution callback at each incumbent solution, and returns the solve status.

Definition at line 46 of file CpSolver.java.

◆ solve() [4/4]

CpSolverStatus com.google.ortools.sat.CpSolver.solve	(	CpModel	model,
		CpSolverSolutionCallback	cb )

Solves the given model, calls the solution callback at each incumbent solution, and returns the solve status.

Definition at line 46 of file CpSolver.java.

◆ solveLog() [1/2]

String com.google.ortools.sat.CpSolver.solveLog ( )

Returns the solve log. You need to set the parameters log_to_response to true to get the solve log.

Definition at line 195 of file CpSolver.java.

◆ solveLog() [2/2]

String com.google.ortools.sat.CpSolver.solveLog ( )

Returns the solve log. You need to set the parameters log_to_response to true to get the solve log.

Definition at line 195 of file CpSolver.java.

◆ stopSearch() [1/2]

synchronized void com.google.ortools.sat.CpSolver.stopSearch ( )

Stops the search asynchronously.

Definition at line 80 of file CpSolver.java.

◆ stopSearch() [2/2]

synchronized void com.google.ortools.sat.CpSolver.stopSearch ( )

Stops the search asynchronously.

Definition at line 80 of file CpSolver.java.

◆ sufficientAssumptionsForInfeasibility() [1/2]

List< Integer > com.google.ortools.sat.CpSolver.sufficientAssumptionsForInfeasibility ( )

Definition at line 144 of file CpSolver.java.

◆ sufficientAssumptionsForInfeasibility() [2/2]

List< Integer > com.google.ortools.sat.CpSolver.sufficientAssumptionsForInfeasibility ( )

Definition at line 144 of file CpSolver.java.

◆ userTime() [1/2]

double com.google.ortools.sat.CpSolver.userTime ( )

Returns the user time of the search.

Definition at line 140 of file CpSolver.java.

◆ userTime() [2/2]

double com.google.ortools.sat.CpSolver.userTime ( )

Returns the user time of the search.

Definition at line 140 of file CpSolver.java.

◆ value() [1/2]

long com.google.ortools.sat.CpSolver.value ( LinearArgument expr )

Returns the value of a linear expression in the last solution found.

Definition at line 100 of file CpSolver.java.

◆ value() [2/2]

long com.google.ortools.sat.CpSolver.value ( LinearArgument expr )

Returns the value of a linear expression in the last solution found.

Definition at line 100 of file CpSolver.java.

◆ wallTime() [1/2]

double com.google.ortools.sat.CpSolver.wallTime ( )

Returns the wall time of the search.

Definition at line 135 of file CpSolver.java.

◆ wallTime() [2/2]

double com.google.ortools.sat.CpSolver.wallTime ( )

Returns the wall time of the search.

Definition at line 135 of file CpSolver.java.

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

ortools/java/com/google/ortools/sat/CpSolver.java
build/java/ortools-java/src/main/java/com/google/ortools/sat/CpSolver.java

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ CpSolver() [1/2]

◆ CpSolver() [2/2]

Member Function Documentation

◆ bestObjectiveBound() [1/2]

◆ bestObjectiveBound() [2/2]

◆ booleanValue() [1/2]

◆ booleanValue() [2/2]

◆ clearBestBoundCallback() [1/2]

◆ clearBestBoundCallback() [2/2]

◆ clearLogCallback() [1/2]

◆ clearLogCallback() [2/2]

◆ getParameters() [1/2]

◆ getParameters() [2/2]

◆ getSolutionInfo() [1/2]

◆ getSolutionInfo() [2/2]

◆ numBranches() [1/2]

◆ numBranches() [2/2]

◆ numConflicts() [1/2]

◆ numConflicts() [2/2]

◆ objectiveValue() [1/2]

◆ objectiveValue() [2/2]

◆ response() [1/2]

◆ response() [2/2]

◆ responseStats() [1/2]

◆ responseStats() [2/2]

◆ setBestBoundCallback() [1/2]

◆ setBestBoundCallback() [2/2]

◆ setLogCallback() [1/2]

◆ setLogCallback() [2/2]

◆ solutionInfo() [1/2]

◆ solutionInfo() [2/2]

◆ solve() [1/4]

◆ solve() [2/4]

◆ solve() [3/4]

◆ solve() [4/4]

◆ solveLog() [1/2]

◆ solveLog() [2/2]

◆ stopSearch() [1/2]

◆ stopSearch() [2/2]

◆ sufficientAssumptionsForInfeasibility() [1/2]

◆ sufficientAssumptionsForInfeasibility() [2/2]

◆ userTime() [1/2]

◆ userTime() [2/2]

◆ value() [1/2]

◆ value() [2/2]

◆ wallTime() [1/2]

◆ wallTime() [2/2]