Comment out some more free() calls, which need to be turned on per-subsystem to weed...
[Math-GSL.git] / pod / CBLAS.pod
blobb3775fc0a3a8db5c87fd79566cc4a0e698047f7e
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 ] );
160 __END__
162 =head1 NAME
164 Math::GSL::CBLAS - Basic Linear Algebra Subprograms based on C functions
166 =head1 SYNOPSIS
168 use Math::GSL::CBLAS qw/:all/;
170 =head1 DESCRIPTION
172 Here is a list of all the functions included in this module :
174 =over 1
176 =item C<cblas_sdsdot>
178 =item C<cblas_dsdot>
180 =item C<cblas_sdot>
182 =item C<cblas_ddot>
184 =item C<cblas_cdotu_sub>
186 =item C<cblas_cdotc_sub>
188 =item C<cblas_zdotu_sub>
190 =item C<cblas_zdotc_sub>
192 =item C<cblas_snrm2>
194 =item C<cblas_sasum>
196 =item C<cblas_dnrm2>
198 =item C<cblas_dasum>
200 =item C<cblas_scnrm2>
202 =item C<cblas_scasum>
204 =item C<cblas_dznrm2>
206 =item C<cblas_dzasum>
208 =item C<cblas_isamax>
210 =item C<cblas_idamax>
212 =item C<cblas_icamax>
214 =item C<cblas_izamax>
216 =item C<cblas_sswap>
218 =item C<cblas_scopy>
220 =item C<cblas_saxpy>
222 =item C<cblas_dswap>
224 =item C<cblas_dcopy>
226 =item C<cblas_daxpy>
228 =item C<cblas_cswap>
230 =item C<cblas_ccopy>
232 =item C<cblas_caxpy>
234 =item C<cblas_zswap>
236 =item C<cblas_zcopy>
238 =item C<cblas_zaxpy>
240 =item C<cblas_srotg>
242 =item C<cblas_srotmg>
244 =item C<cblas_srot>
246 =item C<cblas_srotm>
248 =item C<cblas_drotg>
250 =item C<cblas_drotmg>
252 =item C<cblas_drot>
254 =item C<cblas_drotm>
256 =item C<cblas_sscal>
258 =item C<cblas_dscal>
260 =item C<cblas_cscal>
262 =item C<cblas_zscal>
264 =item C<cblas_csscal>
266 =item C<cblas_zdscal>
268 =item C<cblas_sgemv>
270 =item C<cblas_sgbmv>
272 =item C<cblas_strmv>
274 =item C<cblas_stbmv>
276 =item C<cblas_stpmv>
278 =item C<cblas_strsv>
280 =item C<cblas_stbsv>
282 =item C<cblas_stpsv>
284 =item C<cblas_dgemv>
286 =item C<cblas_dgbmv>
288 =item C<cblas_dtrmv>
290 =item C<cblas_dtbmv>
292 =item C<cblas_dtpmv>
294 =item C<cblas_dtrsv>
296 =item C<cblas_dtbsv>
298 =item C<cblas_dtpsv>
300 =item C<cblas_cgemv>
302 =item C<cblas_cgbmv>
304 =item C<cblas_ctrmv>
306 =item C<cblas_ctbmv>
308 =item C<cblas_ctpmv>
310 =item C<cblas_ctrsv>
312 =item C<cblas_ctbsv>
314 =item C<cblas_ctpsv>
316 =item C<cblas_zgemv>
318 =item C<cblas_zgbmv>
320 =item C<cblas_ztrmv>
322 =item C<cblas_ztbmv>
324 =item C<cblas_ztpmv>
326 =item C<cblas_ztrsv>
328 =item C<cblas_ztbsv>
330 =item C<cblas_ztpsv>
332 =item C<cblas_ssymv>
334 =item C<cblas_ssbmv>
336 =item C<cblas_sspmv>
338 =item C<cblas_sger>
340 =item C<cblas_ssyr>
342 =item C<cblas_sspr>
344 =item C<cblas_ssyr2>
346 =item C<cblas_sspr2>
348 =item C<cblas_dsymv>
350 =item C<cblas_dsbmv>
352 =item C<cblas_dspmv>
354 =item C<cblas_dger>
356 =item C<cblas_dsyr>
358 =item C<cblas_dspr>
360 =item C<cblas_dsyr2>
362 =item C<cblas_dspr2>
364 =item C<cblas_chemv>
366 =item C<cblas_chbmv>
368 =item C<cblas_chpmv>
370 =item C<cblas_cgeru>
372 =item C<cblas_cgerc>
374 =item C<cblas_cher>
376 =item C<cblas_chpr>
378 =item C<cblas_cher2>
380 =item C<cblas_chpr2>
382 =item C<cblas_zhemv>
384 =item C<cblas_zhbmv>
386 =item C<cblas_zhpmv>
388 =item C<cblas_zgeru>
390 =item C<cblas_zgerc>
392 =item C<cblas_zher>
394 =item C<cblas_zhpr>
396 =item C<cblas_zher2>
398 =item C<cblas_zhpr2>
400 =item C<cblas_sgemm>
402 =item C<cblas_ssymm>
404 =item C<cblas_ssyrk>
406 =item C<cblas_ssyr2k>
408 =item C<cblas_strmm>
410 =item C<cblas_strsm>
412 =item C<cblas_dgemm>
414 =item C<cblas_dsymm>
416 =item C<cblas_dsyrk>
418 =item C<cblas_dsyr2k>
420 =item C<cblas_dtrmm>
422 =item C<cblas_dtrsm>
424 =item C<cblas_cgemm>
426 =item C<cblas_csymm>
428 =item C<cblas_csyrk>
430 =item C<cblas_csyr2k>
432 =item C<cblas_ctrmm>
434 =item C<cblas_ctrsm>
436 =item C<cblas_zgemm>
438 =item C<cblas_zsymm>
440 =item C<cblas_zsyrk>
442 =item C<cblas_zsyr2k>
444 =item C<cblas_ztrmm>
446 =item C<cblas_ztrsm>
448 =item C<cblas_chemm>
450 =item C<cblas_cherk>
452 =item C<cblas_cher2k>
454 =item C<cblas_zhemm>
456 =item C<cblas_zherk>
458 =item C<cblas_zher2k>
460 =item C<cblas_xerbla>
462 =back
464 This module also contains the following constants : 
466 =over 1
468 =item C<$CblasRowMajor>
469                
470 =item C<$CblasColMajor> 
472 =item C<$CblasNoTrans > 
474 =item C<$CblasTrans > 
476 =item C<$CblasConjTrans > 
478 =item C<$CblasUpper> 
480 =item C<$CblasLower> 
482 =item C<$CblasNonUnit> 
483                              
484 =item C<$CblasUnit >
486 =item C<$CblasLeft >
488 =item C<$CblasRight >
490 =back
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/>
494 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
497 =head1 EXAMPLES
499 =head1 AUTHORS
501 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
503 =head1 COPYRIGHT AND LICENSE
505 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
507 This program is free software; you can redistribute it and/or modify it
508 under the same terms as Perl itself.
510 =cut