diff options
| author | Mattias Andrée <maandree@kth.se> | 2016-07-16 14:35:59 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2016-07-16 14:35:59 +0200 |
| commit | 64a2515f8234e79c36eeeec915471e89fdf85676 (patch) | |
| tree | abaca58c3def816ab590d0cf7832284d44785aae | |
| parent | Suppres clang warnings (diff) | |
| download | libclut-64a2515f8234e79c36eeeec915471e89fdf85676.tar.gz libclut-64a2515f8234e79c36eeeec915471e89fdf85676.tar.bz2 libclut-64a2515f8234e79c36eeeec915471e89fdf85676.tar.xz | |
doc
Signed-off-by: Mattias Andrée <maandree@kth.se>
| -rw-r--r-- | src/libclut.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/libclut.h b/src/libclut.h index 76f4840..60ef414 100644 --- a/src/libclut.h +++ b/src/libclut.h @@ -23,7 +23,9 @@ -/* This is to avoid warnings about comparing double, which is safe in our case. { */ +/* This is to avoid warnings about comparing double, These are only + * used when it is safe, for example to test whether optimisations + * are possible. { */ #if defined(__GNUC__) || defined(__clang__) # pragma GCC diagnostic push # pragma GCC diagnostic ignored "-Wfloat-equal" @@ -358,6 +360,11 @@ static inline int libclut_0__(double x) { return libclut_eq__(x, 0); } * only way to adjust the blackpoint on many LCD * monitors. * + * Warning. Stops that is too close 0 when using + * floating-point values, get generate overly + * large results. Values too close to `max` when + * using floating-point values, get generate `nan`. + * * None of the parameter may have side-effects. * * Requires linking with '-lm'. |