org.nd4j.linalg.factory

Interface BlasWrapper

All Known Implementing Classes:

BaseBlasWrapper

public interface BlasWrapper

This class provides a cleaner direct interface to the BLAS routines by extracting the parameters of the matrices from the matrices itself.

For example, you can just pass the vector and do not have to pass the length, corresponding DoubleBuffer, offset and step size explicitly.

Currently, all the general matrix routines are implemented.

Method Summary

Modifier and Type	Method and Description
IComplexNumber	asum(IComplexNDArray x)
double	asum(INDArray x) Compute || x ||_1 (1-norm, sum of absolute values)
INDArray	axpy(double da, INDArray dx, INDArray dy) Deprecated.
INDArray	axpy(float da, INDArray dx, INDArray dy) Deprecated.
IComplexNDArray	axpy(IComplexNumber da, IComplexNDArray dx, IComplexNDArray dy)
INDArray	axpy(Number da, INDArray dx, INDArray dy) Compute y <- y + x * alpha
void	checkInfo(String name, int info)
IComplexNDArray	copy(IComplexNDArray x, IComplexNDArray y)
INDArray	copy(INDArray x, INDArray y) Compute y <- x (copy a matrix)
double	dot(INDArray x, INDArray y) Compute x^T * y (dot product)
IComplexNumber	dotc(IComplexNDArray x, IComplexNDArray y) Compute x^T * y (dot product)
IComplexNumber	dotu(IComplexNDArray x, IComplexNDArray y) Compute x^T * y (dot product)
int	geev(char jobvl, char jobvr, INDArray A, INDArray WR, INDArray WI, INDArray VL, INDArray VR)
void	gelsd(INDArray A, INDArray B) Generalized Least Squares via *GELSD.
INDArray	gemm(double alpha, INDArray a, INDArray b, double beta, INDArray c) Deprecated.
INDArray	gemm(float alpha, INDArray a, INDArray b, float beta, INDArray c) Deprecated.
IComplexNDArray	gemm(IComplexNumber alpha, IComplexNDArray a, IComplexNDArray b, IComplexNumber beta, IComplexNDArray c) Deprecated.
INDArray	gemv(double alpha, INDArray a, INDArray x, double beta, INDArray y) Deprecated.
INDArray	gemv(float alpha, INDArray a, INDArray x, float beta, INDArray y) Deprecated.
IComplexNDArray	gemv(IComplexDouble alpha, IComplexNDArray a, IComplexNDArray x, IComplexDouble beta, IComplexNDArray y) Deprecated.
IComplexNDArray	gemv(IComplexFloat alpha, IComplexNDArray a, IComplexNDArray x, IComplexFloat beta, IComplexNDArray y) Deprecated.
IComplexNDArray	gemv(IComplexNumber alpha, IComplexNDArray a, IComplexNDArray x, IComplexNumber beta, IComplexNDArray y) Deprecated.
INDArray	gemv(Number alpha, INDArray a, INDArray x, double beta, INDArray y) ************************************************************************ BLAS Level 2
void	geqrf(INDArray A, INDArray tau)
INDArray	ger(double alpha, INDArray x, INDArray y, INDArray a) Deprecated.
INDArray	ger(float alpha, INDArray x, INDArray y, INDArray a) Compute A <- alpha * x * y^T + A (general rank-1 update)
INDArray	ger(Number alpha, INDArray x, INDArray y, INDArray a)
IComplexNDArray	gerc(IComplexDouble alpha, IComplexNDArray x, IComplexNDArray y, IComplexNDArray a) Deprecated.
IComplexNDArray	gerc(IComplexFloat alpha, IComplexNDArray x, IComplexNDArray y, IComplexNDArray a) Deprecated.
IComplexNDArray	geru(IComplexDouble alpha, IComplexNDArray x, IComplexNDArray y, IComplexNDArray a) Deprecated.
IComplexNDArray	geru(IComplexFloat alpha, IComplexNDArray x, IComplexNDArray y, IComplexNDArray a) Deprecated.
IComplexNDArray	geru(IComplexNumber alpha, IComplexNDArray x, IComplexNDArray y, IComplexNDArray a) Compute A <- alpha * x * y^T + A (general rank-1 update)
INDArray	gesv(INDArray a, int[] ipiv, INDArray b) ************************************************************************ LAPACK
int	iamax(IComplexNDArray x) Compute index of element with largest absolute value (complex version).
int	iamax(INDArray x) Compute index of element with largest absolute value (index of absolute value maximum)
Lapack	lapack() LAPack interface
Level1	level1() Return the level 1 functions for this blas impl
Level2	level2() Return the level 2 functions for this blas impl
Level3	level3() Return the level 3 functions for this blas impl
IComplexNumber	nrm2(IComplexNDArray x)
double	nrm2(INDArray x) Compute || x ||_2 (2-norm)
void	ormqr(char side, char trans, INDArray A, INDArray tau, INDArray C)
void	posv(char uplo, INDArray A, INDArray B)
void	saxpy(double alpha, INDArray x, INDArray y) Deprecated.
void	saxpy(float alpha, INDArray x, INDArray y) Deprecated.
INDArray	scal(double alpha, INDArray x) Deprecated.
INDArray	scal(float alpha, INDArray x) Deprecated.
IComplexNDArray	scal(IComplexDouble alpha, IComplexNDArray x) Deprecated.
IComplexNDArray	scal(IComplexFloat alpha, IComplexNDArray x) Deprecated.
IComplexNDArray	scal(IComplexNumber alpha, IComplexNDArray x) Compute x <- alpha * x (scale a matrix)
INDArray	swap(INDArray x, INDArray y) Compute x <-> y (swap two matrices)
int	syev(char jobz, char uplo, INDArray a, INDArray w)
int	syevd(char jobz, char uplo, INDArray A, INDArray w)
int	syevr(char jobz, char range, char uplo, INDArray a, double vl, double vu, int il, int iu, double abstol, INDArray w, INDArray z, int[] isuppz) Deprecated.
int	syevr(char jobz, char range, char uplo, INDArray a, float vl, float vu, int il, int iu, float abstol, INDArray w, INDArray z, int[] isuppz) Deprecated.
int	syevr(char jobz, char range, char uplo, INDArray a, float vl, float vu, int il, int iu, Number abstol, INDArray w, INDArray z, int[] isuppz)
int	syevx(char jobz, char range, char uplo, INDArray a, double vl, double vu, int il, int iu, double abstol, INDArray w, INDArray z)
int	syevx(char jobz, char range, char uplo, INDArray a, float vl, float vu, int il, int iu, float abstol, INDArray w, INDArray z)
int	sygvd(int itype, char jobz, char uplo, INDArray A, INDArray B, INDArray W)
INDArray	sysv(char uplo, INDArray a, int[] ipiv, INDArray b)

Method Detail

swap

INDArray swap(INDArray x,
              INDArray y)

Compute x <-> y (swap two matrices)

level1

Level1 level1()

Return the level 1 functions for this blas impl

Returns:

level2

Level2 level2()

Return the level 2 functions for this blas impl

Returns:

level3

Level3 level3()

Return the level 3 functions for this blas impl

Returns:

lapack

Lapack lapack()

LAPack interface

Returns:

scal

@Deprecated
INDArray scal(double alpha,
                          INDArray x)

Deprecated.

scal

@Deprecated
INDArray scal(float alpha,
                          INDArray x)

Deprecated.

Compute x <- alpha * x (scale a matrix)

scal

@Deprecated
IComplexNDArray scal(IComplexFloat alpha,
                                 IComplexNDArray x)

Deprecated.

scal

@Deprecated
IComplexNDArray scal(IComplexDouble alpha,
                                 IComplexNDArray x)

Deprecated.

scal

IComplexNDArray scal(IComplexNumber alpha,
                     IComplexNDArray x)

Compute x <- alpha * x (scale a matrix)

copy

INDArray copy(INDArray x,
              INDArray y)

Compute y <- x (copy a matrix)

copy

IComplexNDArray copy(IComplexNDArray x,
                     IComplexNDArray y)

axpy

@Deprecated
INDArray axpy(double da,
                          INDArray dx,
                          INDArray dy)

Deprecated.

axpy

@Deprecated
INDArray axpy(float da,
                          INDArray dx,
                          INDArray dy)

Deprecated.

Compute y <- alpha * x + y (elementwise addition)

axpy

INDArray axpy(Number da,
              INDArray dx,
              INDArray dy)

Compute y <- y + x * alpha

Parameters:

da - the alpha to multiply by

dx -

dy -

Returns:

axpy

IComplexNDArray axpy(IComplexNumber da,
                     IComplexNDArray dx,
                     IComplexNDArray dy)

dot

double dot(INDArray x,
           INDArray y)

Compute x^T * y (dot product)

dotc

IComplexNumber dotc(IComplexNDArray x,
                    IComplexNDArray y)

Compute x^T * y (dot product)

dotu

IComplexNumber dotu(IComplexNDArray x,
                    IComplexNDArray y)

Compute x^T * y (dot product)

nrm2

double nrm2(INDArray x)

Compute || x ||_2 (2-norm)

nrm2

IComplexNumber nrm2(IComplexNDArray x)

asum

double asum(INDArray x)

Compute || x ||_1 (1-norm, sum of absolute values)

asum

IComplexNumber asum(IComplexNDArray x)

iamax

int iamax(INDArray x)

Compute index of element with largest absolute value (index of absolute value maximum)

iamax

int iamax(IComplexNDArray x)

Compute index of element with largest absolute value (complex version).

Parameters:

x - matrix

Returns:

index of element with largest absolute value.

gemv

INDArray gemv(Number alpha,
              INDArray a,
              INDArray x,
              double beta,
              INDArray y)

************************************************************************ BLAS Level 2

gemv

@Deprecated
INDArray gemv(double alpha,
                          INDArray a,
                          INDArray x,
                          double beta,
                          INDArray y)

Deprecated.

gemv

@Deprecated
INDArray gemv(float alpha,
                          INDArray a,
                          INDArray x,
                          float beta,
                          INDArray y)

Deprecated.

Compute y <- alpha*op(a)*x + beta * y (general matrix vector multiplication)

ger

INDArray ger(Number alpha,
             INDArray x,
             INDArray y,
             INDArray a)

ger

@Deprecated
INDArray ger(double alpha,
                         INDArray x,
                         INDArray y,
                         INDArray a)

Deprecated.

ger

INDArray ger(float alpha,
             INDArray x,
             INDArray y,
             INDArray a)

Compute A <- alpha * x * y^T + A (general rank-1 update)

gemv

@Deprecated
IComplexNDArray gemv(IComplexDouble alpha,
                                 IComplexNDArray a,
                                 IComplexNDArray x,
                                 IComplexDouble beta,
                                 IComplexNDArray y)

Deprecated.

gemv

@Deprecated
IComplexNDArray gemv(IComplexNumber alpha,
                                 IComplexNDArray a,
                                 IComplexNDArray x,
                                 IComplexNumber beta,
                                 IComplexNDArray y)

Deprecated.

gemv

@Deprecated
IComplexNDArray gemv(IComplexFloat alpha,
                                 IComplexNDArray a,
                                 IComplexNDArray x,
                                 IComplexFloat beta,
                                 IComplexNDArray y)

Deprecated.

geru

@Deprecated
IComplexNDArray geru(IComplexDouble alpha,
                                 IComplexNDArray x,
                                 IComplexNDArray y,
                                 IComplexNDArray a)

Deprecated.

geru

IComplexNDArray geru(IComplexNumber alpha,
                     IComplexNDArray x,
                     IComplexNDArray y,
                     IComplexNDArray a)

Compute A <- alpha * x * y^T + A (general rank-1 update)

geru

@Deprecated
IComplexNDArray geru(IComplexFloat alpha,
                                 IComplexNDArray x,
                                 IComplexNDArray y,
                                 IComplexNDArray a)

Deprecated.

Compute A <- alpha * x * y^T + A (general rank-1 update)

gerc

@Deprecated
IComplexNDArray gerc(IComplexFloat alpha,
                                 IComplexNDArray x,
                                 IComplexNDArray y,
                                 IComplexNDArray a)

Deprecated.

Compute A <- alpha * x * y^H + A (general rank-1 update)

gerc

@Deprecated
IComplexNDArray gerc(IComplexDouble alpha,
                                 IComplexNDArray x,
                                 IComplexNDArray y,
                                 IComplexNDArray a)

Deprecated.

gemm

@Deprecated
INDArray gemm(double alpha,
                          INDArray a,
                          INDArray b,
                          double beta,
                          INDArray c)

Deprecated.

************************************************************************ BLAS Level 3

gemm

@Deprecated
INDArray gemm(float alpha,
                          INDArray a,
                          INDArray b,
                          float beta,
                          INDArray c)

Deprecated.

Compute c <- a*b + beta * c (general matrix matrix multiplication)

gemm

@Deprecated
IComplexNDArray gemm(IComplexNumber alpha,
                                 IComplexNDArray a,
                                 IComplexNDArray b,
                                 IComplexNumber beta,
                                 IComplexNDArray c)

Deprecated.

gesv

INDArray gesv(INDArray a,
              int[] ipiv,
              INDArray b)

************************************************************************ LAPACK

checkInfo

void checkInfo(String name,
               int info)

sysv

INDArray sysv(char uplo,
              INDArray a,
              int[] ipiv,
              INDArray b)

syev

int syev(char jobz,
         char uplo,
         INDArray a,
         INDArray w)

syevx

int syevx(char jobz,
          char range,
          char uplo,
          INDArray a,
          double vl,
          double vu,
          int il,
          int iu,
          double abstol,
          INDArray w,
          INDArray z)

syevx

int syevx(char jobz,
          char range,
          char uplo,
          INDArray a,
          float vl,
          float vu,
          int il,
          int iu,
          float abstol,
          INDArray w,
          INDArray z)

syevd

int syevd(char jobz,
          char uplo,
          INDArray A,
          INDArray w)

syevr

@Deprecated
int syevr(char jobz,
                      char range,
                      char uplo,
                      INDArray a,
                      double vl,
                      double vu,
                      int il,
                      int iu,
                      double abstol,
                      INDArray w,
                      INDArray z,
                      int[] isuppz)

Deprecated.

syevr

@Deprecated
int syevr(char jobz,
                      char range,
                      char uplo,
                      INDArray a,
                      float vl,
                      float vu,
                      int il,
                      int iu,
                      float abstol,
                      INDArray w,
                      INDArray z,
                      int[] isuppz)

Deprecated.

syevr

int syevr(char jobz,
          char range,
          char uplo,
          INDArray a,
          float vl,
          float vu,
          int il,
          int iu,
          Number abstol,
          INDArray w,
          INDArray z,
          int[] isuppz)

posv

void posv(char uplo,
          INDArray A,
          INDArray B)

geev

int geev(char jobvl,
         char jobvr,
         INDArray A,
         INDArray WR,
         INDArray WI,
         INDArray VL,
         INDArray VR)

sygvd

int sygvd(int itype,
          char jobz,
          char uplo,
          INDArray A,
          INDArray B,
          INDArray W)

gelsd

void gelsd(INDArray A,
           INDArray B)

Generalized Least Squares via *GELSD.

Note that B must be padded to contain the solution matrix. This occurs when A has fewer rows than columns.

For example: in A * X = B, A is (m,n), X is (n,k) and B is (m,k). Now if m < n, since B is overwritten to contain the solution (in classical LAPACK style), B needs to be padded to be an (n,k) matrix.

Likewise, if m > n, the solution consists only of the first n rows of B.

Parameters:

A - an (m,n) matrix

B - an (max(m,n), k) matrix (well, at least)

geqrf

void geqrf(INDArray A,
           INDArray tau)

ormqr

void ormqr(char side,
           char trans,
           INDArray A,
           INDArray tau,
           INDArray C)

saxpy

@Deprecated
void saxpy(double alpha,
                       INDArray x,
                       INDArray y)

Deprecated.

saxpy

@Deprecated
void saxpy(float alpha,
                       INDArray x,
                       INDArray y)

Deprecated.

Abstraction over saxpy

Parameters:

alpha - the alpha to scale by

x - the ndarray to use

y - the ndarray to use