boost/math
2
0
Fork 0
mirror of https://github.com/boostorg/math.git synced 2026-01-28 07:22:12 +00:00
Code Issues Projects Releases Wiki Activity

Added Warning and tip about using nextafter etc.

Browse Source 
[SVN r79721]
This commit is contained in:
Paul A. Bristow
2012-07-24 11:32:17 +00:00
parent 513d4aedfc
commit fb2f55ca04
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/sf_and_dist/float_next.qbk
View File

@@ -49,6 +49,12 @@ Returns the next representable value after /x/ in the direction of /y/. If
a __domain_error. If there is no such value in the direction of /y/ then
returns an __overflow_error.
[warning The template parameter FTP must be a floating-point type.
An integer type, for example, will produce an unhelpful error message.]
[tip Nearly always, you just want the next or prior representable value,
so instead use `float_next` or `float_prior` below.]
[h4 Examples - nextafter]
The two representations using a 32-bit float either side of unity are:
@@ -88,7 +94,7 @@ returns an __overflow_error.
Has the same effect as
nextafter(val, std::numeric_limits<FPT>::max());
nextafter(val, (std::numeric_limits<FPT>::max)());
[endsect] [/section:float_next Finding the Next Greater Representable Value (float_prior)]
@@ -117,7 +123,7 @@ returns an __overflow_error.
Has the same effect as
nextafter(val, -std::numeric_limits<FPT>::max()); // Note most negative value -max.
nextafter(val, -(std::numeric_limits<FPT>::max)()); // Note most negative value -max.
[endsect] [/section:float_prior Finding the Next Smaller Representable Value (float_prior)]