MetricRangeValidInputRange.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/DistanceValidInputRange.hpp"
#include "ad/physics/MetricRange.hpp"
#include "spdlog/fmt/ostr.h"
#include "spdlog/spdlog.h"
 
inline bool withinValidInputRange(::ad::physics::MetricRange const &input, bool const logErrors = true)
{
  // check for generic member input ranges
  bool inValidInputRange = true;
  inValidInputRange
    = withinValidInputRange(input.minimum, logErrors) && withinValidInputRange(input.maximum, logErrors);
  if (!inValidInputRange && logErrors)
  {
    spdlog::error("withinValidInputRange(::ad::physics::MetricRange)>> {} has invalid member",
                  input); // LCOV_EXCL_BR_LINE
  }
 
  // check for individual input ranges
  if (inValidInputRange)
  {
    inValidInputRange = (::ad::physics::Distance(0.) <= input.minimum) && (input.minimum <= input.maximum);
    if (!inValidInputRange && logErrors)
    {
      spdlog::error(
        "withinValidInputRange(::ad::physics::MetricRange)>> {} element {} out of valid input range [{}, {}]",
        input,
        input.minimum,
        ::ad::physics::Distance(0.),
        input.maximum); // LCOV_EXCL_BR_LINE
    }
  }
 
  if (inValidInputRange)
  {
    inValidInputRange = (input.minimum <= input.maximum) && (input.maximum <= ::ad::physics::Distance(1e6));
    if (!inValidInputRange && logErrors)
    {
      spdlog::error(
        "withinValidInputRange(::ad::physics::MetricRange)>> {} element {} out of valid input range [{}, {}]",
        input,
        input.maximum,
        input.minimum,
        ::ad::physics::Distance(1e6)); // LCOV_EXCL_BR_LINE
    }
  }
 
  return inValidInputRange;
}