ProbabilityValidInputRange.hpp

Go to the documentation of this file.

/*
 * ----------------- BEGIN LICENSE BLOCK ---------------------------------
 *
 * Copyright (C) 2018-2020 Intel Corporation
 *
 * SPDX-License-Identifier: MIT
 *
 * ----------------- END LICENSE BLOCK -----------------------------------
 */
 
#pragma once
 
#include <cmath>
#include <limits>
#include "ad/physics/Probability.hpp"
#include "spdlog/fmt/ostr.h"
#include "spdlog/spdlog.h"
 
inline bool withinValidInputRange(::ad::physics::Probability const &input, bool const logErrors = true)
{
  // check for generic numeric limits of the type
  bool inValidInputRange = input.isValid() && (std::numeric_limits<::ad::physics::Probability>::lowest() <= input)
    && (input <= std::numeric_limits<::ad::physics::Probability>::max());
  if (!inValidInputRange && logErrors)
  {
    spdlog::error("withinValidInputRange(::ad::physics::Probability)>> {} out of numerical limits [{}, {}]",
                  input,
                  std::numeric_limits<::ad::physics::Probability>::lowest(),
                  std::numeric_limits<::ad::physics::Probability>::max()); // LCOV_EXCL_BR_LINE
  }
  // check for individual input range
  if (inValidInputRange)
  {
    inValidInputRange = (::ad::physics::Probability(0.) <= input) && (input <= ::ad::physics::Probability(1.));
    if (!inValidInputRange && logErrors)
    {
      spdlog::error("withinValidInputRange(::ad::physics::Probability)>> {} out of valid input range [{}, {}]",
                    input,
                    ::ad::physics::Probability(0.),
                    ::ad::physics::Probability(1.)); // LCOV_EXCL_BR_LINE
    }
  }
  return inValidInputRange;
}