numbers.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file utility/numbers.hh
/// @brief Brief utility classes for numeric usage
/// @details For more complex numeric utilties, see the numeric namespace
/// @author Rocco Moretti

#ifndef INCLUDED_utility_numbers_hh
#define INCLUDED_utility_numbers_hh

#include <platform/types.hh>

#include <limits>
#include <cmath>


#if defined(WIN32)  &&  !defined(__CYGWIN__)
#include <float.h>
namespace std {
inline int isnan(double x) { return _isnan(x); }
inline int isinf(double x) { return !_finite(x); }
}
inline double round(double x) { return x < 0.0 ? ceil(x - 0.5) : floor(x + 0.5); }
inline double copysign(double x, double y) { return _copysign(x, y); }
#endif

namespace utility {

/// @brief Get a numeric value for Size that represents an "undefined" value
inline
platform::Size get_undefined_size() {
  return std::numeric_limits< platform::Size >::max(); // Choice of value same as the BCL (Meiler Lab)
}

/// @brief Check if a Size is undefined (i.e has the same value as utility::get_undefined_size() )
inline
bool is_undefined( platform::Size const & val) {
  return val == get_undefined_size();
}

/// @brief Get a numeric value for Real that represents an "undefined" value
inline
platform::Real get_undefined_real() {
  return std::numeric_limits< platform::Real >::quiet_NaN(); // Choice of value same as the BCL (Meiler Lab)
}

/// @brief Check if a Real is undefined (i.e has the same value as utility::get_undefined_real() )
inline
bool is_undefined( platform::Real const & val) {
  return std::isnan( val ) || std::isinf( val );
}

inline
bool is_nan( platform::Real const & val) {
  return std::isnan( val );
}

inline
bool is_inf( platform::Real const & val) {
  return std::isinf( val );
}

inline
platform::Real round( platform::Real const & val) {
  return ::round(val);
}

inline
platform::Real copysign(platform::Real const & x, platform::Real const & y) {
  return ::copysign(x, y);
}

} // utility

#endif