OR-Tools  8.2
cp_model_checker.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_CHECKER_H_
15 #define OR_TOOLS_SAT_CP_MODEL_CHECKER_H_
16 
17 #include <string>
18 #include <vector>
19 
21 #include "ortools/sat/cp_model.pb.h"
22 
23 namespace operations_research {
24 namespace sat {
25 
26 // Verifies that the given model satisfies all the properties described in the
27 // proto comments. Returns an empty string if it is the case, otherwise fails at
28 // the first error and returns a human-readable description of the issue.
29 //
30 // TODO(user): Add any needed overflow validation because we are far from
31 // exhaustive. We could also run a small presolve that tighten variable bounds
32 // before the overflow check to facilitate the lives of our users, but it is a
33 // some work to put in place.
34 std::string ValidateCpModel(const CpModelProto& model);
35 
36 // Verifies that the given variable assignment is a feasible solution of the
37 // given model. The values vector should be in one to one correspondence with
38 // the model.variables() list of variables.
39 //
40 // The last two arguments are optional and help debugging a failing constraint
41 // due to presolve.
42 bool SolutionIsFeasible(const CpModelProto& model,
43  const std::vector<int64>& variable_values,
44  const CpModelProto* mapping_proto = nullptr,
45  const std::vector<int>* postsolve_mapping = nullptr);
46 
47 } // namespace sat
48 } // namespace operations_research
49 
50 #endif // OR_TOOLS_SAT_CP_MODEL_CHECKER_H_
GRBmodel * model
bool SolutionIsFeasible(const CpModelProto &model, const std::vector< int64 > &variable_values, const CpModelProto *mapping_proto, const std::vector< int > *postsolve_mapping)
std::string ValidateCpModel(const CpModelProto &model)
The vehicle routing library lets one model and solve generic vehicle routing problems ranging from th...