CpSolver (com.google.ortools:ortools-java 9.12.9999 API)

java.lang.Object
- com.google.ortools.sat.CpSolver

```
public final class CpSolver
extends java.lang.Object
```
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.

Constructor Summary

Constructors
Constructor and Description

CpSolver()
Main construction of the CpSolver class.

Constructors
Constructor and Description
`CpSolver()` Main construction of the CpSolver class.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`double`	`bestObjectiveBound()` Returns the best lower bound found when minimizing, of the best upper bound found when maximizing.
`java.lang.Boolean`	`booleanValue(Literal var)` Returns the Boolean value of a literal in the last solution found.
`void`	`clearBestBoundCallback()` Clears the best bound callback.
`void`	`clearLogCallback()` Clears the log callback.
`SatParameters.Builder`	`getParameters()` Returns the builder of the parameters of the SAT solver for modification.
`java.lang.String`	`getSolutionInfo()` Returns some information on how the solution was found, or the reason why the model or the parameters are invalid.
`long`	`numBranches()` Returns the number of branches explored during search.
`long`	`numConflicts()` Returns the number of conflicts created during search.
`double`	`objectiveValue()` Returns the best objective value found during search.
`CpSolverResponse`	`response()` Returns the internal response protobuf that is returned internally by the SAT solver.
`java.lang.String`	`responseStats()` Returns some statistics on the solution found as a string.
`CpSolverStatus`	`searchAllSolutions(CpModel model, CpSolverSolutionCallback cb)` Deprecated. Use the solve() method with the same signature, after setting the enumerate_all_solution parameter to true.
`void`	`setBestBoundCallback(java.util.function.Consumer<java.lang.Double> cb)` Sets the best bound callback for the solver.
`void`	`setLogCallback(java.util.function.Consumer<java.lang.String> cb)` Sets the log callback for the solver.
`CpSolverStatus`	`solve(CpModel model)` Solves the given model, and returns the solve status.
`CpSolverStatus`	`solve(CpModel model, CpSolverSolutionCallback cb)` Solves the given model, calls the solution callback at each incumbent solution, and returns the solve status.
`CpSolverStatus`	`solveWithSolutionCallback(CpModel model, CpSolverSolutionCallback cb)` Deprecated. Use the solve() method with the same signature.
`void`	`stopSearch()` Stops the search asynchronously.
`java.util.List<java.lang.Integer>`	`sufficientAssumptionsForInfeasibility()`
`double`	`userTime()` Returns the user time of the search.
`long`	`value(LinearArgument expr)` Returns the value of a linear expression in the last solution found.
`double`	`wallTime()` Returns the wall time of the search.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CpSolver
```
public CpSolver()
```
    Main construction of the CpSolver class.
- Method Detail
  - solve
```
public CpSolverStatus solve(CpModel model)
```
    Solves the given model, and returns the solve status.
  - solve
```
public CpSolverStatus solve(CpModel model,
                            CpSolverSolutionCallback cb)
```
    Solves the given model, calls the solution callback at each incumbent solution, and returns the solve status.
  - solveWithSolutionCallback
```
@Deprecated
public CpSolverStatus solveWithSolutionCallback(CpModel model,
                                                            CpSolverSolutionCallback cb)
```
    Deprecated. Use the solve() method with the same signature.
    
    Solves the given model, passes each incumber solution to the solution callback if not null, and returns the solve status.
  - searchAllSolutions
```
@Deprecated
public CpSolverStatus searchAllSolutions(CpModel model,
                                                     CpSolverSolutionCallback cb)
```
    Deprecated. Use the solve() method with the same signature, after setting the enumerate_all_solution parameter to true.
    
    Searches for all solutions of a satisfiability problem.
    This method searches for all feasible solutions of a given model. Then it feeds the solutions to the callback.
    Note that the model cannot have an objective.
    
    Parameters:
    
    model - the model to solve
    
    cb - the callback that will be called at each solution
    
    Returns:
    
    the status of the solve (FEASIBLE, INFEASIBLE...)
  - stopSearch
```
public void stopSearch()
```
    Stops the search asynchronously.
  - objectiveValue
```
public double objectiveValue()
```
    Returns the best objective value found during search.
  - bestObjectiveBound
```
public double bestObjectiveBound()
```
    Returns the best lower bound found when minimizing, of the best upper bound found when maximizing.
  - value
```
public long value(LinearArgument expr)
```
    Returns the value of a linear expression in the last solution found.
  - booleanValue
```
public java.lang.Boolean booleanValue(Literal var)
```
    Returns the Boolean value of a literal in the last solution found.
  - response
```
public CpSolverResponse response()
```
    Returns the internal response protobuf that is returned internally by the SAT solver.
  - numBranches
```
public long numBranches()
```
    Returns the number of branches explored during search.
  - numConflicts
```
public long numConflicts()
```
    Returns the number of conflicts created during search.
  - wallTime
```
public double wallTime()
```
    Returns the wall time of the search.
  - userTime
```
public double userTime()
```
    Returns the user time of the search.
  - sufficientAssumptionsForInfeasibility
```
public java.util.List<java.lang.Integer> sufficientAssumptionsForInfeasibility()
```
  - getParameters
```
public SatParameters.Builder getParameters()
```
    Returns the builder of the parameters of the SAT solver for modification.
  - setLogCallback
```
public void setLogCallback(java.util.function.Consumer<java.lang.String> cb)
```
    Sets the log callback for the solver.
  - clearLogCallback
```
public void clearLogCallback()
```
    Clears the log callback.
  - setBestBoundCallback
```
public void setBestBoundCallback(java.util.function.Consumer<java.lang.Double> cb)
```
    Sets the best bound callback for the solver.
  - clearBestBoundCallback
```
public void clearBestBoundCallback()
```
    Clears the best bound callback.
  - responseStats
```
public java.lang.String responseStats()
```
    Returns some statistics on the solution found as a string.
  - getSolutionInfo
```
public java.lang.String getSolutionInfo()
```
    Returns some information on how the solution was found, or the reason why the model or the parameters are invalid.

Class CpSolver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CpSolver

Method Detail

solve

solve

solveWithSolutionCallback

searchAllSolutions

stopSearch

objectiveValue

bestObjectiveBound

value

booleanValue

response

numBranches

numConflicts

wallTime

userTime

sufficientAssumptionsForInfeasibility

getParameters

setLogCallback

clearLogCallback

setBestBoundCallback

clearBestBoundCallback

responseStats

getSolutionInfo