//
// Copyright (c) 2002--2010
// Toon Knapen, Karl Meerbergen, Kresimir Fresl,
// Thomas Klimpel and Rutger ter Borg
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
//
// THIS FILE IS AUTOMATICALLY GENERATED
// PLEASE DO NOT EDIT!
//

#ifndef BOOST_NUMERIC_BINDINGS_BLAS_LEVEL2_TPMV_HPP
#define BOOST_NUMERIC_BINDINGS_BLAS_LEVEL2_TPMV_HPP

#include <boost/assert.hpp>
#include <Core/Utils/numeric/bindings/begin.hpp>
#include <Core/Utils/numeric/bindings/blas/detail/default_order.hpp>
#include <Core/Utils/numeric/bindings/diag_tag.hpp>
#include <Core/Utils/numeric/bindings/has_linear_array.hpp>
#include <Core/Utils/numeric/bindings/has_triangular_array.hpp>
#include <Core/Utils/numeric/bindings/is_mutable.hpp>
#include <Core/Utils/numeric/bindings/remove_imaginary.hpp>
#include <Core/Utils/numeric/bindings/size.hpp>
#include <Core/Utils/numeric/bindings/stride.hpp>
#include <Core/Utils/numeric/bindings/trans_tag.hpp>
#include <Core/Utils/numeric/bindings/uplo_tag.hpp>
#include <Core/Utils/numeric/bindings/value_type.hpp>
#include <boost/static_assert.hpp>
#include <boost/type_traits/is_same.hpp>
#include <boost/type_traits/remove_const.hpp>

//
// The BLAS-backend is selected by defining a pre-processor variable,
//  which can be one of
// * for CBLAS, define BOOST_NUMERIC_BINDINGS_BLAS_CBLAS
// * for CUBLAS, define BOOST_NUMERIC_BINDINGS_BLAS_CUBLAS
// * netlib-compatible BLAS is the default
//
#if defined BOOST_NUMERIC_BINDINGS_BLAS_CBLAS
#include <Core/Utils/numeric/bindings/blas/detail/cblas.h>
#include <Core/Utils/numeric/bindings/blas/detail/cblas_option.hpp>
#elif defined BOOST_NUMERIC_BINDINGS_BLAS_CUBLAS
#include <Core/Utils/numeric/bindings/blas/detail/cublas.h>
#include <Core/Utils/numeric/bindings/blas/detail/blas_option.hpp>
#else
#include <Core/Utils/numeric/bindings/blas/detail/blas.h>
#include <Core/Utils/numeric/bindings/blas/detail/blas_option.hpp>
#endif

namespace boost
{
    namespace numeric
    {
        namespace bindings
        {
            namespace blas
            {
                //
                // The detail namespace contains value-type-overloaded functions that
                // dispatch to the appropriate back-end BLAS-routine.
                //
                namespace detail
                {
#if defined BOOST_NUMERIC_BINDINGS_BLAS_CBLAS
                    //
                    // Overloaded function for dispatching to
                    // * CBLAS backend, and
                    // * float value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const float* ap, float* x, const int incx ) {
    cblas_stpmv( cblas_option< Order >::value, cblas_option< UpLo >::value,
            cblas_option< Trans >::value, cblas_option< Diag >::value, n, ap,
            x, incx );
}

//
                    // Overloaded function for dispatching to
                    // * CBLAS backend, and
                    // * double value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const double* ap, double* x, const int incx ) {
    cblas_dtpmv( cblas_option< Order >::value, cblas_option< UpLo >::value,
            cblas_option< Trans >::value, cblas_option< Diag >::value, n, ap,
            x, incx );
}

//
                    // Overloaded function for dispatching to
                    // * CBLAS backend, and
                    // * complex<float> value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const std::complex<float>* ap, std::complex<float>* x,
        const int incx ) {
    cblas_ctpmv( cblas_option< Order >::value, cblas_option< UpLo >::value,
            cblas_option< Trans >::value, cblas_option< Diag >::value, n, ap,
            x, incx );
}

//
                    // Overloaded function for dispatching to
                    // * CBLAS backend, and
                    // * complex<double> value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const std::complex<double>* ap, std::complex<double>* x,
        const int incx ) {
    cblas_ztpmv( cblas_option< Order >::value, cblas_option< UpLo >::value,
            cblas_option< Trans >::value, cblas_option< Diag >::value, n, ap,
            x, incx );
}

#elif defined BOOST_NUMERIC_BINDINGS_BLAS_CUBLAS
                    //
                    // Overloaded function for dispatching to
                    // * CUBLAS backend, and
                    // * float value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const float* ap, float* x, const int incx ) {
    BOOST_STATIC_ASSERT( (is_same<Order, tag::column_major>::value) );
    cublasStpmv( blas_option< UpLo >::value, blas_option< Trans >::value,
            blas_option< Diag >::value, n, ap, x, incx );
}

//
                    // Overloaded function for dispatching to
                    // * CUBLAS backend, and
                    // * double value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const double* ap, double* x, const int incx ) {
    BOOST_STATIC_ASSERT( (is_same<Order, tag::column_major>::value) );
    cublasDtpmv( blas_option< UpLo >::value, blas_option< Trans >::value,
            blas_option< Diag >::value, n, ap, x, incx );
}

//
                    // Overloaded function for dispatching to
                    // * CUBLAS backend, and
                    // * complex<float> value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const std::complex<float>* ap, std::complex<float>* x,
        const int incx ) {
    BOOST_STATIC_ASSERT( (is_same<Order, tag::column_major>::value) );
    cublasCtpmv( blas_option< UpLo >::value, blas_option< Trans >::value,
            blas_option< Diag >::value, n, ap, x, incx );
}

//
                    // Overloaded function for dispatching to
                    // * CUBLAS backend, and
                    // * complex<double> value-type.
//
template< typename Order, typename UpLo, typename Trans, typename Diag >
inline void tpmv( const Order, const UpLo, const Trans, const Diag,
        const int n, const std::complex<double>* ap, std::complex<double>* x,
        const int incx ) {
    BOOST_STATIC_ASSERT( (is_same<Order, tag::column_major>::value) );
    cublasZtpmv( blas_option< UpLo >::value, blas_option< Trans >::value,
            blas_option< Diag >::value, n, ap, x, incx );
}

#else
                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible BLAS backend (the default), and
                    // * float value-type.
                    //
                    template <typename Order, typename UpLo, typename Trans, typename Diag>
                    inline void tpmv(const Order, const UpLo, const Trans, const Diag,
                                     const fortran_int_t n, const float* ap, float* x,
                                     const fortran_int_t incx)
                    {
                        BOOST_STATIC_ASSERT((is_same<Order, tag::column_major>::value));
                        BLAS_STPMV(&blas_option<UpLo>::value, &blas_option<Trans>::value,
                                   &blas_option<Diag>::value, &n, ap, x, &incx);
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible BLAS backend (the default), and
                    // * double value-type.
                    //
                    template <typename Order, typename UpLo, typename Trans, typename Diag>
                    inline void tpmv(const Order, const UpLo, const Trans, const Diag,
                                     const fortran_int_t n, const double* ap, double* x,
                                     const fortran_int_t incx)
                    {
                        BOOST_STATIC_ASSERT((is_same<Order, tag::column_major>::value));
                        BLAS_DTPMV(&blas_option<UpLo>::value, &blas_option<Trans>::value,
                                   &blas_option<Diag>::value, &n, ap, x, &incx);
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible BLAS backend (the default), and
                    // * complex<float> value-type.
                    //
                    template <typename Order, typename UpLo, typename Trans, typename Diag>
                    inline void tpmv(const Order, const UpLo, const Trans, const Diag,
                                     const fortran_int_t n, const std::complex<float>* ap,
                                     std::complex<float>* x, const fortran_int_t incx)
                    {
                        BOOST_STATIC_ASSERT((is_same<Order, tag::column_major>::value));
                        BLAS_CTPMV(&blas_option<UpLo>::value, &blas_option<Trans>::value,
                                   &blas_option<Diag>::value, &n, ap, x, &incx);
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible BLAS backend (the default), and
                    // * complex<double> value-type.
                    //
                    template <typename Order, typename UpLo, typename Trans, typename Diag>
                    inline void tpmv(const Order, const UpLo, const Trans, const Diag,
                                     const fortran_int_t n, const std::complex<double>* ap,
                                     std::complex<double>* x, const fortran_int_t incx)
                    {
                        BOOST_STATIC_ASSERT((is_same<Order, tag::column_major>::value));
                        BLAS_ZTPMV(&blas_option<UpLo>::value, &blas_option<Trans>::value,
                                   &blas_option<Diag>::value, &n, ap, x, &incx);
                    }

#endif
                } // namespace detail

                //
                // Value-type based template class. Use this class if you need a type
                // for dispatching to tpmv.
                //
                template <typename Value>
                struct tpmv_impl
                {
                    typedef Value value_type;
                    typedef typename remove_imaginary<Value>::type real_type;
                    typedef void result_type;

                    //
                    // Static member function that
                    // * Deduces the required arguments for dispatching to BLAS, and
                    // * Asserts that most arguments make sense.
                    //
                    template <typename MatrixAP, typename VectorX>
                    static result_type invoke(const MatrixAP& ap, VectorX& x)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename detail::default_order<MatrixAP>::type order;
                        typedef typename result_of::trans_tag<MatrixAP, order>::type trans;
                        typedef typename result_of::uplo_tag<MatrixAP, trans>::type uplo;
                        typedef typename result_of::diag_tag<MatrixAP>::type diag;
                        BOOST_STATIC_ASSERT((is_same<typename remove_const<
                                                         typename bindings::value_type<MatrixAP>::type>::type,
                                                     typename remove_const<typename bindings::value_type<
                                                         VectorX>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::has_triangular_array<
                            MatrixAP>::value));
                        BOOST_STATIC_ASSERT((bindings::has_linear_array<VectorX>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorX>::value));
                        detail::tpmv(order(), uplo(), trans(), diag(),
                                     bindings::size_column_op(ap, trans()),
                                     bindings::begin_value(ap), bindings::begin_value(x),
                                     bindings::stride(x));
                    }
                };

                //
                // Functions for direct use. These functions are overloaded for temporaries,
                // so that wrapped types can still be passed and used for write-access. Calls
                // to these functions are passed to the tpmv_impl classes. In the
                // documentation, the const-overloads are collapsed to avoid a large number of
                // prototypes which are very similar.
                //

                //
                // Overloaded function for tpmv. Its overload differs for
                //
                template <typename MatrixAP, typename VectorX>
                inline typename tpmv_impl<typename bindings::value_type<
                    MatrixAP>::type>::result_type
                tpmv(const MatrixAP& ap, VectorX& x)
                {
                    tpmv_impl<typename bindings::value_type<
                        MatrixAP>::type>::invoke(ap, x);
                }
            } // namespace blas
        } // namespace bindings
    } // namespace numeric
} // namespace boost

#endif
