X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FLaTeX%2FTikZ%2FTools.pm;h=d096f6bcf8741e549741255e9409c78be884c1cc;hb=61a93a58351bf2d238dcf81a1a557112b0c0ee85;hp=9a33324ea1dce4eb933e5f40b62b54088b5a5724;hpb=e8f0879ade07eed4f58cd52c0771f4e1ecc90b09;p=perl%2Fmodules%2FLaTeX-TikZ.git

diff --git a/lib/LaTeX/TikZ/Tools.pm b/lib/LaTeX/TikZ/Tools.pm
index 9a33324..d096f6b 100644
--- a/lib/LaTeX/TikZ/Tools.pm
+++ b/lib/LaTeX/TikZ/Tools.pm
@@ -5,41 +5,94 @@ use warnings;
 
 =head1 NAME
 
-LaTeX::TikZ::Tools - Miscellanous tools for LaTeX::TikZ classes.
+LaTeX::TikZ::Tools - Miscellaneous tools for LaTeX::TikZ classes.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
-use Any::Moose 'Util::TypeConstraints' => [ 'find_type_constraint' ];
+use Mouse::Util::TypeConstraints 'find_type_constraint';
+
+=head1 CONSTANTS
+
+=head2 C<EPS>
+
+The numerical accuracy enforced by L</numeq>, L</numcmp> and L</numround>.
+It is currently set to C<1e-10>.
+
+=cut
 
 use constant EPS => 1e-10;
 
+=head1 FUNCTIONS
+
+=head2 C<numeq>
+
+    numeq($x, $y)
+
+Returns true if and only if C<$x> and C<$y> are equal up to L</EPS>.
+
+=cut
+
 sub numeq { abs($_[0] - $_[1]) < EPS }
 
+=head2 C<numcmp>
+
+    numcmp($x, $y)
+
+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</EPS>.
+
+=cut
+
 sub numcmp { $_[0] < $_[1] - EPS ? -1 : $_[0] > $_[1] + EPS ? 1 : 0 }
 
+=head2 C<numround>
+
+    numround($x)
+
+Returns the closest integer from C<$x> up to L</EPS>.
+
+=cut
+
 sub numround {
  my $x = $_[0];
  my $i = int $x;
  $x + EPS < $i + 0.5 ? $i : $i + 1;
 }
 
+=head2 C<type_constraint>
+
+    my $tc = type_constraint($class)
+
+Finds the type constraint for C<$class> by first trying to load the relevant F<.pm> file.
+
+=cut
+
 sub type_constraint {
  my ($class) = @_;
 
  my $file = $class;
  $file =~ s{::}{/}g;
  $file .= '.pm';
- require $file;
+ unless ($INC{$file}) {
+  local $@;
+  eval {
+   local $SIG{__DIE__}; # See LaTeX::TikZ::Meta::TypeConstraint::Autocoerce
+   require $file;
+  }
+ }
 
  find_type_constraint($class);
 }
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
@@ -59,7 +112,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2010 Vincent Pit, all rights reserved.
+Copyright 2010,2011,2012,2013,2014,2015 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.