Permutation.i

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