cp_model_solver.h

Go to the documentation of this file.

// Copyright 2010-2025 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef OR_TOOLS_SAT_CP_MODEL_SOLVER_H_
#define OR_TOOLS_SAT_CP_MODEL_SOLVER_H_
 
#include <functional>
#include <string>
 
#include "absl/flags/declare.h"
#include "ortools/sat/cp_model.pb.h"
#include "ortools/sat/model.h"
#include "ortools/sat/sat_parameters.pb.h"
 
ABSL_DECLARE_FLAG(bool, cp_model_dump_response);
 
namespace operations_research {
namespace sat {

std::string CpSatSolverVersion();

CpSolverResponse Solve(const CpModelProto& model_proto);

CpSolverResponse SolveWithParameters(const CpModelProto& model_proto,
                                     const SatParameters& params);

std::string CpModelStats(const CpModelProto& model);

std::string CpSolverResponseStats(const CpSolverResponse& response,
                                  bool has_objective = true);

CpSolverResponse SolveCpModel(const CpModelProto& model_proto, Model* model);
 
#if !defined(__PORTABLE_PLATFORM__)
CpSolverResponse SolveWithParameters(const CpModelProto& model_proto,
                                     const std::string& params);
#endif  // !__PORTABLE_PLATFORM__

std::function<void(Model*)> NewFeasibleSolutionObserver(
    const std::function<void(const CpSolverResponse& response)>& callback);

std::function<void(Model*)> NewFeasibleSolutionLogCallback(
    const std::function<std::string(const CpSolverResponse& response)>&
        callback);

std::function<void(Model*)> NewBestBoundCallback(
    const std::function<void(double)>& callback);

#if !defined(__PORTABLE_PLATFORM__)
std::function<SatParameters(Model*)> NewSatParameters(
    const std::string& params);
#endif  // !__PORTABLE_PLATFORM__
std::function<SatParameters(Model*)> NewSatParameters(
    const SatParameters& parameters);
 
// TODO(user): Clean this up.
void LoadAndSolveCpModelForTest(const CpModelProto& model_proto, Model* model);
 
}  // namespace sat
}  // namespace operations_research
 
#endif  // OR_TOOLS_SAT_CP_MODEL_SOLVER_H_