pod/Permutation.pod

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