Combination.i

   1 %module "Math::GSL::Combination"
   2
   3 int fclose(FILE *);
   4
   5 %{
   6     #include "gsl/gsl_types.h"
   7     #include "gsl/gsl_combination.h"
   8 %}
   9
  10 %include "gsl/gsl_types.h"
  11 %include "gsl/gsl_combination.h"
  12
  13
  14 %perlcode %{
  15 @EXPORT_OK = qw/fclose
  16                gsl_combination_alloc
  17                gsl_combination_calloc
  18                gsl_combination_init_first
  19                gsl_combination_init_last
  20                gsl_combination_free
  21                gsl_combination_memcpy
  22                gsl_combination_fread
  23                gsl_combination_fwrite
  24                gsl_combination_fscanf
  25                gsl_combination_fprintf
  26                gsl_combination_n
  27                gsl_combination_k
  28                gsl_combination_data
  29                gsl_combination_get
  30                gsl_combination_valid
  31                gsl_combination_next
  32                gsl_combination_prev
  33              /;
  34 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  35
  36 __END__
  37
  38 =head1 NAME
  39
  40 Math::GSL::Combination - Functions for creating and manipulating combinations
  41
  42 =head1 SYNOPSIS
  43
  44 use Math::GSL::Combination qw /:all/;
  45
  46 =head1 DESCRIPTION
  47
  48 Here is a list of all the functions in this module :
  49
  50 =over
  51
  52 =item * C<gsl_combination_alloc($n, $k)> - This function allocates memory for a new combination with parameters $n, $k. The combination is not initialized and its elements are undefined. Use the function gsl_combination_calloc if you want to create a combination which is initialized to the lexicographically first combination.
  53
  54 =item * C<gsl_combination_calloc($n, $k)> - This function allocates memory for a new combination with parameters $n, $k and initializes it to the lexicographically first combination.
  55
  56 =item * C<gsl_combination_init_first($c)> - This function initializes the combination $c to the lexicographically first combination, i.e. (0,1,2,...,k-1).
  57
  58 =item * C<gsl_combination_init_last($c)> - This function initializes the combination $c to the lexicographically last combination, i.e. (n-k,n-k+1,...,n-1).
  59
  60 =item * C<gsl_combination_free($c)> - This function frees all the memory used by the combination $c.
  61
  62 =item * C<gsl_combination_memcpy($dest, $src)> - This function copies the elements of the combination $src into the combination $dest. The two combinations must have the same size.
  63
  64 =item * C<gsl_combination_get($c, $i)> - This function returns the value of the i-th element of the combination $c. If $i lies outside the allowed range of 0 to k-1 then the error handler is invoked and 0 is returned.
  65
  66 =item * C<gsl_combination_fwrite($stream, $c)> - This function writes the elements of the combination $c to the stream $stream, opened with the gsl_fopen function from the Math::GSL module, in binary format. The function returns $GSL_EFAILED if there was a problem writing to the file. Since the data is written in the native binary format it may not be portable between different architectures.
  67
  68 =item * C<gsl_combination_fread($stream, $c)> - This function reads elements from the open stream $stream, opened with the gsl_fopen function from the Math::GSL module, into the combination $c in binary format. The combination $c must be preallocated with correct values of n and k since the function uses the size of $c to determine how many bytes to read. The function returns $GSL_EFAILED if there was a problem reading from the file. The data is assumed to have been written in the native binary format on the same architecture.
  69
  70 =item * C<gsl_combination_fprintf($stream, $c, $format)> - This function writes the elements of the combination $c line-by-line to the stream $stream, opened with the gsl_fopen function from the Math::GSL module, using the format specifier $format, which should be suitable for a type of size_t. In ISO C99 the type modifier z represents size_t, so "%zu\n" is a suitable format. The function returns $GSL_EFAILED if there was a problem writing to the file.
  71
  72 =item * C<gsl_combination_fscanf($stream, $c)> -This function reads formatted data from the stream $stream into the combination $c. The combination $c must be preallocated with correct values of n and k since the function uses the size of $c to determine how many numbers to read. The function returns $GSL_EFAILED if there was a problem reading from the file.
  73
  74 =item * C<gsl_combination_n($c)> - This function returns the range (n) of the combination $c.
  75
  76 =item * C<gsl_combination_k($c)> - This function returns the number of elements (k) in the combination $c.
  77
  78 =item * C<gsl_combination_data($c)> - This function returns a pointer to the array of elements in the combination $c.
  79
  80 =item * C<gsl_combination_valid($c)> - This function checks that the combination $c is valid. The k elements should lie in the range 0 to n-1, with each value occurring once at most and in increasing order.
  81
  82 =item * C<gsl_combination_next($c)> - This function advances the combination $c to the next combination in lexicographic order and returns $GSL_SUCCESS. If no further combinations are available it returns $GSL_FAILURE and leaves $c unmodified. Starting with the first combination and repeatedly applying this function will iterate through all possible combinations of a given order.
  83
  84 =item * C<gsl_combination_prev($c)> - This function steps backwards from the combination $c to the previous combination in lexicographic order, returning $GSL_SUCCESS. If no previous combination is available it returns $GSL_FAILURE and leaves $c unmodified.
  85
  86 =back
  87
  88
  89 For more informations on the functions, we refer you to the GSL offcial
  90 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  91
  92  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  93
  94
  95 =head1 AUTHORS
  96
  97 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  98
  99 =head1 COPYRIGHT AND LICENSE
 100
 101 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 102
 103 This program is free software; you can redistribute it and/or modify it
 104 under the same terms as Perl itself.
 105
 106 =cut
 107
 108 %}