BLAS.i

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