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