scalar_validator.h

Go to the documentation of this file.

// Copyright 2010-2021 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_MATH_OPT_VALIDATORS_SCALAR_VALIDATOR_H_
#define OR_TOOLS_MATH_OPT_VALIDATORS_SCALAR_VALIDATOR_H_

#include "absl/status/status.h"
namespace operations_research {
namespace math_opt {

absl::Status CheckScalarNoNanNoInf(const double d);

struct DoubleOptions {
  bool allow_positive_infinity = true;
  bool allow_negative_infinity = true;
  bool allow_negative = true;
  bool allow_positive = true;
};

// Checks value is not NaN and satisfies the additional conditions in options.
absl::Status CheckScalar(const double value, const DoubleOptions& options);

}  // namespace math_opt
}  // namespace operations_research
#endif  // OR_TOOLS_MATH_OPT_VALIDATORS_SCALAR_VALIDATOR_H_