Skip to content

Commit 76c3ad5

Browse files
author
Dotsenko Andrey
committed
Add documentation for comparison of floating point numbers (ck_assert_floating_*)
1 parent dd8468d commit 76c3ad5

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

doc/check.texi

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1022,6 +1022,54 @@ by the last two letters of the function name. The abbreviations @code{eq},
10221022
@code{==}, @code{!=}, @code{<}, @code{<=}, @code{>}, and @code{>=}
10231023
respectively.
10241024

1025+
@item ck_assert_floating_eq
1026+
@itemx ck_assert_floating_ne
1027+
@itemx ck_assert_floating_lt
1028+
@itemx ck_assert_floating_le
1029+
@itemx ck_assert_floating_gt
1030+
@itemx ck_assert_floating_ge
1031+
1032+
Compares two floating point numbers (@code{float}, @code{double},
1033+
@code{long double}) and displays predefined message with condition and
1034+
values of both input parameters on failure. The operator used for comparison
1035+
is different for each function and is indicated by the last two letters
1036+
of the function name. The abbreviations @code{eq}, @code{ne}, @code{lt},
1037+
@code{le}, @code{gt}, and @code{ge} correspond to @code{==}, @code{!=},
1038+
@code{<}, @code{<=}, @code{>}, and @code{>=} respectively.
1039+
1040+
@item ck_assert_floating_eq_prec
1041+
1042+
Compares two floating point numbers (@code{float}, @code{double},
1043+
@code{long double}) with specified precision (decimal places) set by the third
1044+
parameter (@code{unsigned char}) and displays predefined message with condition
1045+
and values of both input parameters and precision on failure.
1046+
1047+
@item ck_assert_floating_finite
1048+
1049+
Checks floating point number (@code{float}, @code{double}, @code{long double})
1050+
to be a finite value and displays predefined message with condition and value
1051+
of the input parameter on failure. Finite means that value cannot be
1052+
positive infinity, negative infinity or NaN (not a number).
1053+
1054+
@item ck_assert_floating_infinite
1055+
1056+
Checks floating point number (@code{float}, @code{double}, @code{long double})
1057+
to be infinite value and displays predefined message with condition and value
1058+
of the input parameter on failure. Infinite means that value may only be
1059+
positive infinity or negative infinity.
1060+
1061+
@item ck_assert_floating_nan
1062+
1063+
Checks floating point number (@code{float}, @code{double}, @code{long double})
1064+
to be NaN (not a number) value and displays predefined message with condition
1065+
and value of the input parameter on failure.
1066+
1067+
@item ck_assert_floating_nonnan
1068+
1069+
Checks floating point number (@code{float}, @code{double}, @code{long double})
1070+
not to be NaN (not a number) value and displays predefined message with
1071+
condition and value of the input parameter on failure.
1072+
10251073
@item ck_assert_uint_eq
10261074
@itemx ck_assert_uint_ne
10271075
@itemx ck_assert_uint_lt

0 commit comments

Comments
 (0)