Adding documentation and testing skeleton for CBLAS
[Math-GSL.git] / CBLAS.i
blob3248979af0f23d61958f127aa248a1c5b4967424
1 %module CBLAS
3 %{
4 #include "/usr/local/include/gsl/gsl_cblas.h"
5 %}
7 %include "/usr/local/include/gsl/gsl_cblas.h"
10 %perlcode %{
11 @EXPORT_OK = qw/
12 cblas_sdsdot
13 cblas_dsdot
14 cblas_sdot
15 cblas_ddot
16 cblas_cdotu_sub
17 cblas_cdotc_sub
18 cblas_zdotu_sub
19 cblas_zdotc_sub
20 cblas_snrm2
21 cblas_sasum
22 cblas_dnrm2
23 cblas_dasum
24 cblas_scnrm2
25 cblas_scasum
26 cblas_dznrm2
27 cblas_dzasum
28 cblas_isamax
29 cblas_idamax
30 cblas_icamax
31 cblas_izamax
32 cblas_sswap
33 cblas_scopy
34 cblas_saxpy
35 cblas_dswap
36 cblas_dcopy
37 cblas_daxpy
38 cblas_cswap
39 cblas_ccopy
40 cblas_caxpy
41 cblas_zswap
42 cblas_zcopy
43 cblas_zaxpy
44 cblas_srotg
45 cblas_srotmg
46 cblas_srot
47 cblas_srotm
48 cblas_drotg
49 cblas_drotmg
50 cblas_drot
51 cblas_drotm
52 cblas_sscal
53 cblas_dscal
54 cblas_cscal
55 cblas_zscal
56 cblas_csscal
57 cblas_zdscal
58 cblas_sgemv
59 cblas_sgbmv
60 cblas_strmv
61 cblas_stbmv
62 cblas_stpmv
63 cblas_strsv
64 cblas_stbsv
65 cblas_stpsv
66 cblas_dgemv
67 cblas_dgbmv
68 cblas_dtrmv
69 cblas_dtbmv
70 cblas_dtpmv
71 cblas_dtrsv
72 cblas_dtbsv
73 cblas_dtpsv
74 cblas_cgemv
75 cblas_cgbmv
76 cblas_ctrmv
77 cblas_ctbmv
78 cblas_ctpmv
79 cblas_ctrsv
80 cblas_ctbsv
81 cblas_ctpsv
82 cblas_zgemv
83 cblas_zgbmv
84 cblas_ztrmv
85 cblas_ztbmv
86 cblas_ztpmv
87 cblas_ztrsv
88 cblas_ztbsv
89 cblas_ztpsv
90 cblas_ssymv
91 cblas_ssbmv
92 cblas_sspmv
93 cblas_sger
94 cblas_ssyr
95 cblas_sspr
96 cblas_ssyr2
97 cblas_sspr2
98 cblas_dsymv
99 cblas_dsbmv
100 cblas_dspmv
101 cblas_dger
102 cblas_dsyr
103 cblas_dspr
104 cblas_dsyr2
105 cblas_dspr2
106 cblas_chemv
107 cblas_chbmv
108 cblas_chpmv
109 cblas_cgeru
110 cblas_cgerc
111 cblas_cher
112 cblas_chpr
113 cblas_cher2
114 cblas_chpr2
115 cblas_zhemv
116 cblas_zhbmv
117 cblas_zhpmv
118 cblas_zgeru
119 cblas_zgerc
120 cblas_zher
121 cblas_zhpr
122 cblas_zher2
123 cblas_zhpr2
124 cblas_sgemm
125 cblas_ssymm
126 cblas_ssyrk
127 cblas_ssyr2k
128 cblas_strmm
129 cblas_strsm
130 cblas_dgemm
131 cblas_dsymm
132 cblas_dsyrk
133 cblas_dsyr2k
134 cblas_dtrmm
135 cblas_dtrsm
136 cblas_cgemm
137 cblas_csymm
138 cblas_csyrk
139 cblas_csyr2k
140 cblas_ctrmm
141 cblas_ctrsm
142 cblas_zgemm
143 cblas_zsymm
144 cblas_zsyrk
145 cblas_zsyr2k
146 cblas_ztrmm
147 cblas_ztrsm
148 cblas_chemm
149 cblas_cherk
150 cblas_cher2k
151 cblas_zhemm
152 cblas_zherk
153 cblas_zher2k
154 cblas_xerbla
155 $CblasRowMajor
156 $CblasColMajor
157 $CblasNoTrans
158 $CblasTrans
159 $CblasConjTrans
160 $CblasUpper
161 $CblasLower
162 $CblasNonUnit
163 $CblasUnit
164 $CblasLeft
165 $CblasRight
167 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
169 __END__
171 =head1 NAME
173 Math::GSL::CBLAS - Basic Linear Algebra Subprograms
175 =head1 SYPNOPSIS
177 use Math::GSL::CBLAS qw/:all/;
179 =head1 DESCRIPTION
181 Here is a list of all the functions included in this module :
183 =over 1
185 =item C<cblas_sdsdot>
187 =item C<cblas_dsdot>
189 =item C<cblas_sdot>
191 =item C<cblas_ddot>
193 =item C<cblas_cdotu_sub>
195 =item C<cblas_cdotc_sub>
197 =item C<cblas_zdotu_sub>
199 =item C<cblas_zdotc_sub>
201 =item C<cblas_snrm2>
203 =item C<cblas_sasum>
205 =item C<cblas_dnrm2>
207 =item C<cblas_dasum>
209 =item C<cblas_scnrm2>
211 =item C<cblas_scasum>
213 =item C<cblas_dznrm2>
215 =item C<cblas_dzasum>
217 =item C<cblas_isamax>
219 =item C<cblas_idamax>
221 =item C<cblas_icamax>
223 =item C<cblas_izamax>
225 =item C<cblas_sswap>
227 =item C<cblas_scopy>
229 =item C<cblas_saxpy>
231 =item C<cblas_dswap>
233 =item C<cblas_dcopy>
235 =item C<cblas_daxpy>
237 =item C<cblas_cswap>
239 =item C<cblas_ccopy>
241 =item C<cblas_caxpy>
243 =item C<cblas_zswap>
245 =item C<cblas_zcopy>
247 =item C<cblas_zaxpy>
249 =item C<cblas_srotg>
251 =item C<cblas_srotmg>
253 =item C<cblas_srot>
255 =item C<cblas_srotm>
257 =item C<cblas_drotg>
259 =item C<cblas_drotmg>
261 =item C<cblas_drot>
263 =item C<cblas_drotm>
265 =item C<cblas_sscal>
267 =item C<cblas_dscal>
269 =item C<cblas_cscal>
271 =item C<cblas_zscal>
273 =item C<cblas_csscal>
275 =item C<cblas_zdscal>
277 =item C<cblas_sgemv>
279 =item C<cblas_sgbmv>
281 =item C<cblas_strmv>
283 =item C<cblas_stbmv>
285 =item C<cblas_stpmv>
287 =item C<cblas_strsv>
289 =item C<cblas_stbsv>
291 =item C<cblas_stpsv>
293 =item C<cblas_dgemv>
295 =item C<cblas_dgbmv>
297 =item C<cblas_dtrmv>
299 =item C<cblas_dtbmv>
301 =item C<cblas_dtpmv>
303 =item C<cblas_dtrsv>
305 =item C<cblas_dtbsv>
307 =item C<cblas_dtpsv>
309 =item C<cblas_cgemv>
311 =item C<cblas_cgbmv>
313 =item C<cblas_ctrmv>
315 =item C<cblas_ctbmv>
317 =item C<cblas_ctpmv>
319 =item C<cblas_ctrsv>
321 =item C<cblas_ctbsv>
323 =item C<cblas_ctpsv>
325 =item C<cblas_zgemv>
327 =item C<cblas_zgbmv>
329 =item C<cblas_ztrmv>
331 =item C<cblas_ztbmv>
333 =item C<cblas_ztpmv>
335 =item C<cblas_ztrsv>
337 =item C<cblas_ztbsv>
339 =item C<cblas_ztpsv>
341 =item C<cblas_ssymv>
343 =item C<cblas_ssbmv>
345 =item C<cblas_sspmv>
347 =item C<cblas_sger>
349 =item C<cblas_ssyr>
351 =item C<cblas_sspr>
353 =item C<cblas_ssyr2>
355 =item C<cblas_sspr2>
357 =item C<cblas_dsymv>
359 =item C<cblas_dsbmv>
361 =item C<cblas_dspmv>
363 =item C<cblas_dger>
365 =item C<cblas_dsyr>
367 =item C<cblas_dspr>
369 =item C<cblas_dsyr2>
371 =item C<cblas_dspr2>
373 =item C<cblas_chemv>
375 =item C<cblas_chbmv>
377 =item C<cblas_chpmv>
379 =item C<cblas_cgeru>
381 =item C<cblas_cgerc>
383 =item C<cblas_cher>
385 =item C<cblas_chpr>
387 =item C<cblas_cher2>
389 =item C<cblas_chpr2>
391 =item C<cblas_zhemv>
393 =item C<cblas_zhbmv>
395 =item C<cblas_zhpmv>
397 =item C<cblas_zgeru>
399 =item C<cblas_zgerc>
401 =item C<cblas_zher>
403 =item C<cblas_zhpr>
405 =item C<cblas_zher2>
407 =item C<cblas_zhpr2>
409 =item C<cblas_sgemm>
411 =item C<cblas_ssymm>
413 =item C<cblas_ssyrk>
415 =item C<cblas_ssyr2k>
417 =item C<cblas_strmm>
419 =item C<cblas_strsm>
421 =item C<cblas_dgemm>
423 =item C<cblas_dsymm>
425 =item C<cblas_dsyrk>
427 =item C<cblas_dsyr2k>
429 =item C<cblas_dtrmm>
431 =item C<cblas_dtrsm>
433 =item C<cblas_cgemm>
435 =item C<cblas_csymm>
437 =item C<cblas_csyrk>
439 =item C<cblas_csyr2k>
441 =item C<cblas_ctrmm>
443 =item C<cblas_ctrsm>
445 =item C<cblas_zgemm>
447 =item C<cblas_zsymm>
449 =item C<cblas_zsyrk>
451 =item C<cblas_zsyr2k>
453 =item C<cblas_ztrmm>
455 =item C<cblas_ztrsm>
457 =item C<cblas_chemm>
459 =item C<cblas_cherk>
461 =item C<cblas_cher2k>
463 =item C<cblas_zhemm>
465 =item C<cblas_zherk>
467 =item C<cblas_zher2k>
469 =item C<cblas_xerbla>
471 =back
473 This module also contains the following constants :
475 =over 1
477 =item C<$CblasRowMajor>
479 =item C<$CblasColMajor>
481 =item C<$CblasNoTrans >
483 =item C<$CblasTrans >
485 =item C<$CblasConjTrans >
487 =item C<$CblasUpper>
489 =item C<$CblasLower>
491 =item C<$CblasNonUnit>
493 =item C<$CblasUnit >
495 =item C<$CblasLeft >
497 =item C<$CblasRight >
499 =back
501 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
503 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
506 =head1 EXAMPLES
508 =head1 AUTHOR
510 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
512 =head1 COPYRIGHT AND LICENSE
514 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
516 This program is free software; you can redistribute it and/or modify it
517 under the same terms as Perl itself.
519 =cut