tolerance.hpp

Go to the documentation of this file.

// --------------------------------------------------------------------------
//
// Copyright (C) 2025-present by Pablo Antolin
//
// This file is part of the QUGaR library.
//
// SPDX-License-Identifier:    MIT
//
// --------------------------------------------------------------------------
 
#ifndef QUGAR_LIBRARY_TOLERANCE_HPP
 
#define QUGAR_LIBRARY_TOLERANCE_HPP
 
 
 
#include <qugar/point.hpp>
#include <qugar/types.hpp>
 
#include <cstdlib>
#include <vector>
 
namespace qugar {
 
class Tolerance
{
public:
  explicit Tolerance(const real value);
 
  explicit Tolerance(const real tol_0, const real tol_1);
 
  explicit Tolerance(const Tolerance &tol_0, const Tolerance &tol_1);
 
  explicit Tolerance();
 
  void update(const real tol);
 
  void update(const Tolerance &tol);
 
  [[nodiscard]] real value() const;
 
 
  [[nodiscard]] bool is_zero(const real val) const;
 
  [[nodiscard]] bool is_negative(const real val) const;
 
  [[nodiscard]] bool is_positive(const real val) const;
 
  [[nodiscard]] bool equal(const real lhs, const real rhs) const;
 
  [[nodiscard]] bool equal_rel(const real lhs, const real rhs) const;
 
  [[nodiscard]] bool equal_rel(const real lhs, const real rhs, const Tolerance &rel_tolerance) const;
 
  [[nodiscard]] bool greater_than(const real lhs, const real rhs) const;
 
  [[nodiscard]] bool greater_equal_than(const real lhs, const real rhs) const;
 
  [[nodiscard]] bool greater_than_rel(const real lhs, const real rhs) const;
 
  [[nodiscard]] bool smaller_than(const real lhs, const real rhs) const;
 
  [[nodiscard]] bool smaller_equal_than(const real lhs, const real rhs) const;
 
  [[nodiscard]] bool smaller_than_rel(const real lhs, const real rhs) const;
 
  void unique(std::vector<real> &values) const;
 
  template<int dim, typename T>
  [[nodiscard]] bool coincident(const Point<dim, T> &pt_0, const Point<dim, T> &pt_1) const
  {
    for (int dir = 0; dir < dim; ++dir) {
      if (!this->equal(pt_0(dir), pt_1(dir))) {
        return false;
      }
    }
    return true;
  }
 
 
private:
  real tolerance_;
};
 
}// namespace qugar
 
#endif// QUGAR_LIBRARY_TOLERANCE_HPP