Adding matrix_complex functions to the Matrix subsystem and adding gsl_eigen_herm...
[Math-GSL.git] / Matrix.i
blob4ed2906302e4bc6edb4e2a83ba59e792835883bc
1 %module Matrix
3 %apply int *OUTPUT { size_t *imin, size_t *imax, size_t *jmin, size_t *jmax };
5 %apply double *OUTPUT { double * min_out, double * max_out };
6 %{
7 #include "/usr/local/include/gsl/gsl_matrix.h"
8 #include "/usr/local/include/gsl/gsl_vector_double.h"
9 #include "/usr/local/include/gsl/gsl_matrix_double.h"
10 #include "/usr/local/include/gsl/gsl_matrix_int.h"
11 #include "/usr/local/include/gsl/gsl_matrix_complex_double.h"
12 #include "/usr/local/include/gsl/gsl_matrix_char.h"
15 %include "/usr/local/include/gsl/gsl_matrix.h"
16 %include "/usr/local/include/gsl/gsl_vector_double.h"
17 %include "/usr/local/include/gsl/gsl_matrix_double.h"
18 %include "/usr/local/include/gsl/gsl_matrix_int.h"
19 %include "/usr/local/include/gsl/gsl_matrix_complex_double.h"
20 %include "/usr/local/include/gsl/gsl_matrix_char.h"
23 %perlcode %{
25 no warnings 'redefine';
27 @EXPORT_OK = qw/fopen fclose
28 gsl_matrix_alloc gsl_matrix_calloc gsl_matrix_alloc_from_block
29 gsl_matrix_alloc_from_matrix gsl_vector_alloc_row_from_matrix
30 gsl_vector_alloc_col_from_matrix gsl_matrix_free gsl_matrix_submatrix
31 gsl_matrix_row gsl_matrix_column gsl_matrix_diagonal
32 gsl_matrix_subdiagonal gsl_matrix_superdiagonal gsl_matrix_subrow
33 gsl_matrix_subcolumn gsl_matrix_view_array
34 gsl_matrix_view_array_with_tda gsl_matrix_view_vector
35 gsl_matrix_view_vector_with_tda gsl_matrix_const_submatrix
36 gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
37 gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
38 gsl_matrix_const_subrow gsl_matrix_const_subcolumn
39 gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
40 gsl_matrix_const_view_vector gsl_matrix_const_view_vector_with_tda
41 gsl_matrix_get gsl_matrix_set gsl_matrix_ptr gsl_matrix_const_ptr
42 gsl_matrix_set_zero gsl_matrix_set_identity gsl_matrix_set_all
43 gsl_matrix_fread gsl_matrix_fwrite gsl_matrix_fscanf gsl_matrix_fprintf
44 gsl_matrix_memcpy gsl_matrix_swap gsl_matrix_swap_rows
45 gsl_matrix_swap_columns gsl_matrix_swap_rowcol gsl_matrix_transpose
46 gsl_matrix_transpose_memcpy gsl_matrix_max gsl_matrix_min
47 gsl_matrix_minmax gsl_matrix_max_index gsl_matrix_min_index
48 gsl_matrix_minmax_index gsl_matrix_isnull gsl_matrix_ispos
49 gsl_matrix_isneg gsl_matrix_isnonneg gsl_matrix_add gsl_matrix_sub
50 gsl_matrix_mul_elements gsl_matrix_div_elements gsl_matrix_scale
51 gsl_matrix_add_constant gsl_matrix_add_diagonal
52 gsl_matrix_char_alloc gsl_matrix_char_calloc gsl_matrix_char_alloc_from_block
53 gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
54 gsl_matrix_char_free gsl_matrix_char_submatrix
55 gsl_matrix_char_row gsl_matrix_char_column
56 gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
57 gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
58 gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
59 gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
60 gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
61 gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
62 gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
63 gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
64 gsl_matrix_char_set_zero gsl_matrix_char_set_identity
65 gsl_matrix_char_set_all gsl_matrix_char_fread
66 gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
67 gsl_matrix_char_memcpy gsl_matrix_char_swap
68 gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
69 gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
70 gsl_matrix_char_max gsl_matrix_char_min
71 gsl_matrix_char_minmax gsl_matrix_char_max_index
72 gsl_matrix_char_min_index gsl_matrix_char_minmax_index
73 gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
74 gsl_matrix_char_isnonneg gsl_matrix_char_add
75 gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
76 gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
77 gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
78 gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
79 gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
80 gsl_matrix_int_column gsl_matrix_int_diagonal gsl_matrix_int_subdiagonal
81 gsl_matrix_int_superdiagonal gsl_matrix_int_subrow gsl_matrix_int_subcolumn gsl_matrix_int_view_array
82 gsl_matrix_int_view_array_with_tda gsl_matrix_int_view_vector gsl_matrix_int_view_vector_with_tda
83 gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
84 gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
85 gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
86 gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
87 gsl_matrix_int_get gsl_matrix_int_set
88 gsl_matrix_int_ptr gsl_matrix_int_const_ptr
89 gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
90 gsl_matrix_int_fread gsl_matrix_int_fwrite
91 gsl_matrix_int_fscanf gsl_matrix_int_fprintf
92 gsl_matrix_int_memcpy gsl_matrix_int_swap
93 gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
94 gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
95 gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
96 gsl_matrix_int_max_index gsl_matrix_int_min_index
97 gsl_matrix_int_minmax_index gsl_matrix_int_isnull
98 gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
99 gsl_matrix_int_add gsl_matrix_int_sub
100 gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
101 gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
102 gsl_matrix_get_row gsl_matrix_get_col gsl_matrix_set_row gsl_matrix_set_col
103 gsl_matrix_complex_alloc gsl_matrix_complex_calloc gsl_matrix_complex_alloc_from_block
104 gsl_matrix_complex_alloc_from_matrix gsl_vector_complex_alloc_row_from_matrix gsl_vector_complex_alloc_col_from_matrix
105 gsl_matrix_complex_free gsl_matrix_complex_submatrix gsl_matrix_complex_row
106 gsl_matrix_complex_column gsl_matrix_complex_diagonal gsl_matrix_complex_subdiagonal
107 gsl_matrix_complex_superdiagonal gsl_matrix_complex_subrow gsl_matrix_complex_subcolumn
108 gsl_matrix_complex_view_array gsl_matrix_complex_view_array_with_tda gsl_matrix_complex_view_vector
109 gsl_matrix_complex_view_vector_with_tda gsl_matrix_complex_const_submatrix gsl_matrix_complex_const_row
110 gsl_matrix_complex_const_column gsl_matrix_complex_const_diagonal gsl_matrix_complex_const_subdiagonal
111 gsl_matrix_complex_const_superdiagonal gsl_matrix_complex_const_subrow gsl_matrix_complex_const_subcolumn
112 gsl_matrix_complex_const_view_array gsl_matrix_complex_const_view_array_with_tda gsl_matrix_complex_const_view_vector
113 gsl_matrix_complex_const_view_vector_with_tda gsl_matrix_complex_get gsl_matrix_complex_set
114 gsl_matrix_complex_ptr gsl_matrix_complex_const_ptr gsl_matrix_complex_set_zero
115 gsl_matrix_complex_set_identity gsl_matrix_complex_set_all gsl_matrix_complex_fread
116 gsl_matrix_complex_fwrite gsl_matrix_complex_fscanf gsl_matrix_complex_fprintf
117 gsl_matrix_complex_memcpy gsl_matrix_complex_swap gsl_matrix_complex_swap_rows
118 gsl_matrix_complex_swap_columns gsl_matrix_complex_swap_rowcol gsl_matrix_complex_transpose
119 gsl_matrix_complex_transpose_memcpy gsl_matrix_complex_isnull gsl_matrix_complex_ispos
120 gsl_matrix_complex_isneg gsl_matrix_complex_add gsl_matrix_complex_sub
121 gsl_matrix_complex_mul_elements gsl_matrix_complex_div_elements gsl_matrix_complex_scale
122 gsl_matrix_complex_add_constant gsl_matrix_complex_add_diagonal gsl_matrix_complex_get_row
123 gsl_matrix_complex_get_col gsl_matrix_complex_set_row gsl_matrix_complex_set_col /;
125 %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], complex => [gsl_matrix_complex_alloc, gsl_matrix_complex_calloc, gsl_matrix_complex_alloc_from_block, gsl_matrix_complex_alloc_from_matrix, gsl_vector_complex_alloc_row_from_matrix, gsl_vector_complex_alloc_col_from_matrix, gsl_matrix_complex_free, gsl_matrix_complex_submatrix, gsl_matrix_complex_row, gsl_matrix_complex_column, gsl_matrix_complex_diagonal, gsl_matrix_complex_subdiagonal, gsl_matrix_complex_superdiagonal, gsl_matrix_complex_subrow, gsl_matrix_complex_subcolumn, gsl_matrix_complex_view_array, gsl_matrix_complex_view_array_with_tda, gsl_matrix_complex_view_vector, gsl_matrix_complex_view_vector_with_tda, gsl_matrix_complex_const_submatrix, gsl_matrix_complex_const_row, gsl_matrix_complex_const_column, gsl_matrix_complex_const_diagonal, gsl_matrix_complex_const_subdiagonal, gsl_matrix_complex_const_superdiagonal, gsl_matrix_complex_const_subrow, gsl_matrix_complex_const_subcolumn, gsl_matrix_complex_const_view_array, gsl_matrix_complex_const_view_array_with_tda, gsl_matrix_complex_const_view_vector, gsl_matrix_complex_const_view_vector_with_tda, gsl_matrix_complex_get, gsl_matrix_complex_set, gsl_matrix_complex_ptr, gsl_matrix_complex_const_ptr, gsl_matrix_complex_set_zero, gsl_matrix_complex_set_identity, gsl_matrix_complex_set_all, gsl_matrix_complex_fread, gsl_matrix_complex_fwrite, gsl_matrix_complex_fscanf, gsl_matrix_complex_fprintf, gsl_matrix_complex_memcpygsl_matrix_complex_swap, gsl_matrix_complex_swap_rows, gsl_matrix_complex_swap_columns, gsl_matrix_complex_swap_rowcol, gsl_matrix_complex_transpose, gsl_matrix_complex_transpose_memcpy, gsl_matrix_complex_isnull, gsl_matrix_complex_ispos, gsl_matrix_complex_isneg, gsl_matrix_complex_add, gsl_matrix_complex_sub, gsl_matrix_complex_mul_elements, gsl_matrix_complex_div_elements, gsl_matrix_complex_scale, gsl_matrix_complex_add_constant, gsl_matrix_complex_add_diagonal, gsl_matrix_complex_get_row, gsl_matrix_complex_get_col, gsl_matrix_complex_set_row, gsl_matrix_complex_set_col]);
127 __END__
129 =head1 NAME
131 Math::GSL::Matrix - Mathematical functions concerning Matrices
133 =head1 SYPNOPSIS
135 use Math::GSL::Matrix qw/:all/;
137 =head1 DESCRIPTION
139 Here is a list of all the functions included in this module :
141 gsl_matrix_alloc($i, $j) - Return a gsl_matrix of $i rows and $j columns
142 gsl_matrix_calloc($i, $j) - Return a gsl_matrix of $i rows and $j columns and initialize all of the elements of the matrix to zero
143 gsl_matrix_alloc_from_block
144 gsl_matrix_alloc_from_matrix
145 gsl_vector_alloc_row_from_matrix
146 gsl_vector_alloc_col_from_matrix
147 gsl_matrix_free
148 gsl_matrix_submatrix($m, $k1, $k2, $n1, $n2) - Return a matrix view of the matrix $m. The upper-left element of the submatrix is the element ($k1,$k2) of the original matrix. The submatrix has $n1 rows and $n2 columns.
149 gsl_matrix_row($m , $i) - Return a vector view of the $i-th row of the matrix $m
150 gsl_matrix_column($m, $j) - Return a vector view of the $j-th column of the matrix $m
151 gsl_matrix_diagonal($m) - Return a vector view of the diagonal of the vector. The matrix doesn't have to be square.
152 gsl_matrix_subdiagonal($m, $k) - Return a vector view of the $k-th subdiagonal of the matrix $m. The diagonal of the matrix corresponds to k=0.
153 gsl_matrix_superdiagonal($m, $k) - Return a vector view of the $k-th superdiagonal of the matrix $m. The matrix doesn't have to be square.
154 gsl_matrix_subrow($m, $i, $offset, $n) - Return a vector view of the $i-th row of the matrix $m beginning at offset elements and containing n elements.
155 gsl_matrix_subcolumn($m, $j, $offset, $n) - Return a vector view of the $j-th column of the matrix $m beginning at offset elements and containing n elements.
156 gsl_matrix_view_array
157 gsl_matrix_view_array_with_tda
158 gsl_matrix_view_vector
159 gsl_matrix_view_vector_with_tda
160 gsl_matrix_const_submatrix
161 gsl_matrix_get($m, $i, $j) - Return the (i,j)-th element of the matrix $m
162 gsl_matrix_set($m, $i, $j, $x) - Set the value of the (i,j)-th element of the matrix $m to $x
163 gsl_matrix_ptr
164 gsl_matrix_const_ptr
165 gsl_matrix_set_zero($m) - Set all the elements of the matrix $m to zero
166 gsl_matrix_set_identity($m) - Set the elements of the matrix $m to the corresponding elements of the identity matrix
167 gsl_matrix_set_all($m, $x) - Set all the elements of the matrix $m to the value $x
168 gsl_matrix_fread($fh, $m) - Read a file which has been written with gsl_matrix_fwrite from the stream $fh opened with the fopen function and stores the data inside the matrix $m
169 gsl_matrix_fwrite($fh, $m) - Write the elements of the matrix $m in binary format to a stream $fh opened with the fopen function
170 gsl_matrix_fscanf($fh, $m) - Read a file which has been written with gsl_matrix_fprintf from the stream $fh opened with the fopen function and stores the data inside the matrix $m
171 gsl_matrix_fprintf($fh, $m, $format) - Write the elements of the matrix $m in the format $format (for example "%f" is the format for double) to a stream $fh opened with the fopen function
172 gsl_matrix_memcpy($dest, $src) - Copy the elements of the matrix $src to the matrix $dest. The two matrices must have the same size.
173 gsl_matrix_swap($m1, $m2) - Exchange the elements of the matrices $m1 and $m2 by copying. The two matrices must have the same size.
174 gsl_matrix_swap_rows($m, $i, $j) - Exchange the $i-th and $j-th row of the matrix $m. The function returns 0 if the operation suceeded, 1 otherwise.
175 gsl_matrix_swap_columns($m, $i, $j) - Exchange the $i-th and $j-th column of the matrix $m. The function returns 0 if the operation suceeded, 1 otherwise.
176 gsl_matrix_swap_rowcol($m, $i, $j) - Exchange the $i-th row and the $j-th column of the matrix $m. The matrix must be square. The function returns 0 if the operation suceeded, 1 otherwise.
177 gsl_matrix_transpose($m) - This function replaces the matrix m by its transpose by copying the elements of the matrix in-place. The matrix must be square for this operation to be possible.
178 gsl_matrix_transpose_memcpy($dest, $src) - Make the matrix $dest the transpose of the matrix $src. This function works for all matrices provided that the dimensions of the matrix dest match the transposed dimensions of the matrix src.
179 gsl_matrix_max($m) - Return the maximum value in the matrix $m
180 gsl_matrix_min($m) - Return the minimum value in the matrix $m
181 gsl_matrix_minmax($m) - Return two values, the first is the minimum value of the Matrix $m and the second is the maximum of the same the same matrix.
182 gsl_matrix_max_index($m) - Return two values, the first is the the i indice of the maximum value of the matrix $m and the second is the j indice of the same value.
183 gsl_matrix_min_index - Return two values, the first is the the i indice of the minimum value of the matrix $m and the second is the j indice of the same value.
184 gsl_matrix_minmax_index($m) - Return four values, the first is the i indice of the minimum of the matrix $m, the second is the j indice of the same value, the third is the i indice of the maximum of the matrix $m and the fourth is the j indice of the same value
185 gsl_matrix_isnull($m) - Return 1 if all the elements of the matrix $m are zero, 0 otherwise
186 gsl_matrix_ispos($m) - Return 1 if all the elements of the matrix $m are strictly positve, 0 otherwise
187 gsl_matrix_isneg($m) - Return 1 if all the elements of the matrix $m are strictly negative, 0 otherwise
188 gsl_matrix_isnonneg($m) - Return 1 if all the elements of the matrix $m are non-negatuive, 0 otherwise
189 gsl_matrix_add($a, $b) - Add the elements of matrix $b to the elements of matrix $a
190 gsl_matrix_sub($a, $b) - Subtract the elements of matrix $b from the elements of matrix $a
191 gsl_matrix_mul_elements($a, $b) - Multiplie the elements of matrix $a by the elements of matrix $b
192 gsl_matrix_div_elements($a, $b) - Divide the elements of matrix $a by the elements of matrix $b
193 gsl_matrix_scale($a, $x) - Multiplie the elements of matrix $a by the constant factor $x
194 gsl_matrix_add_constant($a, $x) - Add the constant value $x to the elements of the matrix $a
195 gsl_matrix_add_diagonal($a, $x) - Add the constant value $x to the elements of the diagonal of the matrix $a
196 gsl_matrix_get_row($v, $m, $i) - Copy the elements of the $i-th row of the matrix $m into the vector $v. The lenght of the vector must be of the same as the lenght of the row. The function returns 0 if it succeded, 1 otherwise.
197 gsl_matrix_get_col($v, $m, $i) - Copy the elements of the $j-th column of the matrix $m into the vector $v. The lenght of the vector must be of the same as the lenght of the column. The function returns 0 if it succeded, 1 otherwise.
198 gsl_matrix_set_row($m, $i, $v) - Copy the elements of vector $v into the $i-th row of the matrix $m The lenght of the vector must be of the same as the lenght of the row. The function returns 0 if it succeded, 1 otherwise.
199 gsl_matrix_set_col($m, $j, $v) - Copy the elements of vector $v into the $j-th row of the matrix $m The lenght of the vector must be of the same as the lenght of the column. The function returns 0 if it succeded, 1 otherwise.
201 The following functions are specific to matrices containing complex numbers :
203 gsl_matrix_complex_alloc
204 gsl_matrix_complex_calloc
205 gsl_matrix_complex_alloc_from_block
206 gsl_matrix_complex_alloc_from_matrix
207 gsl_vector_complex_alloc_row_from_matrix
208 gsl_vector_complex_alloc_col_from_matrix
209 gsl_matrix_complex_free
210 gsl_matrix_complex_submatrix
211 gsl_matrix_complex_row
212 gsl_matrix_complex_column
213 gsl_matrix_complex_diagonal
214 gsl_matrix_complex_subdiagonal
215 gsl_matrix_complex_superdiagonal
216 gsl_matrix_complex_subrow
217 gsl_matrix_complex_subcolumn
218 gsl_matrix_complex_view_array
219 gsl_matrix_complex_view_array_with_tda
220 gsl_matrix_complex_view_vector
221 gsl_matrix_complex_view_vector_with_tda
222 gsl_matrix_complex_const_submatrix
223 gsl_matrix_complex_const_row
224 gsl_matrix_complex_const_column
225 gsl_matrix_complex_const_diagonal
226 gsl_matrix_complex_const_subdiagonal
227 gsl_matrix_complex_const_superdiagonal
228 gsl_matrix_complex_const_subrow
229 gsl_matrix_complex_const_subcolumn
230 gsl_matrix_complex_const_view_array
231 gsl_matrix_complex_const_view_array_with_tda
232 gsl_matrix_complex_const_view_vector
233 gsl_matrix_complex_const_view_vector_with_tda
234 gsl_matrix_complex_get
235 gsl_matrix_complex_set
236 gsl_matrix_complex_ptr
237 gsl_matrix_complex_const_ptr
238 gsl_matrix_complex_set_zero
239 gsl_matrix_complex_set_identity
240 gsl_matrix_complex_set_all
241 gsl_matrix_complex_fread
242 gsl_matrix_complex_fwrite
243 gsl_matrix_complex_fscanf
244 gsl_matrix_complex_fprintf
245 gsl_matrix_complex_memcpy
246 gsl_matrix_complex_swap
247 gsl_matrix_complex_swap_rows
248 gsl_matrix_complex_swap_columns
249 gsl_matrix_complex_swap_rowcol
250 gsl_matrix_complex_transpose
251 gsl_matrix_complex_transpose_memcpy
252 gsl_matrix_complex_isnull
253 gsl_matrix_complex_ispos
254 gsl_matrix_complex_isneg
255 gsl_matrix_complex_add
256 gsl_matrix_complex_sub
257 gsl_matrix_complex_mul_elements
258 gsl_matrix_complex_div_elements
259 gsl_matrix_complex_scale
260 gsl_matrix_complex_add_constant
261 gsl_matrix_complex_add_diagonal
262 gsl_matrix_complex_get_row
263 gsl_matrix_complex_get_col
264 gsl_matrix_complex_set_row
265 gsl_matrix_complex_set_col
268 The following functions are the same as the previous enonced ones except that they work with other data types than double.
270 gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
271 gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
272 gsl_matrix_const_subrow gsl_matrix_const_subcolumn
273 gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
274 gsl_matrix_const_view_vector gsl_matrix_const_view_vector_with_tda
275 gsl_matrix_char_alloc gsl_matrix_char_calloc gsl_matrix_char_alloc_from_block
276 gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
277 gsl_matrix_char_free gsl_matrix_char_submatrix
278 gsl_matrix_char_row gsl_matrix_char_column
279 gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
280 gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
281 gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
282 gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
283 gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
284 gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
285 gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
286 gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
287 gsl_matrix_char_set_zero gsl_matrix_char_set_identity
288 gsl_matrix_char_set_all gsl_matrix_char_fread
289 gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
290 gsl_matrix_char_memcpy gsl_matrix_char_swap
291 gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
292 gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
293 gsl_matrix_char_max gsl_matrix_char_min
294 gsl_matrix_char_minmax gsl_matrix_char_max_index
295 gsl_matrix_char_min_index gsl_matrix_char_minmax_index
296 gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
297 gsl_matrix_char_isnonneg gsl_matrix_char_add
298 gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
299 gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
300 gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
301 gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
302 gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
303 gsl_matrix_int_column gsl_matrix_int_diagonal gsl_matrix_int_subdiagonal
304 gsl_matrix_int_superdiagonal gsl_matrix_int_subrow gsl_matrix_int_subcolumn gsl_matrix_int_view_array
305 gsl_matrix_int_view_array_with_tda gsl_matrix_int_view_vector gsl_matrix_int_view_vector_with_tda
306 gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
307 gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
308 gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
309 gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
310 gsl_matrix_int_get gsl_matrix_int_set
311 gsl_matrix_int_ptr gsl_matrix_int_const_ptr
312 gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
313 gsl_matrix_int_fread gsl_matrix_int_fwrite
314 gsl_matrix_int_fscanf gsl_matrix_int_fprintf
315 gsl_matrix_int_memcpy gsl_matrix_int_swap
316 gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
317 gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
318 gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
319 gsl_matrix_int_max_index gsl_matrix_int_min_index
320 gsl_matrix_int_minmax_index gsl_matrix_int_isnull
321 gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
322 gsl_matrix_int_add gsl_matrix_int_sub
323 gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
324 gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
326 You have to add the functions you want to use inside the qw /put_funtion_here /.
327 You can also write use Math::GSL::PowInt qw/:name_of_tag/ to use all avaible functions of the module.
328 Other tags are also avaible, here is a complete list of all tags for this module :
330 all
331 int
332 double
333 char
334 complex
336 For more informations on the functions, we refer you to the GSL offcial documentation: http://www.gnu.org/software/gsl/manual/html_node/
337 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/name_of_the_function_you_want
339 =head1 EXAMPLES
341 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
343 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.
345 use Math::GSL::Matrix qw/:all/;
346 $m = gsl_matrix_alloc (10,3);
347 for($i = 0; $i< 10; $i++){
348 for($j = 0; $j<3; $j++){
349 gsl_matrix_set($m, $i, $j, 0.23 + 100*$i + $j);
353 for($i = 0; $i< 100; $i++){ # OUT OF RANGE ERROR
354 for($j=0; $j<3; $j++){
355 print "m($i, $j) = " . gsl_matrix_get ($m, $i, $j) . "\n";
358 gsl_matrix_free ($m);
361 use Math::GSL::Matrix qw/:all/;
363 $m = gsl_matrix_alloc (100, 100);
364 $a = gsl_matrix_alloc (100, 100);
366 for($i = 0; $i < 100; $i++){
367 for($j = 0; $j < 100; $j++){
368 gsl_matrix_set ($m, $i, $j, 0.23 + $i + $j);
372 The next program shows how to write a matrix to a file.
374 $out = fopen("test.dat", "wb");
375 gsl_matrix_fwrite ($out, $m);
376 fclose ($out);
378 $in = fopen("test.dat", "rb");
379 gsl_matrix_fread ($in, $a);
380 fclose($in);
382 $k=0;
383 for($i = 0; $i < 100; $i++){
384 for($j = 0; $j < 100; $j++){
385 $mij = gsl_matrix_get ($m, $i, $j);
386 $aij = gsl_matrix_get ($a, $i, $j);
387 if ($mij != $aij){ $k++ };
391 gsl_matrix_free($m);
392 gsl_matrix_free($a);
394 print "differences = $k (should be zero)\n";
396 =head1 AUTHOR
398 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
400 =head1 COPYRIGHT AND LICENSE
402 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
404 This program is free software; you can redistribute it and/or modify it
405 under the same terms as Perl itself.
407 =cut