From d338042e3ea08b915e9f8096ea4334c9c9e21dbb Mon Sep 17 00:00:00 2001 From: Niels Date: Tue, 26 Jan 2016 19:21:46 +0100 Subject: [PATCH] added note to warn about floating-point exceptions (#181) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 371b9324..acb2e9e2 100644 --- a/README.md +++ b/README.md @@ -397,7 +397,8 @@ Thanks a lot for helping out! ## Notes -- The code contains numerous debug assertions which can be switched off by defining the preprocessor macro `NDEBUG`, see the [documentation of `assert`](http://en.cppreference.com/w/cpp/error/assert). +- The code contains numerous debug **assertions** which can be switched off by defining the preprocessor macro `NDEBUG`, see the [documentation of `assert`](http://en.cppreference.com/w/cpp/error/assert). +- As the exact type of a number is not defined in the [JSON specification](http://rfc7159.net/rfc7159), this library tries to choose the best fitting C++ number type automatically. As a result, the type `double` may be used to store numbers which may yield [**floating-point exceptions**](https://github.com/nlohmann/json/issues/181) in certain rare situations if floating-point exceptions have been unmasked in the calling code. These exceptions are not caused by the library and need to be fixed in the calling code, such as by re-masking the exceptions prior to calling library functions. ## Execute unit tests