pod/PowInt.pod

   1 %perlcode %{
   2
   3 our @EXPORT_OK = qw/gsl_pow_2 gsl_pow_2 gsl_pow_3
   4                     gsl_pow_4 gsl_pow_5 gsl_pow_6
   5                     gsl_pow_7 gsl_pow_8 gsl_pow_9 gsl_pow_int
   6                 /;
   7 our %EXPORT_TAGS = ( all =>  \@EXPORT_OK );
   8
   9 __END__
  10
  11 =head1 NAME
  12
  13 Math::GSL::PowInt - Integer Power functions
  14
  15 =head1 SYNOPSIS
  16
  17     use Math::GSL::PowInt qw /gsl_pow_2 gsl_pow_4 gsl_pow_int/;
  18     print '2**4  = ' . gsl_pow_2(4) . "\n";
  19     print '4**7  = ' . gsl_pow_4(7) . "\n";
  20     print '17**5 = ' . gsl_pow_int(17,5) . "\n";
  21
  22 =head1 DESCRIPTION
  23
  24 This module implements the GSL Integer Power functions, which allow one to
  25 quickly compute a given integer raised to any real number.  It contains
  26 gsl_pow_2 to gsl_pow_9 and gsl_pow_int. If you need a power higher than 9, you
  27 can use gsl_pow_int, which takes a base as the first argument and power being
  28 raised to as the second argument.
  29
  30 You can also write
  31
  32 C<use Math::GSL::PowInt qw/:all/;>
  33
  34 to use all avaible functions of the module.
  35
  36 =head1 PURPOSE
  37
  38 This module is used to speed up arithmetic operations. The underlying code
  39 decomposes the multiplication in the most efficient way. Since it is
  40 implemented in XS (via SWIG), it should lend a large performance increase over
  41 the Perl builtin exponentiation operator, '**' .
  42
  43 =head1 BENCHMARKS
  44
  45 Would someone like to submit some benchmarks?
  46
  47 =head1 AUTHORS
  48
  49 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  50
  51 =head1 COPYRIGHT AND LICENSE
  52
  53 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
  54
  55 This program is free software; you can redistribute it and/or modify it
  56 under the same terms as Perl itself.
  57
  58 =cut
  59 %}
  60