lapack/clapack/trsv.h

//=================================================================================================
/*!
//  \file blaze/math/lapack/clapack/trsv.h
//  \brief Header file for the CLAPACK trsv wrapper functions
//
//  Copyright (C) 2012-2020 Klaus Iglberger - All Rights Reserved
//
//  This file is part of the Blaze library. You can redistribute it and/or modify it under
//  the terms of the New (Revised) BSD License. Redistribution and use in source and binary
//  forms, with or without modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of
//     conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright notice, this list
//     of conditions and the following disclaimer in the documentation and/or other materials
//     provided with the distribution.
//  3. Neither the names of the Blaze development group nor the names of its contributors
//     may be used to endorse or promote products derived from this software without specific
//     prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
//  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
//  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
//  SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
//  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
//  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
//  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
//  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
//  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
*/
//=================================================================================================

#ifndef _BLAZE_MATH_LAPACK_CLAPACK_TRSV_H_
#define _BLAZE_MATH_LAPACK_CLAPACK_TRSV_H_


//*************************************************************************************************
// Includes
//*************************************************************************************************

#include <blaze/math/blas/Types.h>
#include <blaze/util/Complex.h>
#include <blaze/util/StaticAssert.h>
#include <blaze/util/Types.h>


//=================================================================================================
//
//  LAPACK FORWARD DECLARATIONS
//
//=================================================================================================

//*************************************************************************************************
/*! \cond BLAZE_INTERNAL */
#if !defined(BLAS_H)
extern "C" {

void strsv_( char* uplo, char* trans, char* diag, blaze::blas_int_t* n, float* A,
             blaze::blas_int_t* lda, float* x, blaze::blas_int_t* incX,
             blaze::fortran_charlen_t nuplo, blaze::fortran_charlen_t ntrans,
             blaze::fortran_charlen_t ndiag );
void dtrsv_( char* uplo, char* trans, char* diag, blaze::blas_int_t* n, double* A,
             blaze::blas_int_t* lda, double* x, blaze::blas_int_t* incX,
             blaze::fortran_charlen_t nuplo, blaze::fortran_charlen_t ntrans,
             blaze::fortran_charlen_t ndiag );
void ctrsv_( char* uplo, char* trans, char* diag, blaze::blas_int_t* n, float* A,
             blaze::blas_int_t* lda, float* x, blaze::blas_int_t* incX,
             blaze::fortran_charlen_t nuplo, blaze::fortran_charlen_t ntrans,
             blaze::fortran_charlen_t ndiag );
void ztrsv_( char* uplo, char* trans, char* diag, blaze::blas_int_t* n, double* A,
             blaze::blas_int_t* lda, double* x, blaze::blas_int_t* incX,
             blaze::fortran_charlen_t nuplo, blaze::fortran_charlen_t ntrans,
             blaze::fortran_charlen_t ndiag );

}
#endif
/*! \endcond */
//*************************************************************************************************


namespace blaze {

//=================================================================================================
//
//  LAPACK TRIANGULAR LINEAR SYSTEM FUNCTIONS (TRSV)
//
//=================================================================================================

//*************************************************************************************************
/*!\name LAPACK triangular linear system functions (trsv) */
//@{
void trsv( char uplo, char trans, char diag, blas_int_t n, const float* A,
           blas_int_t lda, float* x, blas_int_t incX );

void trsv( char uplo, char trans, char diag, blas_int_t n, const double* A,
           blas_int_t lda, double* x, blas_int_t incX );

void trsv( char uplo, char trans, char diag, blas_int_t n, const complex<float>* A,
           blas_int_t lda, complex<float>* x, blas_int_t incX );

void trsv( char uplo, char trans, char diag, blas_int_t n, const complex<double>* A,
           blas_int_t lda, complex<double>* x, blas_int_t incX );
//@}
//*************************************************************************************************


//*************************************************************************************************
/*!\brief LAPACK kernel for solving a triangular single precision linear system of equations
//        (\f$ A*X=B \f$).
// \ingroup lapack_solver
//
// \param uplo \c 'L' in case of a lower matrix, \c 'U' in case of an upper matrix.
// \param trans \c 'N' for \f$ A*X=B \f$, \c 'T' for \f$ A^T*X=B \f$, and \c C for \f$ A^H*X=B \f$.
// \param diag \c 'U' in case of a unitriangular matrix, \c 'N' otherwise.
// \param n The number of rows/columns of the column-major triangular matrix \f$[0..\infty)\f$.
// \param A Pointer to the first element of the single precision column-major square matrix.
// \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
// \param x Pointer to the first element of vector \a x.
// \param incX The stride within vector \a x.
// \return void
//
// This function uses the LAPACK strsv() function to compute the solution to the triangular system
// of linear equations \f$ A*x=b \f$, where \a A is a \a n-by-\a n triangular matrix and \a x and
// \a b are n-dimensional vectors. The \a trans argument specifies the form of the linear system
// of equations:
//
//   - 'N': \f$ A*x=b \f$ (no transpose)
//   - 'T': \f$ A^{T}*x=b \f$ (transpose)
//   - 'C': \f$ A^{H}*x=b \f$ (conjugate transpose)
//
// For more information on the strsv() function, see the LAPACK online documentation browser:
//
//        http://www.netlib.org/lapack/explore-html/
//
// \note This function can only be used if a fitting LAPACK library, which supports this function,
// is available and linked to the executable. Otherwise a call to this function will result in a
// linker error.
//
// \note The function does not perform any test for singularity or near-singularity. Such tests
// must be performed prior to calling this function!
*/
inline void trsv( char uplo, char trans, char diag, blas_int_t n, const float* A,
                  blas_int_t lda, float* x, blas_int_t incX )
{
   strsv_( &uplo, &trans, &diag, &n, const_cast<float*>( A ), &lda, x, &incX
#if !defined(BLAS_H)
         , blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1)
#endif
         );
}
//*************************************************************************************************


//*************************************************************************************************
/*!\brief LAPACK kernel for solving a triangular double precision linear system of equations
//        (\f$ A*x=b \f$).
// \ingroup lapack_solver
//
// \param uplo \c 'L' in case of a lower matrix, \c 'U' in case of an upper matrix.
// \param trans \c 'N' for \f$ A*X=B \f$, \c 'T' for \f$ A^T*X=B \f$, and \c C for \f$ A^H*X=B \f$.
// \param diag \c 'U' in case of a unitriangular matrix, \c 'N' otherwise.
// \param n The number of rows/columns of the column-major triangular matrix \f$[0..\infty)\f$.
// \param A Pointer to the first element of the double precision column-major square matrix.
// \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
// \param x Pointer to the first element of vector \a x.
// \param incX The stride within vector \a x.
// \return void
//
// This function uses the LAPACK dtrsv() function to compute the solution to the triangular system
// of linear equations \f$ A*x=b \f$, where \a A is a \a n-by-\a n triangular matrix and \a x and
// \a b are n-dimensional vectors. The \a trans argument specifies the form of the linear system
// of equations:
//
//   - 'N': \f$ A*x=b \f$ (no transpose)
//   - 'T': \f$ A^{T}*x=b \f$ (transpose)
//   - 'C': \f$ A^{H}*x=b \f$ (conjugate transpose)
//
// For more information on the dtrsv() function, see the LAPACK online documentation browser:
//
//        http://www.netlib.org/lapack/explore-html/
//
// \note This function can only be used if a fitting LAPACK library, which supports this function,
// is available and linked to the executable. Otherwise a call to this function will result in a
// linker error.
//
// \note The function does not perform any test for singularity or near-singularity. Such tests
// must be performed prior to calling this function!
*/
inline void trsv( char uplo, char trans, char diag, blas_int_t n, const double* A,
                  blas_int_t lda, double* x, blas_int_t incX )
{
   dtrsv_( &uplo, &trans, &diag, &n, const_cast<double*>( A ), &lda, x, &incX
#if !defined(BLAS_H)
         , blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1)
#endif
         );
}
//*************************************************************************************************


//*************************************************************************************************
/*!\brief LAPACK kernel for solving a triangular single precision complex linear system of
//        equations (\f$ A*x=b \f$).
// \ingroup lapack_solver
//
// \param uplo \c 'L' in case of a lower matrix, \c 'U' in case of an upper matrix.
// \param trans \c 'N' for \f$ A*X=B \f$, \c 'T' for \f$ A^T*X=B \f$, and \c C for \f$ A^H*X=B \f$.
// \param diag \c 'U' in case of a unitriangular matrix, \c 'N' otherwise.
// \param n The number of rows/columns of the column-major triangular matrix \f$[0..\infty)\f$.
// \param A Pointer to the first element of the single precision complex column-major square matrix.
// \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
// \param x Pointer to the first element of vector \a x.
// \param incX The stride within vector \a x.
// \return void
//
// This function uses the LAPACK ctrsv() function to compute the solution to the triangular system
// of linear equations \f$ A*x=b \f$, where \a A is a \a n-by-\a n triangular matrix and \a x and
// \a b are n-dimensional vectors. The \a trans argument specifies the form of the linear system
// of equations:
//
//   - 'N': \f$ A*x=b \f$ (no transpose)
//   - 'T': \f$ A^{T}*x=b \f$ (transpose)
//   - 'C': \f$ A^{H}*x=b \f$ (conjugate transpose)
//
// For more information on the ctrsv() function, see the LAPACK online documentation browser:
//
//        http://www.netlib.org/lapack/explore-html/
//
// \note This function can only be used if a fitting LAPACK library, which supports this function,
// is available and linked to the executable. Otherwise a call to this function will result in a
// linker error.
//
// \note The function does not perform any test for singularity or near-singularity. Such tests
// must be performed prior to calling this function!
*/
inline void trsv( char uplo, char trans, char diag, blas_int_t n, const complex<float>* A,
                  blas_int_t lda, complex<float>* x, blas_int_t incX )
{
   BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );

   ctrsv_( &uplo, &trans, &diag, &n, const_cast<float*>( reinterpret_cast<const float*>( A ) ),
           &lda, reinterpret_cast<float*>( x ), &incX
#if !defined(BLAS_H)
         , blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1)
#endif
         );
}
//*************************************************************************************************


//*************************************************************************************************
/*!\brief LAPACK kernel for solving a triangular double precision complex linear system of
//        equations (\f$ A*x=b \f$).
// \ingroup lapack_solver
//
// \param uplo \c 'L' in case of a lower matrix, \c 'U' in case of an upper matrix.
// \param trans \c 'N' for \f$ A*X=B \f$, \c 'T' for \f$ A^T*X=B \f$, and \c C for \f$ A^H*X=B \f$.
// \param diag \c 'U' in case of a unitriangular matrix, \c 'N' otherwise.
// \param n The number of rows/columns of the column-major triangular matrix \f$[0..\infty)\f$.
// \param A Pointer to the first element of the double precision complex column-major square matrix.
// \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
// \param x Pointer to the first element of vector \a x.
// \param incX The stride within vector \a x.
// \return void
//
// This function uses the LAPACK ztrsv() function to compute the solution to the triangular system
// of linear equations \f$ A*x=b \f$, where \a A is a \a n-by-\a n triangular matrix and \a x and
// \a b are n-dimensional vectors. The \a trans argument specifies the form of the linear system
// of equations:
//
//   - 'N': \f$ A*x=b \f$ (no transpose)
//   - 'T': \f$ A^{T}*x=b \f$ (transpose)
//   - 'C': \f$ A^{H}*x=b \f$ (conjugate transpose)
//
// For more information on the ztrsv() function, see the LAPACK online documentation browser:
//
//        http://www.netlib.org/lapack/explore-html/
//
// \note This function can only be used if a fitting LAPACK library, which supports this function,
// is available and linked to the executable. Otherwise a call to this function will result in a
// linker error.
//
// \note The function does not perform any test for singularity or near-singularity. Such tests
// must be performed prior to calling this function!
*/
inline void trsv( char uplo, char trans, char diag, blas_int_t n, const complex<double>* A,
                  blas_int_t lda, complex<double>* x, blas_int_t incX )
{
   BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );

   ztrsv_( &uplo, &trans, &diag, &n, const_cast<double*>( reinterpret_cast<const double*>( A ) ),
           &lda, reinterpret_cast<double*>( x ), &incX
#if !defined(BLAS_H)
         , blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1), blaze::fortran_charlen_t(1)
#endif
         );
}
//*************************************************************************************************

} // namespace blaze

#endif