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_DENSE_TRMM_H
#define MYRAMATH_DENSE_TRMM_H

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

namespace myra {

// Forward declarations.
template<class Number> class MatrixRange;
template<class Number> class CMatrixRange;
template<class Number> class CLowerMatrixRange;

//    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? e.g. 'T'ranspose it, 'H'ermitian it, or 'N'othing
//    A (input): a square matrix range, only specified triangle is accessed
//    X (input/output): original data X, overwritten with B
//    diag (input): override A to have 'U'nit diagonal, or 'N'ot? Defaults to 'N'
//    alpha (input): multiplier applied to A, defaults to 1
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CMatrixRange<NumberS>& A, const MatrixRange<NumberS>& X, char diag = 'N', NumberS alpha = 1);
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CMatrixRange<NumberD>& A, const MatrixRange<NumberD>& X, char diag = 'N', NumberD alpha = 1);
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CMatrixRange<NumberC>& A, const MatrixRange<NumberC>& X, char diag = 'N', NumberC alpha = 1);
MYRAMATH_EXPORT void trmm_inplace(char side, char uplo, char op, const CMatrixRange<NumberZ>& A, const MatrixRange<NumberZ>& X, char diag = 'N', NumberZ alpha = 1);

//    side (input): multiply from the 'L'eft (multiply B=A*X) or 'R'ight (multiply B=X*A)
//    op (input): any operation to apply to A? e.g. 'T'ranspose it, 'H'ermitian it, or 'N'othing.
//    A (input): the LowerMatrix being multipled by
//    X (input/output): original data X, overwritten with B
//    diag (input): override A to have 'U'nit diagonal, or 'N'ot? Defaults to 'N'
//    alpha (input): multiplier applied to A, defaults to 1
MYRAMATH_EXPORT void trmm_inplace (char side, char op, const CLowerMatrixRange<NumberS>& A, const MatrixRange<NumberS>& X, char diag = 'N', NumberS alpha = 1);
MYRAMATH_EXPORT void trmm_inplace (char side, char op, const CLowerMatrixRange<NumberD>& A, const MatrixRange<NumberD>& X, char diag = 'N', NumberD alpha = 1);
MYRAMATH_EXPORT void trmm_inplace (char side, char op, const CLowerMatrixRange<NumberC>& A, const MatrixRange<NumberC>& X, char diag = 'N', NumberC alpha = 1);
MYRAMATH_EXPORT void trmm_inplace (char side, char op, const CLowerMatrixRange<NumberZ>& A, const MatrixRange<NumberZ>& X, char diag = 'N', NumberZ alpha = 1);

} // namespace

#endif