pod/CBLAS.pod

   1 %perlcode %{
   2 @EXPORT_OK = qw/
   3                cblas_sdsdot
   4                cblas_dsdot
   5                cblas_sdot
   6                cblas_ddot
   7                cblas_cdotu_sub
   8                cblas_cdotc_sub
   9                cblas_zdotu_sub
  10                cblas_zdotc_sub
  11                cblas_snrm2
  12                cblas_sasum
  13                cblas_dnrm2
  14                cblas_dasum
  15                cblas_scnrm2
  16                cblas_scasum
  17                cblas_dznrm2
  18                cblas_dzasum
  19                cblas_isamax
  20                cblas_idamax
  21                cblas_icamax
  22                cblas_izamax
  23                cblas_sswap
  24                cblas_scopy
  25                cblas_saxpy
  26                cblas_dswap
  27                cblas_dcopy
  28                cblas_daxpy
  29                cblas_cswap
  30                cblas_ccopy
  31                cblas_caxpy
  32                cblas_zswap
  33                cblas_zcopy
  34                cblas_zaxpy
  35                cblas_srotg
  36                cblas_srotmg
  37                cblas_srot
  38                cblas_srotm
  39                cblas_drotg
  40                cblas_drotmg
  41                cblas_drot
  42                cblas_drotm
  43                cblas_sscal
  44                cblas_dscal
  45                cblas_cscal
  46                cblas_zscal
  47                cblas_csscal
  48                cblas_zdscal
  49                cblas_sgemv
  50                cblas_sgbmv
  51                cblas_strmv
  52                cblas_stbmv
  53                cblas_stpmv
  54                cblas_strsv
  55                cblas_stbsv
  56                cblas_stpsv
  57                cblas_dgemv
  58                cblas_dgbmv
  59                cblas_dtrmv
  60                cblas_dtbmv
  61                cblas_dtpmv
  62                cblas_dtrsv
  63                cblas_dtbsv
  64                cblas_dtpsv
  65                cblas_cgemv
  66                cblas_cgbmv
  67                cblas_ctrmv
  68                cblas_ctbmv
  69                cblas_ctpmv
  70                cblas_ctrsv
  71                cblas_ctbsv
  72                cblas_ctpsv
  73                cblas_zgemv
  74                cblas_zgbmv
  75                cblas_ztrmv
  76                cblas_ztbmv
  77                cblas_ztpmv
  78                cblas_ztrsv
  79                cblas_ztbsv
  80                cblas_ztpsv
  81                cblas_ssymv
  82                cblas_ssbmv
  83                cblas_sspmv
  84                cblas_sger
  85                cblas_ssyr
  86                cblas_sspr
  87                cblas_ssyr2
  88                cblas_sspr2
  89                cblas_dsymv
  90                cblas_dsbmv
  91                cblas_dspmv
  92                cblas_dger
  93                cblas_dsyr
  94                cblas_dspr
  95                cblas_dsyr2
  96                cblas_dspr2
  97                cblas_chemv
  98                cblas_chbmv
  99                cblas_chpmv
 100                cblas_cgeru
 101                cblas_cgerc
 102                cblas_cher
 103                cblas_chpr
 104                cblas_cher2
 105                cblas_chpr2
 106                cblas_zhemv
 107                cblas_zhbmv
 108                cblas_zhpmv
 109                cblas_zgeru
 110                cblas_zgerc
 111                cblas_zher
 112                cblas_zhpr
 113                cblas_zher2
 114                cblas_zhpr2
 115                cblas_sgemm
 116                cblas_ssymm
 117                cblas_ssyrk
 118                cblas_ssyr2k
 119                cblas_strmm
 120                cblas_strsm
 121                cblas_dgemm
 122                cblas_dsymm
 123                cblas_dsyrk
 124                cblas_dsyr2k
 125                cblas_dtrmm
 126                cblas_dtrsm
 127                cblas_cgemm
 128                cblas_csymm
 129                cblas_csyrk
 130                cblas_csyr2k
 131                cblas_ctrmm
 132                cblas_ctrsm
 133                cblas_zgemm
 134                cblas_zsymm
 135                cblas_zsyrk
 136                cblas_zsyr2k
 137                cblas_ztrmm
 138                cblas_ztrsm
 139                cblas_chemm
 140                cblas_cherk
 141                cblas_cher2k
 142                cblas_zhemm
 143                cblas_zherk
 144                cblas_zher2k
 145                cblas_xerbla
 146                $CblasRowMajor
 147                $CblasColMajor
 148                $CblasNoTrans
 149                $CblasTrans
 150                $CblasConjTrans
 151                $CblasUpper
 152                $CblasLower
 153                $CblasNonUnit
 154                $CblasUnit
 155                $CblasLeft
 156                $CblasRight
 157              /;
 158 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
 159
 160 __END__
 161
 162 =head1 NAME
 163
 164 Math::GSL::CBLAS - Basic Linear Algebra Subprograms based on C functions
 165
 166 =head1 SYNOPSIS
 167
 168 use Math::GSL::CBLAS qw/:all/;
 169
 170 =head1 DESCRIPTION
 171
 172 Here is a list of all the functions included in this module :
 173
 174 =over 1
 175
 176 =item C<cblas_sdsdot>
 177
 178 =item C<cblas_dsdot>
 179
 180 =item C<cblas_sdot>
 181
 182 =item C<cblas_ddot>
 183
 184 =item C<cblas_cdotu_sub>
 185
 186 =item C<cblas_cdotc_sub>
 187
 188 =item C<cblas_zdotu_sub>
 189
 190 =item C<cblas_zdotc_sub>
 191
 192 =item C<cblas_snrm2>
 193
 194 =item C<cblas_sasum>
 195
 196 =item C<cblas_dnrm2>
 197
 198 =item C<cblas_dasum>
 199
 200 =item C<cblas_scnrm2>
 201
 202 =item C<cblas_scasum>
 203
 204 =item C<cblas_dznrm2>
 205
 206 =item C<cblas_dzasum>
 207
 208 =item C<cblas_isamax>
 209
 210 =item C<cblas_idamax>
 211
 212 =item C<cblas_icamax>
 213
 214 =item C<cblas_izamax>
 215
 216 =item C<cblas_sswap>
 217
 218 =item C<cblas_scopy>
 219
 220 =item C<cblas_saxpy>
 221
 222 =item C<cblas_dswap>
 223
 224 =item C<cblas_dcopy>
 225
 226 =item C<cblas_daxpy>
 227
 228 =item C<cblas_cswap>
 229
 230 =item C<cblas_ccopy>
 231
 232 =item C<cblas_caxpy>
 233
 234 =item C<cblas_zswap>
 235
 236 =item C<cblas_zcopy>
 237
 238 =item C<cblas_zaxpy>
 239
 240 =item C<cblas_srotg>
 241
 242 =item C<cblas_srotmg>
 243
 244 =item C<cblas_srot>
 245
 246 =item C<cblas_srotm>
 247
 248 =item C<cblas_drotg>
 249
 250 =item C<cblas_drotmg>
 251
 252 =item C<cblas_drot>
 253
 254 =item C<cblas_drotm>
 255
 256 =item C<cblas_sscal>
 257
 258 =item C<cblas_dscal>
 259
 260 =item C<cblas_cscal>
 261
 262 =item C<cblas_zscal>
 263
 264 =item C<cblas_csscal>
 265
 266 =item C<cblas_zdscal>
 267
 268 =item C<cblas_sgemv>
 269
 270 =item C<cblas_sgbmv>
 271
 272 =item C<cblas_strmv>
 273
 274 =item C<cblas_stbmv>
 275
 276 =item C<cblas_stpmv>
 277
 278 =item C<cblas_strsv>
 279
 280 =item C<cblas_stbsv>
 281
 282 =item C<cblas_stpsv>
 283
 284 =item C<cblas_dgemv>
 285
 286 =item C<cblas_dgbmv>
 287
 288 =item C<cblas_dtrmv>
 289
 290 =item C<cblas_dtbmv>
 291
 292 =item C<cblas_dtpmv>
 293
 294 =item C<cblas_dtrsv>
 295
 296 =item C<cblas_dtbsv>
 297
 298 =item C<cblas_dtpsv>
 299
 300 =item C<cblas_cgemv>
 301
 302 =item C<cblas_cgbmv>
 303
 304 =item C<cblas_ctrmv>
 305
 306 =item C<cblas_ctbmv>
 307
 308 =item C<cblas_ctpmv>
 309
 310 =item C<cblas_ctrsv>
 311
 312 =item C<cblas_ctbsv>
 313
 314 =item C<cblas_ctpsv>
 315
 316 =item C<cblas_zgemv>
 317
 318 =item C<cblas_zgbmv>
 319
 320 =item C<cblas_ztrmv>
 321
 322 =item C<cblas_ztbmv>
 323
 324 =item C<cblas_ztpmv>
 325
 326 =item C<cblas_ztrsv>
 327
 328 =item C<cblas_ztbsv>
 329
 330 =item C<cblas_ztpsv>
 331
 332 =item C<cblas_ssymv>
 333
 334 =item C<cblas_ssbmv>
 335
 336 =item C<cblas_sspmv>
 337
 338 =item C<cblas_sger>
 339
 340 =item C<cblas_ssyr>
 341
 342 =item C<cblas_sspr>
 343
 344 =item C<cblas_ssyr2>
 345
 346 =item C<cblas_sspr2>
 347
 348 =item C<cblas_dsymv>
 349
 350 =item C<cblas_dsbmv>
 351
 352 =item C<cblas_dspmv>
 353
 354 =item C<cblas_dger>
 355
 356 =item C<cblas_dsyr>
 357
 358 =item C<cblas_dspr>
 359
 360 =item C<cblas_dsyr2>
 361
 362 =item C<cblas_dspr2>
 363
 364 =item C<cblas_chemv>
 365
 366 =item C<cblas_chbmv>
 367
 368 =item C<cblas_chpmv>
 369
 370 =item C<cblas_cgeru>
 371
 372 =item C<cblas_cgerc>
 373
 374 =item C<cblas_cher>
 375
 376 =item C<cblas_chpr>
 377
 378 =item C<cblas_cher2>
 379
 380 =item C<cblas_chpr2>
 381
 382 =item C<cblas_zhemv>
 383
 384 =item C<cblas_zhbmv>
 385
 386 =item C<cblas_zhpmv>
 387
 388 =item C<cblas_zgeru>
 389
 390 =item C<cblas_zgerc>
 391
 392 =item C<cblas_zher>
 393
 394 =item C<cblas_zhpr>
 395
 396 =item C<cblas_zher2>
 397
 398 =item C<cblas_zhpr2>
 399
 400 =item C<cblas_sgemm>
 401
 402 =item C<cblas_ssymm>
 403
 404 =item C<cblas_ssyrk>
 405
 406 =item C<cblas_ssyr2k>
 407
 408 =item C<cblas_strmm>
 409
 410 =item C<cblas_strsm>
 411
 412 =item C<cblas_dgemm>
 413
 414 =item C<cblas_dsymm>
 415
 416 =item C<cblas_dsyrk>
 417
 418 =item C<cblas_dsyr2k>
 419
 420 =item C<cblas_dtrmm>
 421
 422 =item C<cblas_dtrsm>
 423
 424 =item C<cblas_cgemm>
 425
 426 =item C<cblas_csymm>
 427
 428 =item C<cblas_csyrk>
 429
 430 =item C<cblas_csyr2k>
 431
 432 =item C<cblas_ctrmm>
 433
 434 =item C<cblas_ctrsm>
 435
 436 =item C<cblas_zgemm>
 437
 438 =item C<cblas_zsymm>
 439
 440 =item C<cblas_zsyrk>
 441
 442 =item C<cblas_zsyr2k>
 443
 444 =item C<cblas_ztrmm>
 445
 446 =item C<cblas_ztrsm>
 447
 448 =item C<cblas_chemm>
 449
 450 =item C<cblas_cherk>
 451
 452 =item C<cblas_cher2k>
 453
 454 =item C<cblas_zhemm>
 455
 456 =item C<cblas_zherk>
 457
 458 =item C<cblas_zher2k>
 459
 460 =item C<cblas_xerbla>
 461
 462 =back
 463
 464 This module also contains the following constants :
 465
 466 =over 1
 467
 468 =item C<$CblasRowMajor>
 469
 470 =item C<$CblasColMajor>
 471
 472 =item C<$CblasNoTrans >
 473
 474 =item C<$CblasTrans >
 475
 476 =item C<$CblasConjTrans >
 477
 478 =item C<$CblasUpper>
 479
 480 =item C<$CblasLower>
 481
 482 =item C<$CblasNonUnit>
 483
 484 =item C<$CblasUnit >
 485
 486 =item C<$CblasLeft >
 487
 488 =item C<$CblasRight >
 489
 490 =back
 491
 492 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 493
 494 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 495
 496
 497 =head1 EXAMPLES
 498
 499 =head1 AUTHORS
 500
 501 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 502
 503 =head1 COPYRIGHT AND LICENSE
 504
 505 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
 506
 507 This program is free software; you can redistribute it and/or modify it
 508 under the same terms as Perl itself.
 509
 510 =cut
 511
 512 %}