nd4j/nd4j-backends/nd4j-api-parent/nd4j-api/src/main/java/org/nd4j/linalg/api/blas/impl/BaseLevel3.java
/*
* ******************************************************************************
* *
* *
* * This program and the accompanying materials are made available under the
* * terms of the Apache License, Version 2.0 which is available at
* * https://www.apache.org/licenses/LICENSE-2.0.
* *
* * See the NOTICE file distributed with this work for additional
* * information regarding copyright ownership.
* * Unless required by applicable law or agreed to in writing, software
* * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* * License for the specific language governing permissions and limitations
* * under the License.
* *
* * SPDX-License-Identifier: Apache-2.0
* *****************************************************************************
*/
package org.nd4j.linalg.api.blas.impl;
import lombok.extern.slf4j.Slf4j;
import org.nd4j.linalg.api.blas.Level3;
import org.nd4j.linalg.api.blas.params.MMulTranspose;
import org.nd4j.linalg.api.buffer.DataType;
import org.nd4j.linalg.api.ndarray.INDArray;
import org.nd4j.linalg.api.ops.executioner.DefaultOpExecutioner;
import org.nd4j.linalg.api.ops.executioner.OpExecutioner;
import org.nd4j.linalg.api.ops.executioner.OpExecutionerUtil;
import org.nd4j.linalg.api.ops.impl.reduce.Mmul;
import org.nd4j.linalg.api.shape.Shape;
import org.nd4j.linalg.exception.ND4JArraySizeException;
import org.nd4j.linalg.factory.Nd4j;
import org.nd4j.linalg.profiler.OpProfiler;
@Slf4j
public abstract class BaseLevel3 extends BaseLevel implements Level3 {
/**
* gemm performs a matrix-matrix operation
* c := alpha*op(a)*op(b) + beta*c,
* where c is an m-by-n matrix,
* op(a) is an m-by-k matrix,
* op(b) is a k-by-n matrix.
* @param Order
* @param TransA
* @param TransB
* @param alpha
* @param A
* @param B
* @param beta
* @param C
*/
@Override
public void gemm(char Order, char TransA, char TransB, double alpha, INDArray A, INDArray B, double beta,
INDArray C) {
if (OpProfiler.getInstance().getConfig().isCheckElapsedTime())
OpProfiler.getInstance().processBlasCall(true, A, B, C);
Nd4j.exec(new Mmul(A, B, C, alpha, beta, MMulTranspose.builder().transposeA(false).transposeB(false).build()));
OpExecutionerUtil.checkForAny(C);
}
/**{@inheritDoc}
*/
@Override
public void gemm(INDArray A, INDArray B, INDArray C, boolean transposeA, boolean transposeB, double alpha,
double beta) {
if (OpProfiler.getInstance().getConfig().isCheckElapsedTime())
OpProfiler.getInstance().processBlasCall(true, A, B, C);
Nd4j.exec(new Mmul(A, B, C, alpha, beta, MMulTranspose.builder().transposeA(transposeA).transposeB(transposeB).build()));
OpExecutionerUtil.checkForAny(C);
}
/**
* her2k performs a rank-2k update of an n-by-n Hermitian matrix c, that is, one of the following operations:
* c := alpha*a*conjg(b') + conjg(alpha)*b*conjg(a') + beta*c, for trans = 'N'or'n'
* c := alpha*conjg(b')*a + conjg(alpha)*conjg(a')*b + beta*c, for trans = 'C'or'c'
* where c is an n-by-n Hermitian matrix;
* a and b are n-by-k matrices if trans = 'N'or'n',
* a and b are k-by-n matrices if trans = 'C'or'c'.
* @param Order
* @param Side
* @param Uplo
* @param alpha
* @param A
* @param B
* @param beta
* @param C
*/
@Override
public void symm(char Order, char Side, char Uplo, double alpha, INDArray A, INDArray B, double beta, INDArray C) {
if (OpProfiler.getInstance().getConfig().isCheckElapsedTime())
OpProfiler.getInstance().processBlasCall(false, A, B, C);
if (C.rows() > Integer.MAX_VALUE || C.columns() > Integer.MAX_VALUE ||
A.size(0) > Integer.MAX_VALUE || B.size(0) > Integer.MAX_VALUE || C.size(0) > Integer.MAX_VALUE) {
throw new ND4JArraySizeException();
}
if (A.data().dataType() == DataType.DOUBLE) {
DefaultOpExecutioner.validateDataType(DataType.DOUBLE, A, B, C);
dsymm(Order, Side, Uplo, C.rows(), C.columns(), alpha, A, (int) A.size(0), B, (int) B.size(0), beta, C, (int) C.size(0));
} else {
DefaultOpExecutioner.validateDataType(DataType.FLOAT, A, B, C);
ssymm(Order, Side, Uplo, C.rows(), C.columns(), (float) alpha, A, (int) A.size(0), B, (int) B.size(0), (float) beta, C,
(int) C.size(0));
}
OpExecutionerUtil.checkForAny(C);
}
/**
* syrk performs a rank-n update of an n-by-n symmetric matrix c, that is, one of the following operations:
* c := alpha*a*a' + beta*c for trans = 'N'or'n'
* c := alpha*a'*a + beta*c for trans = 'T'or't','C'or'c',
* where c is an n-by-n symmetric matrix;
* a is an n-by-k matrix, if trans = 'N'or'n',
* a is a k-by-n matrix, if trans = 'T'or't','C'or'c'.
* @param Order
* @param Uplo
* @param Trans
* @param alpha
* @param A
* @param beta
* @param C
*/
@Override
public void syrk(char Order, char Uplo, char Trans, double alpha, INDArray A, double beta, INDArray C) {
if (OpProfiler.getInstance().getConfig().isCheckElapsedTime())
OpProfiler.getInstance().processBlasCall(false, A, C);
if (C.rows() > Integer.MAX_VALUE ||
A.size(0) > Integer.MAX_VALUE ||
C.size(0) > Integer.MAX_VALUE) {
throw new ND4JArraySizeException();
}
if (A.data().dataType() == DataType.DOUBLE) {
DefaultOpExecutioner.validateDataType(DataType.DOUBLE, A, C);
dsyrk(Order, Uplo, Trans, C.rows(), 1, alpha, A, (int) A.size(0), beta, C, (int) C.size(0));
} else {
DefaultOpExecutioner.validateDataType(DataType.FLOAT, A, C);
ssyrk(Order, Uplo, Trans, C.rows(), 1, (float) alpha, A, (int) A.size(0), (float) beta, C, (int) C.size(0));
}
OpExecutionerUtil.checkForAny(C);
}
/**
* yr2k performs a rank-2k update of an n-by-n symmetric matrix c, that is, one of the following operations:
* c := alpha*a*b' + alpha*b*a' + beta*c for trans = 'N'or'n'
* c := alpha*a'*b + alpha*b'*a + beta*c for trans = 'T'or't',
* where c is an n-by-n symmetric matrix;
* a and b are n-by-k matrices, if trans = 'N'or'n',
* a and b are k-by-n matrices, if trans = 'T'or't'.
* @param Order
* @param Uplo
* @param Trans
* @param alpha
* @param A
* @param B
* @param beta
* @param C
*/
@Override
public void syr2k(char Order, char Uplo, char Trans, double alpha, INDArray A, INDArray B, double beta,
INDArray C) {
if (OpProfiler.getInstance().getConfig().isCheckElapsedTime())
OpProfiler.getInstance().processBlasCall(false, A, B, C);
if (A.rows() > Integer.MAX_VALUE || A.columns() > Integer.MAX_VALUE ||
A.size(0) > Integer.MAX_VALUE || B.size(0) > Integer.MAX_VALUE || C.size(0) > Integer.MAX_VALUE) {
throw new ND4JArraySizeException();
}
if (A.data().dataType() == DataType.DOUBLE) {
DefaultOpExecutioner.validateDataType(DataType.DOUBLE, A, B, C);
dsyr2k(Order, Uplo, Trans, A.rows(), A.columns(), alpha, A, (int) A.size(0), B, (int) B.size(0), beta, C, (int) C.size(0));
} else {
DefaultOpExecutioner.validateDataType(DataType.FLOAT, A, B, C);
ssyr2k(Order, Uplo, Trans, A.rows(), A.columns(), (float) alpha, A, (int) A.size(0), B, (int) B.size(0), (float) beta, C, (int) C.size(0));
}
OpExecutionerUtil.checkForAny(C);
}
/**
* syr2k performs a rank-2k update of an n-by-n symmetric matrix c, that is, one of the following operations:
* c := alpha*a*b' + alpha*b*a' + beta*c for trans = 'N'or'n'
* c := alpha*a'*b + alpha*b'*a + beta*c for trans = 'T'or't',
* where c is an n-by-n symmetric matrix;
* a and b are n-by-k matrices, if trans = 'N'or'n',
* a and b are k-by-n matrices, if trans = 'T'or't'.
* @param Order
* @param Side
* @param Uplo
* @param TransA
* @param Diag
* @param alpha
* @param A
* @param B
* @param C
*/
@Override
public void trmm(char Order, char Side, char Uplo, char TransA, char Diag, double alpha, INDArray A, INDArray B,
INDArray C) {
if (OpProfiler.getInstance().getConfig().isCheckElapsedTime())
OpProfiler.getInstance().processBlasCall(false, A, B, C);
if (A.rows() > Integer.MAX_VALUE || A.columns() > Integer.MAX_VALUE ||
A.size(0) > Integer.MAX_VALUE || B.size(0) > Integer.MAX_VALUE) {
throw new ND4JArraySizeException();
}
if (A.data().dataType() == DataType.DOUBLE) {
DefaultOpExecutioner.validateDataType(DataType.DOUBLE, A, B, C);
dtrmm(Order, Side, Uplo, TransA, Diag, A.rows(), A.columns(), alpha, A, (int) A.size(0), B, (int) B.size(0));
} else {
DefaultOpExecutioner.validateDataType(DataType.FLOAT, A, B, C);
strmm(Order, Side, Uplo, TransA, Diag, A.rows(), A.columns(), (float) alpha, A, (int) A.size(0), B, (int) B.size(0));
}
OpExecutionerUtil.checkForAny(C);
}
/**
* ?trsm solves one of the following matrix equations:
* op(a)*x = alpha*b or x*op(a) = alpha*b,
* where x and b are m-by-n general matrices, and a is triangular;
* op(a) must be an m-by-m matrix, if side = 'L'or'l'
* op(a) must be an n-by-n matrix, if side = 'R'or'r'.
* For the definition of op(a), see Matrix Arguments.
* The routine overwrites x on b.
* @param Order
* @param Side
* @param Uplo
* @param TransA
* @param Diag
* @param alpha
* @param A
* @param B
*/
@Override
public void trsm(char Order, char Side, char Uplo, char TransA, char Diag, double alpha, INDArray A, INDArray B) {
if (OpProfiler.getInstance().getConfig().isCheckElapsedTime())
OpProfiler.getInstance().processBlasCall(false, A, B);
if (A.rows() > Integer.MAX_VALUE || A.columns() > Integer.MAX_VALUE ||
A.size(0) > Integer.MAX_VALUE || B.size(0) > Integer.MAX_VALUE) {
throw new ND4JArraySizeException();
}
if (A.data().dataType() == DataType.DOUBLE) {
DefaultOpExecutioner.validateDataType(DataType.DOUBLE, A, B);
dtrsm(Order, Side, Uplo, TransA, Diag, A.rows(), A.columns(), alpha, A, (int) A.size(0), B, (int) B.size(0));
} else {
DefaultOpExecutioner.validateDataType(DataType.FLOAT, A, B);
strsm(Order, Side, Uplo, TransA, Diag, A.rows(), A.columns(), (float) alpha, A, (int) A.size(0), B, (int) B.size(0));
}
OpExecutionerUtil.checkForAny(B);
}
/*
* ===========================================================================
* Prototypes for level 3 BLAS
* ===========================================================================
*/
/*
* Routines with standard 4 prefixes (S, D, C, Z)
*/
protected abstract void hgemm(char Order, char TransA, char TransB, int M, int N, int K, float alpha, INDArray A,
int lda, INDArray B, int ldb, float beta, INDArray C, int ldc);
protected abstract void sgemm(char Order, char TransA, char TransB, int M, int N, int K, float alpha, INDArray A,
int lda, INDArray B, int ldb, float beta, INDArray C, int ldc);
protected abstract void ssymm(char Order, char Side, char Uplo, int M, int N, float alpha, INDArray A, int lda,
INDArray B, int ldb, float beta, INDArray C, int ldc);
protected abstract void ssyrk(char Order, char Uplo, char Trans, int N, int K, float alpha, INDArray A, int lda,
float beta, INDArray C, int ldc);
protected abstract void ssyr2k(char Order, char Uplo, char Trans, int N, int K, float alpha, INDArray A, int lda,
INDArray B, int ldb, float beta, INDArray C, int ldc);
protected abstract void strmm(char Order, char Side, char Uplo, char TransA, char Diag, int M, int N, float alpha,
INDArray A, int lda, INDArray B, int ldb);
protected abstract void strsm(char Order, char Side, char Uplo, char TransA, char Diag, int M, int N, float alpha,
INDArray A, int lda, INDArray B, int ldb);
protected abstract void dgemm(char Order, char TransA, char TransB, int M, int N, int K, double alpha, INDArray A,
int lda, INDArray B, int ldb, double beta, INDArray C, int ldc);
protected abstract void dsymm(char Order, char Side, char Uplo, int M, int N, double alpha, INDArray A, int lda,
INDArray B, int ldb, double beta, INDArray C, int ldc);
protected abstract void dsyrk(char Order, char Uplo, char Trans, int N, int K, double alpha, INDArray A, int lda,
double beta, INDArray C, int ldc);
protected abstract void dsyr2k(char Order, char Uplo, char Trans, int N, int K, double alpha, INDArray A, int lda,
INDArray B, int ldb, double beta, INDArray C, int ldc);
protected abstract void dtrmm(char Order, char Side, char Uplo, char TransA, char Diag, int M, int N, double alpha,
INDArray A, int lda, INDArray B, int ldb);
protected abstract void dtrsm(char Order, char Side, char Uplo, char TransA, char Diag, int M, int N, double alpha,
INDArray A, int lda, INDArray B, int ldb);
}