1 %module
"Math::GSL::Permutation"
3 %include
"gsl_typemaps.i"
5 FILE * fopen
(char
*, char
*);
9 #include
"gsl/gsl_permute.h"
10 #include
"gsl/gsl_permute_double.h"
11 #include
"gsl/gsl_permute_int.h"
12 #include
"gsl/gsl_permute_vector.h"
13 #include
"gsl/gsl_permute_vector_double.h"
14 #include
"gsl/gsl_permute_vector_int.h"
15 #include
"gsl/gsl_permutation.h"
17 %include
"gsl/gsl_permute.h"
18 %include
"gsl/gsl_permute_double.h"
19 %include
"gsl/gsl_permute_int.h"
20 %include
"gsl/gsl_permute_vector.h"
21 %include
"gsl/gsl_permute_vector_double.h"
22 %include
"gsl/gsl_permute_vector_int.h"
23 %include
"gsl/gsl_permutation.h"
26 @EXPORT_OK
= qw
/fopen fclose
28 gsl_permutation_calloc
31 gsl_permutation_memcpy
33 gsl_permutation_fwrite
34 gsl_permutation_fscanf
35 gsl_permutation_fprintf
41 gsl_permutation_reverse
42 gsl_permutation_inverse
46 gsl_permutation_linear_to_canonical
47 gsl_permutation_canonical_to_linear
48 gsl_permutation_inversions
49 gsl_permutation_linear_cycles
50 gsl_permutation_canonical_cycles
54 gsl_permute_int_inverse
56 gsl_permute_vector_inverse
57 gsl_permute_vector_int
58 gsl_permute_vector_int_inverse
60 %EXPORT_TAGS
= ( all
=> [ @EXPORT_OK
] );
62 ### wrapper interface ###
64 my
($class
, $value
) = @_
;
66 $this-
>{_length
} = $value
;
67 $this-
>{_permutation
} = gsl_permutation_calloc
($value
);
73 $self-
>get
( [ 0 .. $self-
>length
- 1 ] );
77 my
($self
, $indices
) = @_
;
78 return map
{ gsl_permutation_get
($self-
>{_permutation
}, $_
) } @$indices
;
81 sub raw
{ (shift
)->{_permutation
} }
87 Math
::GSL
::Permutation
- functions for creating and manipulating permutations
91 use Math
::GSL
::Permutation qw
/:all
/;
95 Here is a list of all the functions included in this module
:
99 =item gsl_permutation_alloc
($n
) - return a newly allocated permutation of size $n
101 =item gsl_permutation_calloc
($n
) - return a newly allocated permutation of size $n which is initialized to the identity
103 =item gsl_permutation_init
($p
) - initialize the permutation $p to the identity i.e.
(0,1,2, ...
, n-1
)
105 =item gsl_permutation_free
($p
) - free all the memory use by the permutaion $p
107 =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 =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 =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 =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 =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 =item gsl_permutation_size
($p
) - return the size of the permutation $p
119 =item gsl_permutation_data
121 =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 =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 =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 =item gsl_permutation_reverse
($p
) - reverse the elements of the permutation $p
129 =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 =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 =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 =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 =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 =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 =item gsl_permutation_inversions
($p
) - return the number of inversions in the permutation $p
143 =item gsl_permutation_linear_cycles
($p
) - return the number of cycles in the permutation $p
, given a linear form
145 =item gsl_permute_vector_int_inversegsl_permutation_canonical_cycles
($p
) - return the number of cycles in the permutation $p
, given a canonical form
149 =item gsl_permute_inverse
151 =item gsl_permute_int
153 =item gsl_permute_int_inverse
155 =item gsl_permute_vector
157 =item gsl_permute_vector_inverse
159 =item gsl_permute_vector_int
163 You have to add the functions you want to use inside the qw
/put_funtion_here
/ with spaces between each function.
164 You can also write use Math
::GSL
::CDF qw
/:all
/ to use all avaible functions of the module.
165 Other tags are also avaible
, here is a complete list of all tags for this module.
166 For more informations on the functions
, we refer you to the GSL offcial documentation
: http
://www.gnu.org
/software
/gsl
/manual
/html_node
/
167 Tip
: search on google
: site
:http
://www.gnu.org
/software
/gsl
/manual
/html_node
/ name_of_the_function_you_want
171 use Math
::GSL
::Permutation qw
/:all
/;
172 $p-
>{permutation
} = gsl_permutation_calloc
(5);
173 print
"The permutation contains [";
174 map
{ print gsl_permutation_get
($p-
>{permutation
}, $_
) .
", " } (0.
.3);
175 print gsl_permutation_get
($p-
>{permutation
}, 4);
177 print
"We'll then swap the first and last elements of the permutation...\n";
178 gsl_permutation_swap
($p-
>{permutation
}, 0, 4);
179 print
"The permutation now contains [";
180 map
{ print gsl_permutation_get
($p-
>{permutation
},$_
) .
", " } (0.
.3);
181 print gsl_permutation_get
($p-
>{permutation
}, 4);
185 use Math
::GSL
::Permutation qw
/:all
/;
186 use Math
::GSL
::Vector qw
/:all
/;
187 my $p-
>{permutation
} = gsl_permutation_calloc
(6);
188 gsl_permutation_init
($p-
>{permutation
});
189 gsl_permutation_swap
($p-
>{permutation
}, 0, 1);
190 print
"The permutation has his first and second elements swapped : [";
191 map
{ print gsl_permutation_get
($p-
>{permutation
}, $_
) .
"," } (0.
.4);
192 print gsl_permutation_get
($p-
>{permutation
}, 5) .
"] \n";
193 my $vec-
>{vector
} = gsl_vector_alloc
(6);
194 map
{ gsl_vector_set
($vec-
>{vector
}, $_
, $_
) } (0.
.5);
196 print
"We will now apply the permutation to this vector : [";
197 map
{ print gsl_vector_get
($vec-
>{vector
}, $_
) .
"," } (0.
.4);
198 print gsl_vector_get
($vec-
>{vector
}, 5) .
"] \n";
199 gsl_permute_vector
($p-
>{permutation
}, $vec-
>{vector
});
200 print
"The vector is now : [";
201 map
{ print gsl_vector_get
($vec-
>{vector
}, $_
) .
"," } (0.
.4);
202 print gsl_vector_get
($vec-
>{vector
}, 5) .
"] \n";
207 Jonathan Leto
<jonathan@leto.net
> and Thierry Moisan
<thierry.moisan@gmail.com
>
209 =head1 COPYRIGHT
AND LICENSE
211 Copyright
(C
) 2008 Jonathan Leto and Thierry Moisan
213 This program is free software
; you can redistribute it and
/or modify it
214 under the same terms as Perl itself.