//
// 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_LAPACK_DRIVER_HPSVX_HPP
#define BOOST_NUMERIC_BINDINGS_LAPACK_DRIVER_HPSVX_HPP

#include <boost/assert.hpp>
#include <Core/Utils/numeric/bindings/begin.hpp>
#include <Core/Utils/numeric/bindings/detail/array.hpp>
#include <Core/Utils/numeric/bindings/is_column_major.hpp>
#include <Core/Utils/numeric/bindings/is_complex.hpp>
#include <Core/Utils/numeric/bindings/is_mutable.hpp>
#include <Core/Utils/numeric/bindings/is_real.hpp>
#include <Core/Utils/numeric/bindings/lapack/workspace.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/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>
#include <boost/utility/enable_if.hpp>

//
// The LAPACK-backend for hpsvx is the netlib-compatible backend.
//
#include <Core/Utils/numeric/bindings/lapack/detail/lapack.h>
#include <Core/Utils/numeric/bindings/lapack/detail/lapack_option.hpp>

namespace boost
{
    namespace numeric
    {
        namespace bindings
        {
            namespace lapack
            {
                //
                // The detail namespace contains value-type-overloaded functions that
                // dispatch to the appropriate back-end LAPACK-routine.
                //
                namespace detail
                {
                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * float value-type.
                    //
                    template <typename UpLo>
                    inline std::ptrdiff_t hpsvx(const char fact, const UpLo,
                                                const fortran_int_t n, const fortran_int_t nrhs, const float* ap,
                                                float* afp, fortran_int_t* ipiv, const float* b,
                                                const fortran_int_t ldb, float* x, const fortran_int_t ldx,
                                                float& rcond, float* ferr, float* berr, float* work,
                                                fortran_int_t* iwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_SSPSVX(&fact, &lapack_option<UpLo>::value, &n, &nrhs, ap, afp,
                                      ipiv, b, &ldb, x, &ldx, &rcond, ferr, berr, work, iwork, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * double value-type.
                    //
                    template <typename UpLo>
                    inline std::ptrdiff_t hpsvx(const char fact, const UpLo,
                                                const fortran_int_t n, const fortran_int_t nrhs, const double* ap,
                                                double* afp, fortran_int_t* ipiv, const double* b,
                                                const fortran_int_t ldb, double* x, const fortran_int_t ldx,
                                                double& rcond, double* ferr, double* berr, double* work,
                                                fortran_int_t* iwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_DSPSVX(&fact, &lapack_option<UpLo>::value, &n, &nrhs, ap, afp,
                                      ipiv, b, &ldb, x, &ldx, &rcond, ferr, berr, work, iwork, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * complex<float> value-type.
                    //
                    template <typename UpLo>
                    inline std::ptrdiff_t hpsvx(const char fact, const UpLo,
                                                const fortran_int_t n, const fortran_int_t nrhs,
                                                const std::complex<float>* ap, std::complex<float>* afp,
                                                fortran_int_t* ipiv, const std::complex<float>* b,
                                                const fortran_int_t ldb, std::complex<float>* x,
                                                const fortran_int_t ldx, float& rcond, float* ferr, float* berr,
                                                std::complex<float>* work, float* rwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_CHPSVX(&fact, &lapack_option<UpLo>::value, &n, &nrhs, ap, afp,
                                      ipiv, b, &ldb, x, &ldx, &rcond, ferr, berr, work, rwork, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * complex<double> value-type.
                    //
                    template <typename UpLo>
                    inline std::ptrdiff_t hpsvx(const char fact, const UpLo,
                                                const fortran_int_t n, const fortran_int_t nrhs,
                                                const std::complex<double>* ap, std::complex<double>* afp,
                                                fortran_int_t* ipiv, const std::complex<double>* b,
                                                const fortran_int_t ldb, std::complex<double>* x,
                                                const fortran_int_t ldx, double& rcond, double* ferr, double* berr,
                                                std::complex<double>* work, double* rwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_ZHPSVX(&fact, &lapack_option<UpLo>::value, &n, &nrhs, ap, afp,
                                      ipiv, b, &ldb, x, &ldx, &rcond, ferr, berr, work, rwork, &info);
                        return info;
                    }
                } // namespace detail

                //
                // Value-type based template class. Use this class if you need a type
                // for dispatching to hpsvx.
                //
                template <typename Value, typename Enable = void>
                struct hpsvx_impl
                {
                };

                //
                // This implementation is enabled if Value is a real type.
                //
                template <typename Value>
                struct hpsvx_impl<Value, typename boost::enable_if<is_real<Value>>::type>
                {
                    typedef Value value_type;
                    typedef typename remove_imaginary<Value>::type real_type;

                    //
                    // Static member function for user-defined workspaces, that
                    // * Deduces the required arguments for dispatching to LAPACK, and
                    // * Asserts that most arguments make sense.
                    //
                    template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                              typename MatrixB, typename MatrixX, typename VectorFERR,
                              typename VectorBERR, typename WORK, typename IWORK>
                    static std::ptrdiff_t invoke(const char fact, const MatrixAP& ap,
                                                 MatrixAFP& afp, VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                                                 real_type& rcond, VectorFERR& ferr, VectorBERR& berr,
                                                 detail::workspace2<WORK, IWORK> work)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixAP>::type uplo;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixB>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixX>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixAFP>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixB>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixX>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                VectorFERR>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                VectorBERR>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixAFP>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorIPIV>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixX>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorFERR>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorBERR>::value));
                        BOOST_ASSERT(bindings::size(berr) >= bindings::size_column(b));
                        BOOST_ASSERT(bindings::size(work.select(fortran_int_t())) >=
                            min_size_iwork(bindings::size_column(ap)));
                        BOOST_ASSERT(bindings::size(work.select(real_type())) >=
                            min_size_work(bindings::size_column(ap)));
                        BOOST_ASSERT(bindings::size_column(ap) >= 0);
                        BOOST_ASSERT(bindings::size_column(b) >= 0);
                        BOOST_ASSERT(bindings::size_minor(b) == 1 ||
                            bindings::stride_minor(b) == 1);
                        BOOST_ASSERT(bindings::size_minor(x) == 1 ||
                            bindings::stride_minor(x) == 1);
                        BOOST_ASSERT(bindings::stride_major(b) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_column(ap)));
                        BOOST_ASSERT(bindings::stride_major(x) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_column(ap)));
                        BOOST_ASSERT(fact == 'F' || fact == 'N');
                        return detail::hpsvx(fact, uplo(), bindings::size_column(ap),
                                             bindings::size_column(b), bindings::begin_value(ap),
                                             bindings::begin_value(afp), bindings::begin_value(ipiv),
                                             bindings::begin_value(b), bindings::stride_major(b),
                                             bindings::begin_value(x), bindings::stride_major(x), rcond,
                                             bindings::begin_value(ferr), bindings::begin_value(berr),
                                             bindings::begin_value(work.select(real_type())),
                                             bindings::begin_value(work.select(fortran_int_t())));
                    }

                    //
                    // Static member function that
                    // * Figures out the minimal workspace requirements, and passes
                    //   the results to the user-defined workspace overload of the
                    //   invoke static member function
                    // * Enables the unblocked algorithm (BLAS level 2)
                    //
                    template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                              typename MatrixB, typename MatrixX, typename VectorFERR,
                              typename VectorBERR>
                    static std::ptrdiff_t invoke(const char fact, const MatrixAP& ap,
                                                 MatrixAFP& afp, VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                                                 real_type& rcond, VectorFERR& ferr, VectorBERR& berr,
                                                 minimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixAP>::type uplo;
                        bindings::detail::array<real_type> tmp_work(min_size_work(
                            bindings::size_column(ap)));
                        bindings::detail::array<fortran_int_t> tmp_iwork(
                            min_size_iwork(bindings::size_column(ap)));
                        return invoke(fact, ap, afp, ipiv, b, x, rcond, ferr, berr,
                                      workspace(tmp_work, tmp_iwork));
                    }

                    //
                    // Static member function that
                    // * Figures out the optimal workspace requirements, and passes
                    //   the results to the user-defined workspace overload of the
                    //   invoke static member
                    // * Enables the blocked algorithm (BLAS level 3)
                    //
                    template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                              typename MatrixB, typename MatrixX, typename VectorFERR,
                              typename VectorBERR>
                    static std::ptrdiff_t invoke(const char fact, const MatrixAP& ap,
                                                 MatrixAFP& afp, VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                                                 real_type& rcond, VectorFERR& ferr, VectorBERR& berr,
                                                 optimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixAP>::type uplo;
                        return invoke(fact, ap, afp, ipiv, b, x, rcond, ferr, berr,
                                      minimal_workspace());
                    }

                    //
                    // Static member function that returns the minimum size of
                    // workspace-array work.
                    //
                    static std::ptrdiff_t min_size_work(const std::ptrdiff_t n)
                    {
                        return 3 * n;
                    }

                    //
                    // Static member function that returns the minimum size of
                    // workspace-array iwork.
                    //
                    static std::ptrdiff_t min_size_iwork(const std::ptrdiff_t n)
                    {
                        return n;
                    }
                };

                //
                // This implementation is enabled if Value is a complex type.
                //
                template <typename Value>
                struct hpsvx_impl<Value, typename boost::enable_if<is_complex<Value>>::type>
                {
                    typedef Value value_type;
                    typedef typename remove_imaginary<Value>::type real_type;

                    //
                    // Static member function for user-defined workspaces, that
                    // * Deduces the required arguments for dispatching to LAPACK, and
                    // * Asserts that most arguments make sense.
                    //
                    template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                              typename MatrixB, typename MatrixX, typename VectorFERR,
                              typename VectorBERR, typename WORK, typename RWORK>
                    static std::ptrdiff_t invoke(const char fact, const MatrixAP& ap,
                                                 MatrixAFP& afp, VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                                                 real_type& rcond, VectorFERR& ferr, VectorBERR& berr,
                                                 detail::workspace2<WORK, RWORK> work)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixAP>::type uplo;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixB>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixX>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<VectorFERR>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                VectorBERR>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixAFP>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixB>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixAP>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixX>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixAFP>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorIPIV>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixX>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorFERR>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorBERR>::value));
                        BOOST_ASSERT(bindings::size(berr) >= bindings::size_column(b));
                        BOOST_ASSERT(bindings::size(work.select(real_type())) >=
                            min_size_rwork(bindings::size_column(ap)));
                        BOOST_ASSERT(bindings::size(work.select(value_type())) >=
                            min_size_work(bindings::size_column(ap)));
                        BOOST_ASSERT(bindings::size_column(ap) >= 0);
                        BOOST_ASSERT(bindings::size_column(b) >= 0);
                        BOOST_ASSERT(bindings::size_minor(b) == 1 ||
                            bindings::stride_minor(b) == 1);
                        BOOST_ASSERT(bindings::size_minor(x) == 1 ||
                            bindings::stride_minor(x) == 1);
                        BOOST_ASSERT(bindings::stride_major(b) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_column(ap)));
                        BOOST_ASSERT(bindings::stride_major(x) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_column(ap)));
                        BOOST_ASSERT(fact == 'F' || fact == 'N');
                        return detail::hpsvx(fact, uplo(), bindings::size_column(ap),
                                             bindings::size_column(b), bindings::begin_value(ap),
                                             bindings::begin_value(afp), bindings::begin_value(ipiv),
                                             bindings::begin_value(b), bindings::stride_major(b),
                                             bindings::begin_value(x), bindings::stride_major(x), rcond,
                                             bindings::begin_value(ferr), bindings::begin_value(berr),
                                             bindings::begin_value(work.select(value_type())),
                                             bindings::begin_value(work.select(real_type())));
                    }

                    //
                    // Static member function that
                    // * Figures out the minimal workspace requirements, and passes
                    //   the results to the user-defined workspace overload of the
                    //   invoke static member function
                    // * Enables the unblocked algorithm (BLAS level 2)
                    //
                    template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                              typename MatrixB, typename MatrixX, typename VectorFERR,
                              typename VectorBERR>
                    static std::ptrdiff_t invoke(const char fact, const MatrixAP& ap,
                                                 MatrixAFP& afp, VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                                                 real_type& rcond, VectorFERR& ferr, VectorBERR& berr,
                                                 minimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixAP>::type uplo;
                        bindings::detail::array<value_type> tmp_work(min_size_work(
                            bindings::size_column(ap)));
                        bindings::detail::array<real_type> tmp_rwork(min_size_rwork(
                            bindings::size_column(ap)));
                        return invoke(fact, ap, afp, ipiv, b, x, rcond, ferr, berr,
                                      workspace(tmp_work, tmp_rwork));
                    }

                    //
                    // Static member function that
                    // * Figures out the optimal workspace requirements, and passes
                    //   the results to the user-defined workspace overload of the
                    //   invoke static member
                    // * Enables the blocked algorithm (BLAS level 3)
                    //
                    template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                              typename MatrixB, typename MatrixX, typename VectorFERR,
                              typename VectorBERR>
                    static std::ptrdiff_t invoke(const char fact, const MatrixAP& ap,
                                                 MatrixAFP& afp, VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                                                 real_type& rcond, VectorFERR& ferr, VectorBERR& berr,
                                                 optimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixAP>::type uplo;
                        return invoke(fact, ap, afp, ipiv, b, x, rcond, ferr, berr,
                                      minimal_workspace());
                    }

                    //
                    // Static member function that returns the minimum size of
                    // workspace-array work.
                    //
                    static std::ptrdiff_t min_size_work(const std::ptrdiff_t n)
                    {
                        return 2 * n;
                    }

                    //
                    // Static member function that returns the minimum size of
                    // workspace-array rwork.
                    //
                    static std::ptrdiff_t min_size_rwork(const std::ptrdiff_t n)
                    {
                        return n;
                    }
                };


                //
                // Functions for direct use. These functions are overloaded for temporaries,
                // so that wrapped types can still be passed and used for write-access. In
                // addition, if applicable, they are overloaded for user-defined workspaces.
                // Calls to these functions are passed to the hpsvx_impl classes. In the
                // documentation, most overloads are collapsed to avoid a large number of
                // prototypes which are very similar.
                //

                //
                // Overloaded function for hpsvx. Its overload differs for
                // * User-defined workspace
                //
                template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                          typename MatrixB, typename MatrixX, typename VectorFERR,
                          typename VectorBERR, typename Workspace>
                inline typename boost::enable_if<detail::is_workspace<Workspace>,
                                                 std::ptrdiff_t>::type
                hpsvx(const char fact, const MatrixAP& ap, MatrixAFP& afp,
                      VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                      typename remove_imaginary<typename bindings::value_type<
                          MatrixAP>::type>::type& rcond, VectorFERR& ferr, VectorBERR& berr,
                      Workspace work)
                {
                    return hpsvx_impl<typename bindings::value_type<
                        MatrixAP>::type>::invoke(fact, ap, afp, ipiv, b, x, rcond,
                                                 ferr, berr, work);
                }

                //
                // Overloaded function for hpsvx. Its overload differs for
                // * Default workspace-type (optimal)
                //
                template <typename MatrixAP, typename MatrixAFP, typename VectorIPIV,
                          typename MatrixB, typename MatrixX, typename VectorFERR,
                          typename VectorBERR>
                inline typename boost::disable_if<detail::is_workspace<VectorBERR>,
                                                  std::ptrdiff_t>::type
                hpsvx(const char fact, const MatrixAP& ap, MatrixAFP& afp,
                      VectorIPIV& ipiv, const MatrixB& b, MatrixX& x,
                      typename remove_imaginary<typename bindings::value_type<
                          MatrixAP>::type>::type& rcond, VectorFERR& ferr, VectorBERR& berr)
                {
                    return hpsvx_impl<typename bindings::value_type<
                        MatrixAP>::type>::invoke(fact, ap, afp, ipiv, b, x, rcond,
                                                 ferr, berr, optimal_workspace());
                }
            } // namespace lapack
        } // namespace bindings
    } // namespace numeric
} // namespace boost

#endif
