model_validator.h

Go to the documentation of this file.

// Copyright 2010-2024 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_LINEAR_SOLVER_MODEL_VALIDATOR_H_
#define OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_
 
#include <optional>
#include <string>
 
#include "absl/types/optional.h"
#include "ortools/linear_solver/linear_solver.pb.h"
#include "ortools/util/lazy_mutable_copy.h"
 
namespace operations_research {
std::string FindErrorInMPModelProto(
    const MPModelProto& model, double abs_value_threshold = 0.0,
    // If false, variable and constraint bounds like [lb=1.2, ub=0.7] yield an
    // error, and also integer variable bounds like [0.7, 0.8].
    bool accept_trivially_infeasible_bounds = false);
 
std::string FindErrorInMPModelDeltaProto(const MPModelDeltaProto& delta,
                                         const MPModelProto& model);
 
std::optional<LazyMutableCopy<MPModelProto>>
ExtractValidMPModelOrPopulateResponseStatus(const MPModelRequest& request,
                                            MPSolutionResponse* response);
 
std::optional<LazyMutableCopy<MPModelProto>> GetMPModelOrPopulateResponse(
    LazyMutableCopy<MPModelRequest>& request, MPSolutionResponse* response);
 
std::string FindFeasibilityErrorInSolutionHint(const MPModelProto& model,
                                               double tolerance);
 
// Partially merges a MPConstraintProto onto another, skipping only the
// repeated fields "var_index" and "coefficients". This is used within
// FindErrorInMPModelDeltaProto.
// See the unit test MergeMPConstraintProtoExceptTermsTest that explains why we
// need this.
void MergeMPConstraintProtoExceptTerms(const MPConstraintProto& from,
                                       MPConstraintProto* to);
 
// Applies the given model_delta to "model". Assumes that
// FindErrorInMPModelDeltaProto() found no error. For full error checking,
// please use ExtractValidMPModelOrPopulateResponseStatus() instead.
void ApplyVerifiedMPModelDelta(const MPModelDeltaProto& delta,
                               MPModelProto* model);
 
}  // namespace operations_research
 
#endif  // OR_TOOLS_LINEAR_SOLVER_MODEL_VALIDATOR_H_