X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FLaTeX%2FTikZ%2FTools.pm;h=d2d1131146a50bb85a1b0cb439852843a15de2cf;hb=58ac8fce7c7d1d825f90340434ca71b1b9da843b;hp=54e50097d13408746b1c526c33101bde775d1a1a;hpb=04d3984b7e9310f2d825c6458620a8c131bf3030;p=perl%2Fmodules%2FLaTeX-TikZ.git
diff --git a/lib/LaTeX/TikZ/Tools.pm b/lib/LaTeX/TikZ/Tools.pm
index 54e5009..d2d1131 100644
--- a/lib/LaTeX/TikZ/Tools.pm
+++ b/lib/LaTeX/TikZ/Tools.pm
@@ -21,25 +21,34 @@ use Any::Moose 'Util::TypeConstraints' => [ 'find_type_constraint' ];
=head2 C
+The numerical accuracy enforced by L, L and L.
+It is currently set to C<1e-10>.
+
=cut
use constant EPS => 1e-10;
=head1 FUNCTIONS
-=head2 C
+=head2 C
+
+Returns true if and only if C<$x> and C<$y> are equal up to L.
=cut
sub numeq { abs($_[0] - $_[1]) < EPS }
-=head2 C
+=head2 C
+
+Returns a negative number, zero, or a positive number when C<$x> is respectively smaller than, equal to, or greater than C<$y> up to L.
=cut
sub numcmp { $_[0] < $_[1] - EPS ? -1 : $_[0] > $_[1] + EPS ? 1 : 0 }
-=head2 C
+=head2 C
+
+Returns the closest integer from C<$x> up to L.
=cut
@@ -51,7 +60,7 @@ sub numround {
=head2 C
-Find the type constraint for C<$class> by first trying to load the relevant F<.pm> file.
+Finds the type constraint for C<$class> by first trying to load the relevant F<.pm> file.
=cut