Fixing some failing tests in BLAS
[Math-GSL.git] / Permutation.i
blobf5110d27b615b5ab6e9998b9aa0bccbcedc5dcfd
1 %module "Math::GSL::Permutation"
2 %include "typemaps.i"
3 %include "gsl_typemaps.i"
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"
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"
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
57 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
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;
68 sub as_list {
69 my $self=shift;
70 $self->get( [ 0 .. $self->length - 1 ] );
73 sub get {
74 my ($self, $indices) = @_;
75 return map { gsl_permutation_get($self->{_permutation}, $_ ) } @$indices ;
78 sub raw { (shift)->{_permutation} }
79 sub length { (shift)->{_length} }
84 __END__
86 =head1 NAME
88 Math::GSL::Permutation - functions for creating and manipulating permutations
90 =head1 SYNOPSIS
92 use Math::GSL::Permutation qw/:all/;
93 my $permutation = Math::GSL::Permutation->new(30); # allocate and initialize a permutation of size 30
94 my $lenght = $permutation->lenght; # returns the lenght of the permutation object, here it is 30
95 gsl_permutation_swap($permutation->raw, 2,7);
96 # the raw method is made to use the underlying permutation structure of the permutation object
97 my $value = $permutation->get(2); # returns the third value (starting from 0) of the permutation
98 my @values = $permutation->as_list; # returns all the values of the permutation
99 my @set = $permutation->get([0,1,2,3]); # returns the four first values of the permutation
101 =head1 DESCRIPTION
103 Here is a list of all the functions included in this module :
105 =over
107 =item gsl_permutation_alloc($n) - return a newly allocated permutation of size $n
109 =item gsl_permutation_calloc($n) - return a newly allocated permutation of size $n which is initialized to the identity
111 =item gsl_permutation_init($p) - initialize the permutation $p to the identity i.e. (0,1,2, ..., n-1)
113 =item gsl_permutation_free($p) - free all the memory use by the permutaion $p
115 =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
117 =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.
119 =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.
121 =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.
123 =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.
125 =item gsl_permutation_size($p) - return the size of the permutation $p
127 =item gsl_permutation_data
129 =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
131 =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
133 =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
135 =item gsl_permutation_reverse($p) - reverse the elements of the permutation $p
137 =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
139 =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
141 =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
143 =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
145 =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
147 =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
149 =item gsl_permutation_inversions($p) - return the number of inversions in the permutation $p
151 =item gsl_permutation_linear_cycles($p) - return the number of cycles in the permutation $p, given a linear form
153 =item gsl_permute_vector_int_inversegsl_permutation_canonical_cycles($p) - return the number of cycles in the permutation $p, given a canonical form
155 =item gsl_permute
157 =item gsl_permute_inverse
159 =item gsl_permute_int
161 =item gsl_permute_int_inverse
163 =item gsl_permute_vector
165 =item gsl_permute_vector_inverse
167 =item gsl_permute_vector_int
169 =back
171 You have to add the functions you want to use inside the qw/put_funtion_here/ with spaces between each function.
172 You can also write use Math::GSL::CDF qw/:all/ to use all avaible functions of the module.
173 Other tags are also avaible, here is a complete list of all tags for this module.
174 For more informations on the functions, we refer you to the GSL offcial documentation:
175 L<http://www.gnu.org/software/gsl/manual/html_node/>
177 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
179 =head1 EXAMPLES
181 use Math::GSL::Permutation qw/:all/;
182 $p->{permutation} = gsl_permutation_calloc(5);
183 print "The permutation contains [";
184 map { print gsl_permutation_get($p->{permutation}, $_) . ", " } (0..3);
185 print gsl_permutation_get($p->{permutation}, 4);
186 print "] \n";
187 print "We'll then swap the first and last elements of the permutation...\n";
188 gsl_permutation_swap($p->{permutation}, 0, 4);
189 print "The permutation now contains [";
190 map { print gsl_permutation_get($p->{permutation},$_) . ", " } (0..3);
191 print gsl_permutation_get($p->{permutation}, 4);
192 print "] \n";
195 use Math::GSL::Permutation qw/:all/;
196 use Math::GSL::Vector qw/:all/;
197 my $p->{permutation} = gsl_permutation_calloc(6);
198 gsl_permutation_init($p->{permutation});
199 gsl_permutation_swap($p->{permutation}, 0, 1);
200 print "The permutation has his first and second elements swapped : [";
201 map { print gsl_permutation_get($p->{permutation}, $_) . "," } (0..4);
202 print gsl_permutation_get($p->{permutation}, 5) . "] \n";
203 my $vec->{vector} = gsl_vector_alloc(6);
204 map { gsl_vector_set($vec->{vector}, $_, $_) } (0..5);
206 print "We will now apply the permutation to this vector : [";
207 map { print gsl_vector_get($vec->{vector}, $_) . "," } (0..4);
208 print gsl_vector_get($vec->{vector}, 5) . "] \n";
209 gsl_permute_vector($p->{permutation}, $vec->{vector});
210 print "The vector is now : [";
211 map { print gsl_vector_get($vec->{vector}, $_) . "," } (0..4);
212 print gsl_vector_get($vec->{vector}, 5) . "] \n";
215 =head1 AUTHORS
217 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
219 =head1 COPYRIGHT AND LICENSE
221 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
223 This program is free software; you can redistribute it and/or modify it
224 under the same terms as Perl itself.
226 =cut