C++ Reference

C++ Reference: CP-SAT

cp_model_solver.h
Go to the documentation of this file.
1// Copyright 2010-2018 Google LLC
2// Licensed under the Apache License, Version 2.0 (the "License");
3// you may not use this file except in compliance with the License.
4// You may obtain a copy of the License at
5//
6// http://www.apache.org/licenses/LICENSE-2.0
7//
8// Unless required by applicable law or agreed to in writing, software
9// distributed under the License is distributed on an "AS IS" BASIS,
10// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11// See the License for the specific language governing permissions and
12// limitations under the License.
13
14#ifndef OR_TOOLS_SAT_CP_MODEL_SOLVER_H_
15#define OR_TOOLS_SAT_CP_MODEL_SOLVER_H_
16
17#include <functional>
18#include <string>
19#include <vector>
20
21#include "ortools/base/integral_types.h"
22#include "ortools/sat/cp_model.pb.h"
23#include "ortools/sat/model.h"
24#include "ortools/sat/sat_parameters.pb.h"
25
26namespace operations_research {
27namespace sat {
28
30CpSolverResponse Solve(const CpModelProto& model_proto);
31
33CpSolverResponse SolveWithParameters(const CpModelProto& model_proto,
34 const SatParameters& params);
35
37std::string CpModelStats(const CpModelProto& model);
38
45std::string CpSolverResponseStats(const CpSolverResponse& response,
46 bool has_objective = true);
47
59CpSolverResponse SolveCpModel(const CpModelProto& model_proto, Model* model);
60
61#if !defined(__PORTABLE_PLATFORM__)
66CpSolverResponse SolveWithParameters(const CpModelProto& model_proto,
67 const std::string& params);
68#endif // !__PORTABLE_PLATFORM__
69
78std::function<void(Model*)> NewFeasibleSolutionObserver(
79 const std::function<void(const CpSolverResponse& response)>& observer);
80
92void SetSynchronizationFunction(std::function<CpSolverResponse()> f,
93 Model* model);
94
102#if !defined(__PORTABLE_PLATFORM__)
103std::function<SatParameters(Model*)> NewSatParameters(
104 const std::string& params);
105#endif // !__PORTABLE_PLATFORM__
106std::function<SatParameters(Model*)> NewSatParameters(
107 const SatParameters& parameters);
108
109} // namespace sat
110} // namespace operations_research
111
112#endif // OR_TOOLS_SAT_CP_MODEL_SOLVER_H_
Class that owns everything related to a particular optimization model.
Definition: model.h:38
std::function< void(Model *)> NewFeasibleSolutionObserver(const std::function< void(const CpSolverResponse &response)> &observer)
Creates a solution observer with the model with model.Add(NewFeasibleSolutionObserver([](response){....
std::function< SatParameters(Model *)> NewSatParameters(const std::string &params)
Creates parameters for the solver, which you can add to the model with.
std::string CpSolverResponseStats(const CpSolverResponse &response, bool has_objective=true)
Returns a string with some statistics on the solver response.
void SetSynchronizationFunction(std::function< CpSolverResponse()> f, Model *model)
If set, the underlying solver will call this function regularly in a deterministic way.
std::string CpModelStats(const CpModelProto &model)
Returns a string with some statistics on the given CpModelProto.
CpSolverResponse SolveCpModel(const CpModelProto &model_proto, Model *model)
Solves the given CpModelProto.
CpSolverResponse SolveWithParameters(const CpModelProto &model_proto, const SatParameters &params)
Solves the given CpModelProto with the given parameters.
CpSolverResponse Solve(const CpModelProto &model_proto)
Solves the given CpModelProto and returns an instance of CpSolverResponse.