Permutation.i

   1 %module "Math::GSL::Permutation"
   2 %include "typemaps.i"
   3 %include "gsl_typemaps.i"
   4
   5 %{
   6     #include "gsl/gsl_permute.h"
   7     #include "gsl/gsl_permute_double.h"
   8     #include "gsl/gsl_permute_int.h"
   9     #include "gsl/gsl_permute_vector.h"
  10     #include "gsl/gsl_permute_vector_double.h"
  11     #include "gsl/gsl_permute_vector_int.h"
  12     #include "gsl/gsl_permutation.h"
  13 %}
  14 %include "gsl/gsl_permute.h"
  15 %include "gsl/gsl_permute_double.h"
  16 %include "gsl/gsl_permute_int.h"
  17 %include "gsl/gsl_permute_vector.h"
  18 %include "gsl/gsl_permute_vector_double.h"
  19 %include "gsl/gsl_permute_vector_int.h"
  20 %include "gsl/gsl_permutation.h"
  21
  22 %perlcode %{
  23 @EXPORT_OK = qw/fopen fclose
  24                 gsl_permutation_alloc
  25                 gsl_permutation_calloc
  26                 gsl_permutation_init
  27                 gsl_permutation_free
  28                 gsl_permutation_memcpy
  29                 gsl_permutation_fread
  30                 gsl_permutation_fwrite
  31                 gsl_permutation_fscanf
  32                 gsl_permutation_fprintf
  33                 gsl_permutation_size
  34                 gsl_permutation_data
  35                 gsl_permutation_get
  36                 gsl_permutation_swap
  37                 gsl_permutation_valid
  38                 gsl_permutation_reverse
  39                 gsl_permutation_inverse
  40                 gsl_permutation_next
  41                 gsl_permutation_prev
  42                 gsl_permutation_mul
  43                 gsl_permutation_linear_to_canonical
  44                 gsl_permutation_canonical_to_linear
  45                 gsl_permutation_inversions
  46                 gsl_permutation_linear_cycles
  47                 gsl_permutation_canonical_cycles
  48                 gsl_permute
  49                 gsl_permute_inverse
  50                 gsl_permute_int
  51                 gsl_permute_int_inverse
  52                 gsl_permute_vector
  53                 gsl_permute_vector_inverse
  54                 gsl_permute_vector_int
  55                 gsl_permute_vector_int_inverse
  56             /;
  57 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  58
  59 ### wrapper interface ###
  60 sub new {
  61     my ($class, $value) = @_;
  62     my $this = {};
  63     $this->{_length} = $value;
  64     $this->{_permutation} = gsl_permutation_calloc($value);
  65     bless $this, $class;
  66 }
  67
  68 sub as_list {
  69     my $self=shift;
  70     $self->get( [ 0 .. $self->length - 1  ] );
  71 }
  72
  73 sub get {
  74     my ($self, $indices) = @_;
  75     return  map {  gsl_permutation_get($self->{_permutation}, $_ ) } @$indices ;
  76 }
  77
  78 sub raw { (shift)->{_permutation} }
  79 sub length { (shift)->{_length} }
  80
  81
  82
  83
  84 __END__
  85
  86 =head1 NAME
  87
  88 Math::GSL::Permutation - functions for creating and manipulating permutations
  89
  90 =head1 SYNOPSIS
  91
  92 use Math::GSL::Permutation qw/:all/;
  93
  94 =head1 DESCRIPTION
  95
  96 Here is a list of all the functions included in this module :
  97
  98 =over
  99
 100 =item gsl_permutation_alloc($n) - return a newly allocated permutation of size $n
 101
 102 =item gsl_permutation_calloc($n) - return a newly allocated permutation of size $n which is initialized to the identity
 103
 104 =item gsl_permutation_init($p) - initialize the permutation $p to the identity i.e. (0,1,2, ..., n-1)
 105
 106 =item gsl_permutation_free($p) - free all the memory use by the permutaion $p
 107
 108 =item gsl_permutation_memcpy($dest, $src) - copy the permutation $src into the permutation $dest, the two permutations must have the same lenght and return 0 if the operation suceeded, 1 otherwise
 109
 110 =item gsl_permutation_fread($stream, $p) -  This function reads into the permutation $p from the open stream $stream (opened with the fopen function) in binary format. The permutation $p must be preallocated with the correct length since the function uses the size of $p to determine how many bytes to read. The function returns 1 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.
 111
 112 =item gsl_permutation_fwrite($stream, $p) - This function writes the elements of the permutation $p to the stream $stream (opened with the fopen function) in binary format. The function returns 1 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.
 113
 114 =item gsl_permutation_fscanf($stream, $p) - This function reads formatted data from the stream $stream into the permutation $p. The permutation $p must be preallocated with the correct length since the function uses the size of $p to determine how many numbers to read. The function returns 1 if there was a problem reading from the file.
 115
 116 =item gsl_permutation_fprintf($stream, $p, $format) - This function writes the elements of the permutation $p line-by-line to the stream $stream (opened with the fopen function) using the format specifier $format, which should be suitable. "%zu\n" is a suitable format. The function returns 1 if there was a problem writing to the file.
 117
 118 =item gsl_permutation_size($p) - return the size of the permutation $p
 119
 120 =item gsl_permutation_data
 121
 122 =item gsl_permutation_get($p, $i) - return the $i-th element of the permutation $p, return 0 if $i is outside the range of 0 to n-1
 123
 124 =item gsl_permutation_swap($p, $i, $j) - exchange the $i-th position and the $j-th position of the permutation $p and return 0 if the operation suceeded, 1 otherwise
 125
 126 =item gsl_permutation_valid($p) - return 0 if the permutation $p is valid (if the n elements contain each of the numbers 0 to n-1 once and only once), 1 otherwise
 127
 128 =item gsl_permutation_reverse($p) - reverse the elements of the permutation $p
 129
 130 =item gsl_permutation_inverse($inv, $p) - compute the inverse of the permutation $p, storing it in $inv and return 0 if the operation succeeded, 1 otherwise
 131
 132 =item gsl_permutation_next($p) - advance the permutation $p to the next permutation in lexicographic order and return 0 if the operation succeeded, 1 otherwise
 133
 134 =item gsl_permutation_prev($p) - step backward from the permutation $p to the previous permutation in lexicographic order and return 0 if the operation suceeded, 1 otherwise
 135
 136 =item gsl_permutation_mul($p, $pa, $pb) - combine the two permutation $pa and $pb into a single permutation $p and return 0 if the operation suceeded, 1 otherwise
 137
 138 =item gsl_permutation_linear_to_canonical($q, $p) - compute the canonical form the permutation $p and store it in $q and return 0 if the operation suceeded, 1 otherwise
 139
 140 =item gsl_permutation_canonical_to_linear($p, $q) - convert a canonical permutation $q back into linear form and store it in $p and return 0 if the operation suceeded, 1 otherwise
 141
 142 =item gsl_permutation_inversions($p) - return the number of inversions in the permutation $p
 143
 144 =item gsl_permutation_linear_cycles($p) - return the number of cycles in the permutation $p, given a linear form
 145
 146 =item gsl_permute_vector_int_inversegsl_permutation_canonical_cycles($p) - return the number of cycles in the permutation $p, given a canonical form
 147
 148 =item gsl_permute
 149
 150 =item gsl_permute_inverse
 151
 152 =item gsl_permute_int
 153
 154 =item gsl_permute_int_inverse
 155
 156 =item gsl_permute_vector
 157
 158 =item gsl_permute_vector_inverse
 159
 160 =item gsl_permute_vector_int
 161
 162 =back
 163
 164  You have to add the functions you want to use inside the qw/put_funtion_here/ with spaces between each function.
 165  You can also write use Math::GSL::CDF qw/:all/ to use all avaible functions of the module.
 166  Other tags are also avaible, here is a complete list of all tags for this module.
 167 For more informations on the functions, we refer you to the GSL offcial documentation:
 168 L<http://www.gnu.org/software/gsl/manual/html_node/>
 169
 170  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 171
 172 =head1 EXAMPLES
 173
 174  use Math::GSL::Permutation qw/:all/;
 175  $p->{permutation} = gsl_permutation_calloc(5);
 176  print "The permutation contains [";
 177  map { print gsl_permutation_get($p->{permutation}, $_) . ", " } (0..3);
 178  print gsl_permutation_get($p->{permutation}, 4);
 179  print "] \n";
 180  print "We'll then swap the first and last elements of the permutation...\n";
 181  gsl_permutation_swap($p->{permutation}, 0, 4);
 182  print "The permutation now contains [";
 183  map { print gsl_permutation_get($p->{permutation},$_) . ", " } (0..3);
 184  print gsl_permutation_get($p->{permutation}, 4);
 185  print "] \n";
 186
 187
 188  use Math::GSL::Permutation qw/:all/;
 189  use Math::GSL::Vector qw/:all/;
 190  my $p->{permutation} = gsl_permutation_calloc(6);
 191  gsl_permutation_init($p->{permutation});
 192  gsl_permutation_swap($p->{permutation}, 0, 1);
 193  print "The permutation has his first and second elements swapped : [";
 194  map { print gsl_permutation_get($p->{permutation}, $_) . "," } (0..4);
 195  print gsl_permutation_get($p->{permutation}, 5) . "] \n";
 196  my $vec->{vector} = gsl_vector_alloc(6);
 197  map { gsl_vector_set($vec->{vector}, $_, $_) } (0..5);
 198
 199  print "We will now apply the permutation to this vector : [";
 200  map { print gsl_vector_get($vec->{vector}, $_) . "," } (0..4);
 201  print gsl_vector_get($vec->{vector}, 5) . "] \n";
 202  gsl_permute_vector($p->{permutation}, $vec->{vector});
 203  print "The vector is now : [";
 204  map { print gsl_vector_get($vec->{vector}, $_) . "," } (0..4);
 205  print gsl_vector_get($vec->{vector}, 5) . "] \n";
 206
 207
 208 =head1 AUTHORS
 209
 210 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 211
 212 =head1 COPYRIGHT AND LICENSE
 213
 214 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 215
 216 This program is free software; you can redistribute it and/or modify it
 217 under the same terms as Perl itself.
 218
 219 =cut
 220 %}
 221