trmm.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_SPARSE_TRMM_H
#define MYRAMATH_SPARSE_TRMM_H

#include <myramath/MYRAMATH_EXPORT.h>
#include <myramath/utility/Number.h>

namespace myra {

// Forward declaration.
template<class Number> class CSparseMatrixRange;
template<class Number> class MatrixRange;

//    side (input): multiply from the 'L'eft (multiply B=A*X) or 'R'ight (multiply B=X*A)
//    uplo (input): does A's data exist in its 'U'pper or 'L'ower triangle?
//    op (input): any operation to apply to A? Can 'T'ranspose it, 'H'ermitian it, 'C'onjugate it, or 'N'othing
//    A (input): a square matrix range, only specified triangle is accessed
//    X (input/output): original data X, overwritten with B
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CSparseMatrixRange<NumberS>& A, const MatrixRange<NumberS>& X);
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CSparseMatrixRange<NumberD>& A, const MatrixRange<NumberD>& X);
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CSparseMatrixRange<NumberC>& A, const MatrixRange<NumberC>& X);
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CSparseMatrixRange<NumberZ>& A, const MatrixRange<NumberZ>& X);

} // namespace

#endif