Debian Codegraph @

upstream/debian-unstable/man3/Test2::Compare::Float.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Test2::Compare::Float 3perl"
58 .TH Test2::Compare::Float 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Compare::Float \- Compare two values as numbers with tolerance.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This is used to compare two numbers. You can also check that two numbers are not
68 the same.
69 .PP
70 This is similar to Test2::Compare::Number, with extra checks to work around floating
71 point representation issues.
72 .PP
73 The optional 'tolerance' parameter controls how close the two numbers must be to
74 be considered equal. Tolerance defaults to 1e\-08.
75 .PP
76 \&\fBNote\fR: This will fail if the received value is undefined. It must be a number.
77 .PP
78 \&\fBNote\fR: This will fail if the comparison generates a non-numeric value warning
79 (which will not be shown). This is because it must get a number. The warning is
80 not shown as it will report to a useless line and filename. However, the test
81 diagnostics show both values.
82 .SH SOURCE
83 .IX Header "SOURCE"
84 The source code repository for Test2\-Suite can be found at
85 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
86 .SH MAINTAINERS
87 .IX Header "MAINTAINERS"
88 .IP "Chad Granum <[email protected]>" 4
89 .IX Item "Chad Granum <[email protected]>"
90 .SH AUTHORS
91 .IX Header "AUTHORS"
92 .PD 0
93 .IP "Andrew Grangaard <[email protected]>" 4
94 .IX Item "Andrew Grangaard <[email protected]>"
95 .PD
96 .SH COPYRIGHT
97 .IX Header "COPYRIGHT"
98 Copyright 2018 Chad Granum <[email protected]>.
99 .PP
100 This program is free software; you can redistribute it and/or
101 modify it under the same terms as Perl itself.
102 .PP
103 See \fIhttp://dev.perl.org/licenses/\fR