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