Low-level BLAS functions (scipy.linalg.blas)

This module contains low-level functions from the BLAS library.

New in version 0.12.0.

Note

The common overwrite_<> option in many routines, allows the input arrays to be overwritten to avoid extra memory allocation. However this requires the array to satisfy two conditions which are memory order and the data type to match exactly the order and the type expected by the routine.

As an example, if you pass a double precision float array to any S.... routine which expects single precision arguments, f2py will create an intermediate array to match the argument types and overwriting will be performed on that intermediate array.

Similarly, if a C-contiguous array is passed, f2py will pass a FORTRAN-contiguous array internally. Please make sure that these details are satisfied. More information can be found in the f2py documentation.

Warning

These functions do little to no error checking. It is possible to cause crashes by mis-using them, so prefer using the higher-level routines in scipy.linalg.

Finding functions

get_blas_funcs(names[, arrays, dtype])	Return available BLAS function objects from names.
find_best_blas_type([arrays, dtype])	Find best-matching BLAS/LAPACK type.

BLAS Level 1 functions

caxpy(x,y,[n,a,offx,incx,offy,incy])	Wrapper for caxpy.
ccopy(x,y,[n,offx,incx,offy,incy])	Wrapper for ccopy.
cdotc(x,y,[n,offx,incx,offy,incy])	Wrapper for cdotc.
cdotu(x,y,[n,offx,incx,offy,incy])	Wrapper for cdotu.
crotg(a,b)	Wrapper for crotg.
cscal(a,x,[n,offx,incx])	Wrapper for cscal.
csrot(…)	Wrapper for csrot.
csscal(a,x,[n,offx,incx,overwrite_x])	Wrapper for csscal.
cswap(x,y,[n,offx,incx,offy,incy])	Wrapper for cswap.
dasum(x,[n,offx,incx])	Wrapper for dasum.
daxpy(x,y,[n,a,offx,incx,offy,incy])	Wrapper for daxpy.
dcopy(x,y,[n,offx,incx,offy,incy])	Wrapper for dcopy.
ddot(x,y,[n,offx,incx,offy,incy])	Wrapper for ddot.
dnrm2(x,[n,offx,incx])	Wrapper for dnrm2.
drot(…)	Wrapper for drot.
drotg(a,b)	Wrapper for drotg.
drotm(…)	Wrapper for drotm.
drotmg(d1,d2,x1,y1)	Wrapper for drotmg.
dscal(a,x,[n,offx,incx])	Wrapper for dscal.
dswap(x,y,[n,offx,incx,offy,incy])	Wrapper for dswap.
dzasum(x,[n,offx,incx])	Wrapper for dzasum.
dznrm2(x,[n,offx,incx])	Wrapper for dznrm2.
icamax(x,[n,offx,incx])	Wrapper for icamax.
idamax(x,[n,offx,incx])	Wrapper for idamax.
isamax(x,[n,offx,incx])	Wrapper for isamax.
izamax(x,[n,offx,incx])	Wrapper for izamax.
sasum(x,[n,offx,incx])	Wrapper for sasum.
saxpy(x,y,[n,a,offx,incx,offy,incy])	Wrapper for saxpy.
scasum(x,[n,offx,incx])	Wrapper for scasum.
scnrm2(x,[n,offx,incx])	Wrapper for scnrm2.
scopy(x,y,[n,offx,incx,offy,incy])	Wrapper for scopy.
sdot(x,y,[n,offx,incx,offy,incy])	Wrapper for sdot.
snrm2(x,[n,offx,incx])	Wrapper for snrm2.
srot(…)	Wrapper for srot.
srotg(a,b)	Wrapper for srotg.
srotm(…)	Wrapper for srotm.
srotmg(d1,d2,x1,y1)	Wrapper for srotmg.
sscal(a,x,[n,offx,incx])	Wrapper for sscal.
sswap(x,y,[n,offx,incx,offy,incy])	Wrapper for sswap.
zaxpy(x,y,[n,a,offx,incx,offy,incy])	Wrapper for zaxpy.
zcopy(x,y,[n,offx,incx,offy,incy])	Wrapper for zcopy.
zdotc(x,y,[n,offx,incx,offy,incy])	Wrapper for zdotc.
zdotu(x,y,[n,offx,incx,offy,incy])	Wrapper for zdotu.
zdrot(…)	Wrapper for zdrot.
zdscal(a,x,[n,offx,incx,overwrite_x])	Wrapper for zdscal.
zrotg(a,b)	Wrapper for zrotg.
zscal(a,x,[n,offx,incx])	Wrapper for zscal.
zswap(x,y,[n,offx,incx,offy,incy])	Wrapper for zswap.

BLAS Level 2 functions

sgbmv(…)	Wrapper for sgbmv.
sgemv(…)	Wrapper for sgemv.
sger(…)	Wrapper for sger.
ssbmv(…)	Wrapper for ssbmv.
sspr(n,alpha,x,ap,[incx,offx,lower,overwrite_ap])	Wrapper for sspr.
sspr2(…)	Wrapper for sspr2.
ssymv(…)	Wrapper for ssymv.
ssyr(alpha,x,[lower,incx,offx,n,a,overwrite_a])	Wrapper for ssyr.
ssyr2(…)	Wrapper for ssyr2.
stbmv(…)	Wrapper for stbmv.
stpsv(…)	Wrapper for stpsv.
strmv(…)	Wrapper for strmv.
strsv(…)	Wrapper for strsv.
dgbmv(…)	Wrapper for dgbmv.
dgemv(…)	Wrapper for dgemv.
dger(…)	Wrapper for dger.
dsbmv(…)	Wrapper for dsbmv.
dspr(n,alpha,x,ap,[incx,offx,lower,overwrite_ap])	Wrapper for dspr.
dspr2(…)	Wrapper for dspr2.
dsymv(…)	Wrapper for dsymv.
dsyr(alpha,x,[lower,incx,offx,n,a,overwrite_a])	Wrapper for dsyr.
dsyr2(…)	Wrapper for dsyr2.
dtbmv(…)	Wrapper for dtbmv.
dtpsv(…)	Wrapper for dtpsv.
dtrmv(…)	Wrapper for dtrmv.
dtrsv(…)	Wrapper for dtrsv.
cgbmv(…)	Wrapper for cgbmv.
cgemv(…)	Wrapper for cgemv.
cgerc(…)	Wrapper for cgerc.
cgeru(…)	Wrapper for cgeru.
chbmv(…)	Wrapper for chbmv.
chemv(…)	Wrapper for chemv.
cher(alpha,x,[lower,incx,offx,n,a,overwrite_a])	Wrapper for cher.
cher2(…)	Wrapper for cher2.
chpmv(…)	Wrapper for chpmv.
chpr(n,alpha,x,ap,[incx,offx,lower,overwrite_ap])	Wrapper for chpr.
chpr2(…)	Wrapper for chpr2.
ctbmv(…)	Wrapper for ctbmv.
ctbsv(…)	Wrapper for ctbsv.
ctpmv(…)	Wrapper for ctpmv.
ctpsv(…)	Wrapper for ctpsv.
ctrmv(…)	Wrapper for ctrmv.
ctrsv(…)	Wrapper for ctrsv.
csyr(alpha,x,[lower,incx,offx,n,a,overwrite_a])	Wrapper for csyr.
zgbmv(…)	Wrapper for zgbmv.
zgemv(…)	Wrapper for zgemv.
zgerc(…)	Wrapper for zgerc.
zgeru(…)	Wrapper for zgeru.
zhbmv(…)	Wrapper for zhbmv.
zhemv(…)	Wrapper for zhemv.
zher(alpha,x,[lower,incx,offx,n,a,overwrite_a])	Wrapper for zher.
zher2(…)	Wrapper for zher2.
zhpmv(…)	Wrapper for zhpmv.
zhpr(n,alpha,x,ap,[incx,offx,lower,overwrite_ap])	Wrapper for zhpr.
zhpr2(…)	Wrapper for zhpr2.
ztbmv(…)	Wrapper for ztbmv.
ztbsv(…)	Wrapper for ztbsv.
ztpmv(…)	Wrapper for ztpmv.
ztrmv(…)	Wrapper for ztrmv.
ztrsv(…)	Wrapper for ztrsv.
zsyr(alpha,x,[lower,incx,offx,n,a,overwrite_a])	Wrapper for zsyr.

BLAS Level 3 functions

sgemm(…)	Wrapper for sgemm.
ssymm(alpha,a,b,[beta,c,side,lower,overwrite_c])	Wrapper for ssymm.
ssyr2k(…)	Wrapper for ssyr2k.
ssyrk(alpha,a,[beta,c,trans,lower,overwrite_c])	Wrapper for ssyrk.
strmm(…)	Wrapper for strmm.
strsm(…)	Wrapper for strsm.
dgemm(…)	Wrapper for dgemm.
dsymm(alpha,a,b,[beta,c,side,lower,overwrite_c])	Wrapper for dsymm.
dsyr2k(…)	Wrapper for dsyr2k.
dsyrk(alpha,a,[beta,c,trans,lower,overwrite_c])	Wrapper for dsyrk.
dtrmm(…)	Wrapper for dtrmm.
dtrsm(…)	Wrapper for dtrsm.
cgemm(…)	Wrapper for cgemm.
chemm(alpha,a,b,[beta,c,side,lower,overwrite_c])	Wrapper for chemm.
cher2k(…)	Wrapper for cher2k.
cherk(alpha,a,[beta,c,trans,lower,overwrite_c])	Wrapper for cherk.
csymm(alpha,a,b,[beta,c,side,lower,overwrite_c])	Wrapper for csymm.
csyr2k(…)	Wrapper for csyr2k.
csyrk(alpha,a,[beta,c,trans,lower,overwrite_c])	Wrapper for csyrk.
ctrmm(…)	Wrapper for ctrmm.
ctrsm(…)	Wrapper for ctrsm.
zgemm(…)	Wrapper for zgemm.
zhemm(alpha,a,b,[beta,c,side,lower,overwrite_c])	Wrapper for zhemm.
zher2k(…)	Wrapper for zher2k.
zherk(alpha,a,[beta,c,trans,lower,overwrite_c])	Wrapper for zherk.
zsymm(alpha,a,b,[beta,c,side,lower,overwrite_c])	Wrapper for zsymm.
zsyr2k(…)	Wrapper for zsyr2k.
zsyrk(alpha,a,[beta,c,trans,lower,overwrite_c])	Wrapper for zsyrk.
ztrmm(…)	Wrapper for ztrmm.
ztrsm(…)	Wrapper for ztrsm.