solve_parameters_validator.cc

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.
 
#include "ortools/math_opt/validators/solve_parameters_validator.h"
 
#include <cmath>
#include <string>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/str_cat.h"
#include "absl/strings/string_view.h"
#include "absl/time/time.h"
#include "ortools/base/protoutil.h"
#include "ortools/base/status_macros.h"
#include "ortools/math_opt/parameters.pb.h"
#include "ortools/util/status_macros.h"
 
namespace operations_research {
namespace math_opt {
namespace {
 
// Returns an error if the input value is not one of the possible values of the
// enum. The parameter_name is the name of the SolveParametersProto field
// holding the value.
absl::Status ValidateEmphasisProtoParameter(
    const EmphasisProto value, const absl::string_view field_name) {
  if (!EmphasisProto_IsValid(value)) {
    return util::InvalidArgumentErrorBuilder()
           << "Unknown enum value for SolverParameters." << field_name << " = "
           << value;
  }
  return absl::OkStatus();
}
 
}  // namespace
 
absl::Status ValidateSolveParameters(const SolveParametersProto& parameters) {
  {
    OR_ASSIGN_OR_RETURN3(
        const absl::Duration time_limit,
        util_time::DecodeGoogleApiProto(parameters.time_limit()),
        _ << "invalid SolveParameters.time_limit");
    if (time_limit < absl::ZeroDuration()) {
      return util::InvalidArgumentErrorBuilder()
             << "SolveParameters.time_limit = " << time_limit << " < 0";
    }
  }
 
  if (parameters.has_threads()) {
    if (parameters.threads() <= 0) {
      return absl::InvalidArgumentError(absl::StrCat(
          "SolveParameters.threads = ", parameters.threads(), " <= 0"));
    }
  }
 
  if (parameters.has_relative_gap_tolerance()) {
    if (parameters.relative_gap_tolerance() < 0) {
      return absl::InvalidArgumentError(
          absl::StrCat("SolveParameters.relative_gap_tolerance = ",
                       parameters.relative_gap_tolerance(), " < 0"));
    }
  }
 
  if (parameters.has_absolute_gap_tolerance()) {
    if (parameters.absolute_gap_tolerance() < 0) {
      return absl::InvalidArgumentError(
          absl::StrCat("SolveParameters.absolute_gap_tolerance = ",
                       parameters.absolute_gap_tolerance(), " < 0"));
    }
  }
  if (parameters.has_node_limit() && parameters.node_limit() < 0) {
    return util::InvalidArgumentErrorBuilder()
           << "SolveParameters.node_limit = " << parameters.node_limit()
           << " should be nonnegative.";
  }
 
  if (parameters.has_solution_limit() && parameters.solution_limit() <= 0) {
    return util::InvalidArgumentErrorBuilder()
           << "SolveParameters.solution_limit = " << parameters.solution_limit()
           << " should be positive.";
  }
 
  if (!std::isfinite(parameters.cutoff_limit())) {
    return util::InvalidArgumentErrorBuilder()
           << "SolveParameters.cutoff_limit should be finite (and not NaN) but "
              "was: "
           << parameters.cutoff_limit();
  }
  if (std::isnan(parameters.objective_limit())) {
    return absl::InvalidArgumentError(
        "SolveParameters.objective_limit was NaN");
  }
  if (std::isnan(parameters.best_bound_limit())) {
    return absl::InvalidArgumentError(
        "SolveParameters.best_bound_limit was NaN");
  }
  if (parameters.has_solution_pool_size() &&
      parameters.solution_pool_size() <= 0) {
    return util::InvalidArgumentErrorBuilder()
           << "SolveParameters.solution_pool_size must be positive if set, but "
              "was set to: "
           << parameters.solution_pool_size();
  }
  if (!LPAlgorithmProto_IsValid(parameters.lp_algorithm())) {
    return util::InvalidArgumentErrorBuilder()
           << "Unknown enum value for SolverParameters.lp_algorithm = "
           << parameters.lp_algorithm();
  }
#define VALIDATE_EMPHASIS(property) \
  RETURN_IF_ERROR(                  \
      ValidateEmphasisProtoParameter(parameters.property(), #property))
  VALIDATE_EMPHASIS(presolve);
  VALIDATE_EMPHASIS(cuts);
  VALIDATE_EMPHASIS(heuristics);
  VALIDATE_EMPHASIS(scaling);
#undef VALIDATE_EMPHASIS
  return absl::OkStatus();
}
 
}  // namespace math_opt
}  // namespace operations_research