BLAS.i

   1 %module BLAS
   2
   3 %include "typemaps.i"
   4 %include "gsl_typemaps.i"
   5
   6 %apply float *OUTPUT { float *result };
   7 %apply double *OUTPUT { double *result };
   8
   9 %{
  10     #include "gsl/gsl_blas.h"
  11     #include "gsl/gsl_blas_types.h"
  12 %}
  13
  14 %include "gsl/gsl_blas.h"
  15 %include "gsl/gsl_blas_types.h"
  16
  17 %perlcode %{
  18
  19 @EXPORT_OK_level1 = qw/
  20                         gsl_blas_sdsdot gsl_blas_dsdot gsl_blas_sdot gsl_blas_ddot
  21                         gsl_blas_cdotu gsl_blas_cdotc gsl_blas_zdotu gsl_blas_zdotc
  22                         gsl_blas_snrm2 gsl_blas_sasum gsl_blas_dnrm2 gsl_blas_dasum
  23                         gsl_blas_scnrm2 gsl_blas_scasum gsl_blas_dznrm2 gsl_blas_dzasum
  24                         gsl_blas_isamax gsl_blas_idamax gsl_blas_icamax gsl_blas_izamax
  25                         gsl_blas_sswap gsl_blas_scopy gsl_blas_saxpy gsl_blas_dswap
  26                         gsl_blas_dcopy gsl_blas_daxpy gsl_blas_cswap gsl_blas_ccopy
  27                         gsl_blas_caxpy gsl_blas_zswap gsl_blas_zcopy gsl_blas_zaxpy
  28                         gsl_blas_srotg gsl_blas_srotmg gsl_blas_srot gsl_blas_srotm
  29                         gsl_blas_drotg gsl_blas_drotmg gsl_blas_drot gsl_blas_drotm
  30                         gsl_blas_sscal gsl_blas_dscal gsl_blas_cscal gsl_blas_zscal
  31                         gsl_blas_csscal gsl_blas_zdscal
  32                     /;
  33 @EXPORT_OK_level2 = qw/
  34                         gsl_blas_sgemv gsl_blas_strmv
  35                         gsl_blas_strsv gsl_blas_dgemv gsl_blas_dtrmv gsl_blas_dtrsv
  36                         gsl_blas_cgemv gsl_blas_ctrmv gsl_blas_ctrsv gsl_blas_zgemv
  37                         gsl_blas_ztrmv gsl_blas_ztrsv gsl_blas_ssymv gsl_blas_sger
  38                         gsl_blas_ssyr gsl_blas_ssyr2 gsl_blas_dsymv gsl_blas_dger
  39                         gsl_blas_dsyr gsl_blas_dsyr2 gsl_blas_chemv gsl_blas_cgeru
  40                         gsl_blas_cgerc gsl_blas_cher gsl_blas_cher2 gsl_blas_zhemv
  41                         gsl_blas_zgeru gsl_blas_zgerc gsl_blas_zher gsl_blas_zher2
  42                     /;
  43
  44 @EXPORT_OK_level3 = qw/
  45                         gsl_blas_sgemm gsl_blas_ssymm gsl_blas_ssyrk gsl_blas_ssyr2k
  46                         gsl_blas_strmm gsl_blas_strsm gsl_blas_dgemm gsl_blas_dsymm
  47                         gsl_blas_dsyrk gsl_blas_dsyr2k gsl_blas_dtrmm gsl_blas_dtrsm
  48                         gsl_blas_cgemm gsl_blas_csymm gsl_blas_csyrk gsl_blas_csyr2k
  49                         gsl_blas_ctrmm gsl_blas_ctrsm gsl_blas_zgemm gsl_blas_zsymm
  50                         gsl_blas_zsyrk gsl_blas_zsyr2k gsl_blas_ztrmm gsl_blas_ztrsm
  51                         gsl_blas_chemm gsl_blas_cherk gsl_blas_cher2k gsl_blas_zhemm
  52                         gsl_blas_zherk gsl_blas_zher2k
  53                     /;
  54 @EXPORT_OK = (@EXPORT_OK_level1, @EXPORT_OK_level2, @EXPORT_OK_level3);
  55 %EXPORT_TAGS = (
  56                 all    => [ @EXPORT_OK ],
  57                 level1 => [ @EXPORT_OK_level1 ],
  58                 level2 => [ @EXPORT_OK_level2 ],
  59                 level3 => [ @EXPORT_OK_level3 ],
  60                );
  61 __END__
  62
  63 =head1 NAME
  64
  65 Math::GSL::BLAS - Basic Linear Algebra Subprograms
  66
  67 =head1 SYNOPSIS
  68
  69 use Math::GSL::QRNG qw/:all/;
  70
  71 =head1 DESCRIPTION
  72
  73 The functions of this module are divised into 3 levels:
  74
  75 =head2 Level 1 - Vector operations
  76
  77 =over 3
  78
  79 =item C<gsl_blas_sdsdot>
  80
  81 =item C<gsl_blas_dsdot>
  82
  83 =item C<gsl_blas_sdot>
  84
  85 =item C<gsl_blas_ddot($x, $y)> - This function computes the scalar product x^T y for the vectors $x and $y. The function returns two values, the first is 0 if the operation suceeded, 1 otherwise and the second value is the result of the computation.
  86
  87 =item C<gsl_blas_cdotu>
  88
  89 =item C<gsl_blas_cdotc>
  90
  91 =item C<gsl_blas_zdotu($x, $y, $dotu)> - This function computes the complex scalar product x^T y for the complex vectors $x and $y, returning the result in the complex number $dotu. The function returns 0 if the operation suceeded, 1 otherwise.
  92
  93 =item C<gsl_blas_zdotc($x, $y, $dotc)> - This function computes the complex conjugate scalar product x^H y for the complex vectors $x and $y, returning the result in the complex number $dotc. The function returns 0 if the operation suceeded, 1 otherwise.
  94
  95 =item C<gsl_blas_snrm2>
  96 =item C<gsl_blas_sasum>
  97
  98 =item C<gsl_blas_dnrm2($x)> - This function computes the Euclidean norm ||x||_2 = \sqrt {\sum x_i^2} of the vector $x.
  99
 100 =item C<gsl_blas_dasum($x)> - This function computes the absolute sum \sum |x_i| of the elements of the vector $x.
 101
 102 =item C<gsl_blas_scnrm2>
 103
 104 =item C<gsl_blas_scasum>
 105
 106 =item C<gsl_blas_dznrm2($x)> - This function computes the Euclidean norm of the complex vector $x, ||x||_2 = \sqrt {\sum (\Re(x_i)^2 + \Im(x_i)^2)}.
 107
 108 =item C<gsl_blas_dzasum($x)> - This function computes the sum of the magnitudes of the real and imaginary parts of the complex vector $x, \sum |\Re(x_i)| + |\Im(x_i)|.
 109
 110 =item C<gsl_blas_isamax>
 111
 112 =item C<gsl_blas_idamax>
 113
 114 =item C<gsl_blas_icamax>
 115
 116 =item C<gsl_blas_izamax >
 117
 118 =item C<gsl_blas_sswap>
 119
 120 =item C<gsl_blas_scopy>
 121
 122 =item C<gsl_blas_saxpy>
 123
 124 =item C<gsl_blas_dswap($x, $y)> - This function exchanges the elements of the vectors $x and $y. The function returns 0 if the operation suceeded, 1 otherwise.
 125
 126 =item C<gsl_blas_dcopy($x, $y)> - This function copies the elements of the vector $x into the vector $y. The function returns 0 if the operation suceeded, 1 otherwise.
 127
 128 =item C<gsl_blas_daxpy($alpha, $x, $y)> - These functions compute the sum $y = $alpha * $x + $y for the vectors $x and $y.
 129
 130 =item C<gsl_blas_cswap>
 131
 132 =item C<gsl_blas_ccopy >
 133
 134 =item C<gsl_blas_caxpy>
 135
 136 =item C<gsl_blas_zswap>
 137
 138 =item C<gsl_blas_zcopy>
 139
 140 =item C<gsl_blas_zaxpy >
 141
 142 =item C<gsl_blas_srotg>
 143
 144 =item C<gsl_blas_srotmg>
 145
 146 =item C<gsl_blas_srot>
 147
 148 =item C<gsl_blas_srotm >
 149
 150 =item C<gsl_blas_drotg>
 151
 152 =item C<gsl_blas_drotmg>
 153
 154 =item C<gsl_blas_drot($x, $y, $c, $s)> - This function applies a Givens rotation (x', y') = (c x + s y, -s x + c y) to the vectors $x, $y.
 155
 156 =item C<gsl_blas_drotm >
 157
 158 =item C<gsl_blas_sscal>
 159
 160 =item C<gsl_blas_dscal($alpha, $x)> - This function rescales the vector $x by the multiplicative factor $alpha.
 161
 162 =item C<gsl_blas_cscal>
 163
 164 =item C<gsl_blas_zscal >
 165
 166 =item C<gsl_blas_csscal>
 167
 168 =item C<gsl_blas_zdscal>
 169
 170 =back
 171
 172 =head2 Level 2 - Matrix-vector operations
 173
 174 =over 3
 175
 176 =item C<gsl_blas_sgemv>
 177
 178 =item C<gsl_blas_strmv >
 179
 180 =item C<gsl_blas_strsv>
 181
 182 =item C<gsl_blas_dgemv($TransA, $alpha, $A, $x, $beta, $y)> - This function computes the matrix-vector product and sum y = \alpha op(A) x + \beta y, where op(A) = A, A^T, A^H for $TransA = $CblasNoTrans, $CblasTrans, $CblasConjTrans (constant values coming from the CBLAS module). $A is a matrix and $x and $y are vectors. The function returns 0 if the operation suceeded, 1 otherwise.
 183
 184 =item C<gsl_blas_dtrmv($Uplo, $TransA, $Diag, $A, $x)> - This function computes the matrix-vector product x = op(A) x for the triangular matrix $A, where op(A) = A, A^T, A^H for $TransA = $CblasNoTrans, $CblasTrans, $CblasConjTrans (constant values coming from the CBLAS module). When $Uplo is $CblasUpper then the upper triangle of $A is used, and when $Uplo is $CblasLower then the lower triangle of $A is used. If $Diag is $CblasNonUnit then the diagonal of the matrix is used, but if $Diag is $CblasUnit then the diagonal elements of the matrix $A are taken as unity and are not referenced. The function returns 0 if the operation suceeded, 1 otherwise.
 185
 186 =item C<gsl_blas_dtrsv($Uplo, $TransA, $Diag, $A, $x)> - This function computes inv(op(A)) x for the vector $x, where op(A) = A, A^T, A^H for $TransA = $CblasNoTrans, $CblasTrans, $CblasConjTrans (constant values coming from the CBLAS module). When $Uplo is $CblasUpper then the upper triangle of $A is used, and when $Uplo is $CblasLower then the lower triangle of $A is used. If $Diag is $CblasNonUnit then the diagonal of the matrix is used, but if $Diag is $CblasUnit then the diagonal elements of the matrix $A are taken as unity and are not referenced. The function returns 0 if the operation suceeded, 1 otherwise.
 187
 188 =item C<gsl_blas_cgemv >
 189
 190 =item C<gsl_blas_ctrmv>
 191
 192 =item C<gsl_blas_ctrsv>
 193
 194 =item C<gsl_blas_zgemv >
 195
 196 =item C<gsl_blas_ztrmv>
 197
 198 =item C<gsl_blas_ztrsv>
 199
 200 =item C<gsl_blas_ssymv>
 201
 202 =item C<gsl_blas_sger >
 203
 204 =item C<gsl_blas_ssyr>
 205
 206 =item C<gsl_blas_ssyr2>
 207
 208 =item C<gsl_blas_dsymv>
 209
 210 =item C<gsl_blas_dger($alpha, $x, $y, $A)> - This function computes the rank-1 update A = alpha x y^T + A of the matrix $A. $x and $y are vectors. The function returns 0 if the operation suceeded, 1 otherwise.
 211
 212 =item C<gsl_blas_dsyr($Uplo, $alpha, $x, $A)> - This function computes the symmetric rank-1 update A = \alpha x x^T + A of the symmetric matrix $A and the vector $x. Since the matrix $A is symmetric only its upper half or lower half need to be stored. When $Uplo is $CblasUpper then the upper triangle and diagonal of $A are used, and when $Uplo is $CblasLower then the lower triangle and diagonal of $A are used. The function returns 0 if the operation suceeded, 1 otherwise.
 213
 214 =item C<gsl_blas_dsyr2($Uplo, $alpha, $x, $y, $A)> - This function computes the symmetric rank-2 update A = \alpha x y^T + \alpha y x^T + A of the symmetric matrix $A, the vector $x and vector $y. Since the matrix $A is symmetric only its upper half or lower half need to be stored. When $Uplo is $CblasUpper then the upper triangle and diagonal of $A are used, and when $Uplo is $CblasLower then the lower triangle and diagonal of $A are used.
 215
 216 =item C<gsl_blas_chemv>
 217
 218 =item C<gsl_blas_cgeru >
 219
 220 =item C<gsl_blas_cgerc>
 221
 222 =item C<gsl_blas_cher>
 223
 224 =item C<gsl_blas_cher2>
 225
 226 =item C<gsl_blas_zhemv >
 227
 228 =item C<gsl_blas_zgeru($alpha, $x, $y, $A)> - This function computes the rank-1 update A = alpha x y^T + A of the complex matrix $A. $alpha is a complex number and $x and $y are complex vectors. The function returns 0 if the operation suceeded, 1 otherwise.
 229
 230 =item C<gsl_blas_zgerc>
 231
 232 =item C<gsl_blas_zher($Uplo, $alpha, $x, $A)> - This function computes the hermitian rank-1 update A = \alpha x x^H + A of the hermitian matrix $A and of the complex vector $x. Since the matrix $A is hermitian only its upper half or lower half need to be stored. When $Uplo is $CblasUpper then the upper triangle and diagonal of $A are used, and when $Uplo is $CblasLower then the lower triangle and diagonal of $A are used. The imaginary elements of the diagonal are automatically set to zero. The function returns 0 if the operation suceeded, 1 otherwise.
 233
 234
 235 =item C<gsl_blas_zher2 >
 236
 237 =back
 238
 239 =head2 Level 3 - Matrix-matrix operations
 240
 241 =over 3
 242
 243 =item C<gsl_blas_sgemm>
 244
 245 =item C<gsl_blas_ssymm>
 246
 247 =item C<gsl_blas_ssyrk>
 248
 249 =item C<gsl_blas_ssyr2k >
 250
 251 =item C<gsl_blas_strmm>
 252
 253 =item C<gsl_blas_strsm>
 254
 255 =item C<gsl_blas_dgemm($TransA, $TransB, $alpha, $A, $B, $beta, $C)> - This function computes the matrix-matrix product and sum C = \alpha op(A) op(B) + \beta C where op(A) = A, A^T, A^H for $TransA = $CblasNoTrans, $CblasTrans, $CblasConjTrans and similarly for the parameter $TransB. The function returns 0 if the operation suceeded, 1 otherwise.
 256
 257 =item C<gsl_blas_dsymm>
 258
 259 =item C<gsl_blas_dsyrk>
 260
 261 =item C<gsl_blas_dsyr2k>
 262
 263 =item C<gsl_blas_dtrmm>
 264
 265 =item C<gsl_blas_dtrsm >
 266
 267 =item C<gsl_blas_cgemm>
 268
 269 =item C<gsl_blas_csymm>
 270
 271 =item C<gsl_blas_csyrk>
 272
 273 =item C<gsl_blas_csyr2k >
 274
 275 =item C<gsl_blas_ctrmm>
 276
 277 =item C<gsl_blas_ctrsm>
 278
 279 =item C<gsl_blas_zgemm>
 280
 281 =item C<gsl_blas_zsymm >
 282
 283 =item C<gsl_blas_zsyrk>
 284
 285 =item C<gsl_blas_zsyr2k>
 286
 287 =item C<gsl_blas_ztrmm>
 288
 289 =item C<gsl_blas_ztrsm >
 290
 291 =item C<gsl_blas_chemm>
 292
 293 =item C<gsl_blas_cherk>
 294
 295 =item C<gsl_blas_cher2k>
 296
 297 =item C<gsl_blas_zhemm >
 298
 299 =item C<gsl_blas_zherk >
 300
 301 =item C<gsl_blas_zher2k >
 302
 303 =back
 304
 305 You have to add the functions you want to use inside the qw /put_funtion_here /.
 306 You can also write use Math::GSL::PowInt qw/:all/ to use all avaible functions of the module.
 307 Other tags are also avaible, here is a complete list of all tags for this module :
 308
 309 =over 3
 310
 311 =item C<level1>
 312
 313 =item C<level2>
 314
 315 =item C<level3>
 316
 317 =back
 318
 319 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 320
 321 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 322
 323
 324 =head1 EXAMPLES
 325
 326 =head1 AUTHOR
 327
 328 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 329
 330 =head1 COPYRIGHT AND LICENSE
 331
 332 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 333
 334 This program is free software; you can redistribute it and/or modify it
 335 under the same terms as Perl itself.
 336
 337 =cut
 338
 339 %}