Refactor Matrix tests.
[Math-GSL.git] / Matrix.i
blob2e4499b909ff35d94a086dae5bc9b9226679cc0d
1 %module Matrix
2 %typemap(in) gsl_vector const * {
3 printf("gsl_vector_view const *\n");
6 FILE *fopen(char *, char *);
7 int fclose(FILE *);
9 %apply int *INOUT { size_t *imin, size_t *imax, size_t *jmin, size_t *jmax };
11 %apply double *INOUT { double * min_out, double * max_out };
13 #include "/usr/local/include/gsl/gsl_matrix.h"
14 #include "/usr/local/include/gsl/gsl_matrix_double.h"
15 #include "/usr/local/include/gsl/gsl_matrix_int.h"
16 #include "/usr/local/include/gsl/gsl_matrix_complex_double.h"
17 #include "/usr/local/include/gsl/gsl_matrix_char.h"
20 %include "/usr/local/include/gsl/gsl_matrix.h"
21 %include "/usr/local/include/gsl/gsl_matrix_double.h"
22 %include "/usr/local/include/gsl/gsl_matrix_int.h"
23 %include "/usr/local/include/gsl/gsl_matrix_complex_double.h"
24 %include "/usr/local/include/gsl/gsl_matrix_char.h"
27 %perlcode %{
29 no warnings 'redefine';
31 @EXPORT_OK = qw/fopen fclose
32 gsl_matrix_alloc gsl_matrix_calloc gsl_matrix_alloc_from_block
33 gsl_matrix_alloc_from_matrix gsl_vector_alloc_row_from_matrix
34 gsl_vector_alloc_col_from_matrix gsl_matrix_free gsl_matrix_submatrix
35 gsl_matrix_row gsl_matrix_column gsl_matrix_diagonal
36 gsl_matrix_subdiagonal gsl_matrix_superdiagonal gsl_matrix_subrow
37 gsl_matrix_subcolumn gsl_matrix_view_array
38 gsl_matrix_view_array_with_tda gsl_matrix_view_vector
39 gsl_matrix_view_vector_with_tda gsl_matrix_const_submatrix
40 gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
41 gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
42 gsl_matrix_const_subrow gsl_matrix_const_subcolumn
43 gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
44 gsl_matrix_const_view_vector gsl_matrix_const_view_vector_with_tda
45 gsl_matrix_get gsl_matrix_set gsl_matrix_ptr gsl_matrix_const_ptr
46 gsl_matrix_set_zero gsl_matrix_set_identity gsl_matrix_set_all
47 gsl_matrix_fread gsl_matrix_fwrite gsl_matrix_fscanf gsl_matrix_fprintf
48 gsl_matrix_memcpy gsl_matrix_swap gsl_matrix_swap_rows
49 gsl_matrix_swap_columns gsl_matrix_swap_rowcol gsl_matrix_transpose
50 gsl_matrix_transpose_memcpy gsl_matrix_max gsl_matrix_min
51 gsl_matrix_minmax gsl_matrix_max_index gsl_matrix_min_index
52 gsl_matrix_minmax_index gsl_matrix_isnull gsl_matrix_ispos
53 gsl_matrix_isneg gsl_matrix_isnonneg gsl_matrix_add gsl_matrix_sub
54 gsl_matrix_mul_elements gsl_matrix_div_elements gsl_matrix_scale
55 gsl_matrix_add_constant gsl_matrix_add_diagonal
56 gsl_matrix_char_alloc gsl_matrix_char_calloc gsl_matrix_char_alloc_from_block
57 gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
58 gsl_matrix_char_free gsl_matrix_char_submatrix
59 gsl_matrix_char_row gsl_matrix_char_column
60 gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
61 gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
62 gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
63 gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
64 gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
65 gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
66 gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
67 gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
68 gsl_matrix_char_set_zero gsl_matrix_char_set_identity
69 gsl_matrix_char_set_all gsl_matrix_char_fread
70 gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
71 gsl_matrix_char_memcpy gsl_matrix_char_swap
72 gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
73 gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
74 gsl_matrix_char_max gsl_matrix_char_min
75 gsl_matrix_char_minmax gsl_matrix_char_max_index
76 gsl_matrix_char_min_index gsl_matrix_char_minmax_index
77 gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
78 gsl_matrix_char_isnonneg gsl_matrix_char_add
79 gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
80 gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
81 gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
82 gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
83 gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
84 gsl_matrix_int_column gsl_matrix_int_diagonal gsl_matrix_int_subdiagonal
85 gsl_matrix_int_superdiagonal gsl_matrix_int_subrow gsl_matrix_int_subcolumn gsl_matrix_int_view_array
86 gsl_matrix_int_view_array_with_tda gsl_matrix_int_view_vector gsl_matrix_int_view_vector_with_tda
87 gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
88 gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
89 gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
90 gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
91 gsl_matrix_int_get gsl_matrix_int_set
92 gsl_matrix_int_ptr gsl_matrix_int_const_ptr
93 gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
94 gsl_matrix_int_fread gsl_matrix_int_fwrite
95 gsl_matrix_int_fscanf gsl_matrix_int_fprintf
96 gsl_matrix_int_memcpy gsl_matrix_int_swap
97 gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
98 gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
99 gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
100 gsl_matrix_int_max_index gsl_matrix_int_min_index
101 gsl_matrix_int_minmax_index gsl_matrix_int_isnull
102 gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
103 gsl_matrix_int_add gsl_matrix_int_sub
104 gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
105 gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
106 gsl_matrix_get_row gsl_matrix_get_col gsl_matrix_set_row gsl_matrix_set_col
108 %EXPORT_TAGS = ( all => [ @EXPORT_OK ], char => [gsl_matrix_char_alloc, gsl_matrix_char_calloc, gsl_matrix_char_alloc_from_block, gsl_matrix_char_alloc_from_matrix, gsl_vector_char_alloc_row_from_matrix, gsl_vector_char_alloc_col_from_matrix, gsl_matrix_char_free, gsl_matrix_char_submatrix, gsl_matrix_char_row, gsl_matrix_char_column, gsl_matrix_char_diagonal, gsl_matrix_char_subdiagonal, gsl_matrix_char_superdiagonal, gsl_matrix_char_subrow, gsl_matrix_char_subcolumn, gsl_matrix_char_view_array, gsl_matrix_char_view_array_with_tda, gsl_matrix_char_view_vector, gsl_matrix_char_view_vector_with_tda, gsl_matrix_char_const_submatrix, gsl_matrix_char_const_row, gsl_matrix_char_const_column, gsl_matrix_char_const_diagonal, gsl_matrix_char_const_subdiagonal, gsl_matrix_char_const_superdiagonal, gsl_matrix_char_const_subrow, gsl_matrix_char_const_subcolumn, gsl_matrix_char_const_view_array, gsl_matrix_char_const_view_array_with_tda, gsl_matrix_char_const_view_vector, gsl_matrix_char_const_view_vector_with_tda, gsl_matrix_char_get, gsl_matrix_char_set, gsl_matrix_char_ptr, gsl_matrix_char_const_ptr, gsl_matrix_char_set_zero, gsl_matrix_char_set_identity, gsl_matrix_char_set_all, gsl_matrix_char_fread, gsl_matrix_char_fwrite, gsl_matrix_char_fscanf, gsl_matrix_char_fprintf, gsl_matrix_char_memcpy, gsl_matrix_char_swap, gsl_matrix_char_swap_rows, gsl_matrix_char_swap_columns, gsl_matrix_char_swap_rowcol, gsl_matrix_char_transpose, gsl_matrix_char_transpose_memcpy, gsl_matrix_char_max, gsl_matrix_char_min, gsl_matrix_char_minmax, gsl_matrix_char_max_index, gsl_matrix_char_min_index, gsl_matrix_char_minmax_index, gsl_matrix_char_isnull, gsl_matrix_char_ispos, gsl_matrix_char_isneg, gsl_matrix_char_isnonneg, gsl_matrix_char_add, gsl_matrix_char_sub, gsl_matrix_char_mul_elements, gsl_matrix_char_div_elements, gsl_matrix_char_scale, gsl_matrix_char_add_constant, gsl_matrix_char_add_diagonal], double => [ gsl_matrix_alloc, gsl_matrix_calloc, gsl_matrix_alloc_from_block, gsl_matrix_alloc_from_matrix, gsl_vector_alloc_row_from_matrix, gsl_vector_alloc_col_from_matrix, gsl_matrix_free, gsl_matrix_submatrix, gsl_matrix_row, gsl_matrix_column, gsl_matrix_diagonal, gsl_matrix_subdiagonal, gsl_matrix_superdiagonal, gsl_matrix_subrow, gsl_matrix_subcolumn, gsl_matrix_view_array, gsl_matrix_view_array_with_tda, gsl_matrix_view_vector, gsl_matrix_view_vector_with_tda, gsl_matrix_const_submatrix, gsl_matrix_const_row, gsl_matrix_const_column, gsl_matrix_const_diagonal, gsl_matrix_const_subdiagonal, gsl_matrix_const_superdiagonal, gsl_matrix_const_subrow, gsl_matrix_const_subcolumn, gsl_matrix_const_view_array, gsl_matrix_const_view_array_with_tda, gsl_matrix_const_view_vector, gsl_matrix_const_view_vector_with_tda, gsl_matrix_get, gsl_matrix_set, gsl_matrix_ptr, gsl_matrix_const_ptr, gsl_matrix_set_zero, gsl_matrix_set_identity, gsl_matrix_set_all, gsl_matrix_fread, gsl_matrix_fwrite, gsl_matrix_fscanf, gsl_matrix_fprintf, gsl_matrix_memcpy, gsl_matrix_swap, gsl_matrix_swap_rows, gsl_matrix_swap_columns, gsl_matrix_swap_rowcol, gsl_matrix_transpose, gsl_matrix_transpose_memcpy, gsl_matrix_max, gsl_matrix_minmax, gsl_matrix_max_index, gsl_matrix_min_index, gsl_matrix_minmax_index, gsl_matrix_isnull, gsl_matrix_ispos, gsl_matrix_isneg, gsl_matrix_isnonneg, gsl_matrix_add, gsl_matrix_mul_elements, gsl_matrix_div_elements, gsl_matrix_scale, gsl_matrix_add_constant, gsl_matrix_add_diagonal], int => [gsl_matrix_int_alloc, gsl_matrix_int_alloc_from_matrix, gsl_matrix_int_free, gsl_matrix_int_column, gsl_matrix_int_superdiagonal, gsl_matrix_int_view_array_with_tda, gsl_matrix_int_const_submatrix, gsl_matrix_int_const_diagonal, gsl_matrix_int_const_subrow, gsl_matrix_int_const_view_array_with_tda, gsl_matrix_int_get, gsl_matrix_int_ptr, gsl_matrix_int_set_zero, gsl_matrix_int_fread, gsl_matrix_int_fscanf, gsl_matrix_int_memcpy, gsl_matrix_int_swap_rows, gsl_matrix_int_transpose, gsl_matrix_int_max, gsl_matrix_int_max_index, gsl_matrix_int_minmax_index, gsl_matrix_int_ispos, gsl_matrix_int_add, gsl_matrix_int_mul_elements, gsl_matrix_int_add_constant]);
110 __END__
112 =head1 NAME
114 Math::GSL::Matrix
115 Mathematical functions concerning Matrices
117 =head1 SYPNOPSIS
119 use Math::GSL::Matrix qw/:all/;
121 =head1 DESCRIPTION
123 Here is a list of all the functions included in this module :
125 gsl_matrix_alloc gsl_matrix_calloc gsl_matrix_alloc_from_block
126 gsl_matrix_alloc_from_matrix gsl_vector_alloc_row_from_matrix
127 gsl_vector_alloc_col_from_matrix gsl_matrix_free gsl_matrix_submatrix
128 gsl_matrix_row gsl_matrix_column gsl_matrix_diagonal
129 gsl_matrix_subdiagonal gsl_matrix_superdiagonal gsl_matrix_subrow
130 gsl_matrix_subcolumn gsl_matrix_view_array
131 gsl_matrix_view_array_with_tda gsl_matrix_view_vector
132 gsl_matrix_view_vector_with_tda gsl_matrix_const_submatrix
133 gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
134 gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
135 gsl_matrix_const_subrow gsl_matrix_const_subcolumn
136 gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
137 gsl_matrix_const_view_vector gsl_matrix_const_view_vector_with_tda
138 gsl_matrix_get gsl_matrix_set gsl_matrix_ptr gsl_matrix_const_ptr
139 gsl_matrix_set_zero gsl_matrix_set_identity gsl_matrix_set_all
140 gsl_matrix_fread gsl_matrix_fwrite gsl_matrix_fscanf gsl_matrix_fprintf
141 gsl_matrix_memcpy gsl_matrix_swap gsl_matrix_swap_rows
142 gsl_matrix_swap_columns gsl_matrix_swap_rowcol gsl_matrix_transpose
143 gsl_matrix_transpose_memcpy gsl_matrix_max gsl_matrix_min
144 gsl_matrix_minmax gsl_matrix_max_index gsl_matrix_min_index
145 gsl_matrix_minmax_index gsl_matrix_isnull gsl_matrix_ispos
146 gsl_matrix_isneg gsl_matrix_isnonneg gsl_matrix_add gsl_matrix_sub
147 gsl_matrix_mul_elements gsl_matrix_div_elements gsl_matrix_scale
148 gsl_matrix_add_constant gsl_matrix_add_diagonal
149 gsl_matrix_char_alloc gsl_matrix_char_calloc gsl_matrix_char_alloc_from_block
150 gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
151 gsl_matrix_char_free gsl_matrix_char_submatrix
152 gsl_matrix_char_row gsl_matrix_char_column
153 gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
154 gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
155 gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
156 gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
157 gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
158 gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
159 gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
160 gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
161 gsl_matrix_char_set_zero gsl_matrix_char_set_identity
162 gsl_matrix_char_set_all gsl_matrix_char_fread
163 gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
164 gsl_matrix_char_memcpy gsl_matrix_char_swap
165 gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
166 gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
167 gsl_matrix_char_max gsl_matrix_char_min
168 gsl_matrix_char_minmax gsl_matrix_char_max_index
169 gsl_matrix_char_min_index gsl_matrix_char_minmax_index
170 gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
171 gsl_matrix_char_isnonneg gsl_matrix_char_add
172 gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
173 gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
174 gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
175 gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
176 gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
177 gsl_matrix_int_column gsl_matrix_int_diagonal gsl_matrix_int_subdiagonal
178 gsl_matrix_int_superdiagonal gsl_matrix_int_subrow gsl_matrix_int_subcolumn gsl_matrix_int_view_array
179 gsl_matrix_int_view_array_with_tda gsl_matrix_int_view_vector gsl_matrix_int_view_vector_with_tda
180 gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
181 gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
182 gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
183 gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
184 gsl_matrix_int_get gsl_matrix_int_set
185 gsl_matrix_int_ptr gsl_matrix_int_const_ptr
186 gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
187 gsl_matrix_int_fread gsl_matrix_int_fwrite
188 gsl_matrix_int_fscanf gsl_matrix_int_fprintf
189 gsl_matrix_int_memcpy gsl_matrix_int_swap
190 gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
191 gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
192 gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
193 gsl_matrix_int_max_index gsl_matrix_int_min_index
194 gsl_matrix_int_minmax_index gsl_matrix_int_isnull
195 gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
196 gsl_matrix_int_add gsl_matrix_int_sub
197 gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
198 gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
199 gsl_matrix_get_row gsl_matrix_get_col gsl_matrix_set_row gsl_matrix_set_col
201 You have to add the functions you want to use inside the qw /put_funtion_here /. You can also write use Math::GSL::PowInt qw/:name_of_tag/ to use all avaible functions of the module. Other tags are also avaible, here is a complete list of all tags for this module :
205 double
206 char
208 For more informations on the functions, we refer you to the GSL offcial documentation: http://www.gnu.org/software/gsl/manual/html_node/
209 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/name_of_the_function_you_want
211 =head1 EXAMPLES
213 Most of the examples from this section are perl versions of the examples there : http://www.gnu.org/software/gsl/manual/html_node/Example-programs-for-matrices.html
216 The program below shows how to allocate, initialize and read from a matrix using the functions gsl_matrix_alloc, gsl_matrix_set and gsl_matrix_get.
218 use Math::GSL::Matrix qw/:all/;
219 $m = gsl_matrix_alloc (10,3);
220 for($i = 0; $i< 10; $i++){
221 for($j = 0; $j<3; $j++){
222 gsl_matrix_set($m, $i, $j, 0.23 + 100*$i + $j);
225 for($i = 0; $i< 100; $i++){ # OUT OF RANGE ERROR
226 for($j=0; $j<3; $j++){
227 print "m($i, $j) = " . gsl_matrix_get ($m, $i, $j) . "\n";
230 gsl_matrix_free ($m);
233 use Math::GSL::Matrix qw/:all/;
235 $m = gsl_matrix_alloc (100, 100);
236 $a = gsl_matrix_alloc (100, 100);
238 for($i = 0; $i < 100; $i++){
239 for($j = 0; $j < 100; $j++){
240 gsl_matrix_set ($m, $i, $j, 0.23 + $i + $j);
244 The next program shows how to write a matrix to a file.
246 $out = fopen("test.dat", "wb");
247 gsl_matrix_fwrite ($out, $m);
248 fclose ($out);
250 $in = fopen("test.dat", "rb");
251 gsl_matrix_fread ($in, $a);
252 fclose($in);
254 $k=0;
255 for($i = 0; $i < 100; $i++){
256 for($j = 0; $j < 100; $j++){
257 $mij = gsl_matrix_get ($m, $i, $j);
258 $aij = gsl_matrix_get ($a, $i, $j);
259 if ($mij != $aij){ $k++ };
263 gsl_matrix_free($m);
264 gsl_matrix_free($a);
266 print "differences = $k (should be zero)\n";
268 =head1 AUTHOR
270 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
272 =head1 COPYRIGHT AND LICENSE
274 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
276 This program is free software; you can redistribute it and/or modify it
277 under the same terms as Perl itself.
279 =cut