//
// 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_HEEVR_HPP
#define BOOST_NUMERIC_BINDINGS_LAPACK_DRIVER_HEEVR_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/traits/detail/utils.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 heevr 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 heevr(const char jobz, const char range, const UpLo,
                                                const fortran_int_t n, float* a, const fortran_int_t lda,
                                                const float vl, const float vu, const fortran_int_t il,
                                                const fortran_int_t iu, const float abstol, fortran_int_t& m,
                                                float* w, float* z, const fortran_int_t ldz, fortran_int_t* isuppz,
                                                float* work, const fortran_int_t lwork, fortran_int_t* iwork,
                                                const fortran_int_t liwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_SSYEVR(&jobz, &range, &lapack_option<UpLo>::value, &n, a, &lda,
                                      &vl, &vu, &il, &iu, &abstol, &m, w, z, &ldz, isuppz, work, &lwork,
                                      iwork, &liwork, &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 heevr(const char jobz, const char range, const UpLo,
                                                const fortran_int_t n, double* a, const fortran_int_t lda,
                                                const double vl, const double vu, const fortran_int_t il,
                                                const fortran_int_t iu, const double abstol, fortran_int_t& m,
                                                double* w, double* z, const fortran_int_t ldz, fortran_int_t* isuppz,
                                                double* work, const fortran_int_t lwork, fortran_int_t* iwork,
                                                const fortran_int_t liwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_DSYEVR(&jobz, &range, &lapack_option<UpLo>::value, &n, a, &lda,
                                      &vl, &vu, &il, &iu, &abstol, &m, w, z, &ldz, isuppz, work, &lwork,
                                      iwork, &liwork, &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 heevr(const char jobz, const char range, const UpLo,
                                                const fortran_int_t n, std::complex<float>* a,
                                                const fortran_int_t lda, const float vl, const float vu,
                                                const fortran_int_t il, const fortran_int_t iu, const float abstol,
                                                fortran_int_t& m, float* w, std::complex<float>* z,
                                                const fortran_int_t ldz, fortran_int_t* isuppz,
                                                std::complex<float>* work, const fortran_int_t lwork, float* rwork,
                                                const fortran_int_t lrwork, fortran_int_t* iwork,
                                                const fortran_int_t liwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_CHEEVR(&jobz, &range, &lapack_option<UpLo>::value, &n, a, &lda,
                                      &vl, &vu, &il, &iu, &abstol, &m, w, z, &ldz, isuppz, work, &lwork,
                                      rwork, &lrwork, iwork, &liwork, &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 heevr(const char jobz, const char range, const UpLo,
                                                const fortran_int_t n, std::complex<double>* a,
                                                const fortran_int_t lda, const double vl, const double vu,
                                                const fortran_int_t il, const fortran_int_t iu, const double abstol,
                                                fortran_int_t& m, double* w, std::complex<double>* z,
                                                const fortran_int_t ldz, fortran_int_t* isuppz,
                                                std::complex<double>* work, const fortran_int_t lwork, double* rwork,
                                                const fortran_int_t lrwork, fortran_int_t* iwork,
                                                const fortran_int_t liwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_ZHEEVR(&jobz, &range, &lapack_option<UpLo>::value, &n, a, &lda,
                                      &vl, &vu, &il, &iu, &abstol, &m, w, z, &ldz, isuppz, work, &lwork,
                                      rwork, &lrwork, iwork, &liwork, &info);
                        return info;
                    }
                } // namespace detail

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

                //
                // This implementation is enabled if Value is a real type.
                //
                template <typename Value>
                struct heevr_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 MatrixA, typename VectorW, typename MatrixZ,
                              typename VectorISUPPZ, typename WORK, typename IWORK>
                    static std::ptrdiff_t invoke(const char jobz, const char range,
                                                 MatrixA& a, const real_type vl, const real_type vu,
                                                 const fortran_int_t il, const fortran_int_t iu,
                                                 const real_type abstol, fortran_int_t& m, VectorW& w,
                                                 MatrixZ& z, VectorISUPPZ& isuppz, detail::workspace2<WORK,
                                                                                                      IWORK> work)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixA>::type uplo;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixZ>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixA>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                VectorW>::type>::type>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixA>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixZ>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorW>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixZ>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorISUPPZ>::value));
                        BOOST_ASSERT(bindings::size(w) >= bindings::size_column(a));
                        BOOST_ASSERT(bindings::size(work.select(fortran_int_t())) >=
                            min_size_iwork(bindings::size_column(a)));
                        BOOST_ASSERT(bindings::size(work.select(real_type())) >=
                            min_size_work(bindings::size_column(a)));
                        BOOST_ASSERT(bindings::size_column(a) >= 0);
                        BOOST_ASSERT(bindings::size_minor(a) == 1 ||
                            bindings::stride_minor(a) == 1);
                        BOOST_ASSERT(bindings::size_minor(z) == 1 ||
                            bindings::stride_minor(z) == 1);
                        BOOST_ASSERT(bindings::stride_major(a) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_column(a)));
                        BOOST_ASSERT(jobz == 'N' || jobz == 'V');
                        BOOST_ASSERT(range == 'A' || range == 'V' || range == 'I');
                        return detail::heevr(jobz, range, uplo(), bindings::size_column(a),
                                             bindings::begin_value(a), bindings::stride_major(a), vl, vu,
                                             il, iu, abstol, m, bindings::begin_value(w),
                                             bindings::begin_value(z), bindings::stride_major(z),
                                             bindings::begin_value(isuppz),
                                             bindings::begin_value(work.select(real_type())),
                                             bindings::size(work.select(real_type())),
                                             bindings::begin_value(work.select(fortran_int_t())),
                                             bindings::size(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 MatrixA, typename VectorW, typename MatrixZ,
                              typename VectorISUPPZ>
                    static std::ptrdiff_t invoke(const char jobz, const char range,
                                                 MatrixA& a, const real_type vl, const real_type vu,
                                                 const fortran_int_t il, const fortran_int_t iu,
                                                 const real_type abstol, fortran_int_t& m, VectorW& w,
                                                 MatrixZ& z, VectorISUPPZ& isuppz, minimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixA>::type uplo;
                        bindings::detail::array<real_type> tmp_work(min_size_work(
                            bindings::size_column(a)));
                        bindings::detail::array<fortran_int_t> tmp_iwork(
                            min_size_iwork(bindings::size_column(a)));
                        return invoke(jobz, range, a, vl, vu, il, iu, abstol, m, w, z,
                                      isuppz, 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 MatrixA, typename VectorW, typename MatrixZ,
                              typename VectorISUPPZ>
                    static std::ptrdiff_t invoke(const char jobz, const char range,
                                                 MatrixA& a, const real_type vl, const real_type vu,
                                                 const fortran_int_t il, const fortran_int_t iu,
                                                 const real_type abstol, fortran_int_t& m, VectorW& w,
                                                 MatrixZ& z, VectorISUPPZ& isuppz, optimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixA>::type uplo;
                        real_type opt_size_work;
                        fortran_int_t opt_size_iwork;
                        detail::heevr(jobz, range, uplo(), bindings::size_column(a),
                                      bindings::begin_value(a), bindings::stride_major(a), vl, vu,
                                      il, iu, abstol, m, bindings::begin_value(w),
                                      bindings::begin_value(z), bindings::stride_major(z),
                                      bindings::begin_value(isuppz), &opt_size_work, -1,
                                      &opt_size_iwork, -1);
                        bindings::detail::array<real_type> tmp_work(
                            traits::detail::to_int(opt_size_work));
                        bindings::detail::array<fortran_int_t> tmp_iwork(
                            opt_size_iwork);
                        return invoke(jobz, range, a, vl, vu, il, iu, abstol, m, w, z,
                                      isuppz, workspace(tmp_work, tmp_iwork));
                    }

                    //
                    // 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 std::max<std::ptrdiff_t>(1, 26 * 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 std::max<std::ptrdiff_t>(1, 10 * n);
                    }
                };

                //
                // This implementation is enabled if Value is a complex type.
                //
                template <typename Value>
                struct heevr_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 MatrixA, typename VectorW, typename MatrixZ,
                              typename VectorISUPPZ, typename WORK, typename RWORK,
                              typename IWORK>
                    static std::ptrdiff_t invoke(const char jobz, const char range,
                                                 MatrixA& a, const real_type vl, const real_type vu,
                                                 const fortran_int_t il, const fortran_int_t iu,
                                                 const real_type abstol, fortran_int_t& m, VectorW& w,
                                                 MatrixZ& z, VectorISUPPZ& isuppz, detail::workspace3<WORK, RWORK,
                                                                                                      IWORK> work)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixA>::type uplo;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixZ>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixA>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixZ>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorW>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixZ>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorISUPPZ>::value));
                        BOOST_ASSERT(bindings::size(w) >= bindings::size_column(a));
                        BOOST_ASSERT(bindings::size(work.select(fortran_int_t())) >=
                            min_size_iwork(bindings::size_column(a)));
                        BOOST_ASSERT(bindings::size(work.select(real_type())) >=
                            min_size_rwork(bindings::size_column(a)));
                        BOOST_ASSERT(bindings::size(work.select(value_type())) >=
                            min_size_work(bindings::size_column(a)));
                        BOOST_ASSERT(bindings::size_column(a) >= 0);
                        BOOST_ASSERT(bindings::size_minor(a) == 1 ||
                            bindings::stride_minor(a) == 1);
                        BOOST_ASSERT(bindings::size_minor(z) == 1 ||
                            bindings::stride_minor(z) == 1);
                        BOOST_ASSERT(bindings::stride_major(a) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_column(a)));
                        BOOST_ASSERT(jobz == 'N' || jobz == 'V');
                        BOOST_ASSERT(range == 'A' || range == 'V' || range == 'I');
                        return detail::heevr(jobz, range, uplo(), bindings::size_column(a),
                                             bindings::begin_value(a), bindings::stride_major(a), vl, vu,
                                             il, iu, abstol, m, bindings::begin_value(w),
                                             bindings::begin_value(z), bindings::stride_major(z),
                                             bindings::begin_value(isuppz),
                                             bindings::begin_value(work.select(value_type())),
                                             bindings::size(work.select(value_type())),
                                             bindings::begin_value(work.select(real_type())),
                                             bindings::size(work.select(real_type())),
                                             bindings::begin_value(work.select(fortran_int_t())),
                                             bindings::size(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 MatrixA, typename VectorW, typename MatrixZ,
                              typename VectorISUPPZ>
                    static std::ptrdiff_t invoke(const char jobz, const char range,
                                                 MatrixA& a, const real_type vl, const real_type vu,
                                                 const fortran_int_t il, const fortran_int_t iu,
                                                 const real_type abstol, fortran_int_t& m, VectorW& w,
                                                 MatrixZ& z, VectorISUPPZ& isuppz, minimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixA>::type uplo;
                        bindings::detail::array<value_type> tmp_work(min_size_work(
                            bindings::size_column(a)));
                        bindings::detail::array<real_type> tmp_rwork(min_size_rwork(
                            bindings::size_column(a)));
                        bindings::detail::array<fortran_int_t> tmp_iwork(
                            min_size_iwork(bindings::size_column(a)));
                        return invoke(jobz, range, a, vl, vu, il, iu, abstol, m, w, z,
                                      isuppz, workspace(tmp_work, tmp_rwork, 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 MatrixA, typename VectorW, typename MatrixZ,
                              typename VectorISUPPZ>
                    static std::ptrdiff_t invoke(const char jobz, const char range,
                                                 MatrixA& a, const real_type vl, const real_type vu,
                                                 const fortran_int_t il, const fortran_int_t iu,
                                                 const real_type abstol, fortran_int_t& m, VectorW& w,
                                                 MatrixZ& z, VectorISUPPZ& isuppz, optimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        typedef typename result_of::uplo_tag<MatrixA>::type uplo;
                        value_type opt_size_work;
                        real_type opt_size_rwork;
                        fortran_int_t opt_size_iwork;
                        detail::heevr(jobz, range, uplo(), bindings::size_column(a),
                                      bindings::begin_value(a), bindings::stride_major(a), vl, vu,
                                      il, iu, abstol, m, bindings::begin_value(w),
                                      bindings::begin_value(z), bindings::stride_major(z),
                                      bindings::begin_value(isuppz), &opt_size_work, -1,
                                      &opt_size_rwork, -1, &opt_size_iwork, -1);
                        bindings::detail::array<value_type> tmp_work(
                            traits::detail::to_int(opt_size_work));
                        bindings::detail::array<real_type> tmp_rwork(
                            traits::detail::to_int(opt_size_rwork));
                        bindings::detail::array<fortran_int_t> tmp_iwork(
                            opt_size_iwork);
                        return invoke(jobz, range, a, vl, vu, il, iu, abstol, m, w, z,
                                      isuppz, workspace(tmp_work, tmp_rwork, tmp_iwork));
                    }

                    //
                    // 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 std::max<std::ptrdiff_t>(1, 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 std::max<std::ptrdiff_t>(1, 24 * 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 std::max<std::ptrdiff_t>(1, 10 * 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 heevr_impl classes. In the
                // documentation, most overloads are collapsed to avoid a large number of
                // prototypes which are very similar.
                //

                //
                // Overloaded function for heevr. Its overload differs for
                // * User-defined workspace
                //
                template <typename MatrixA, typename VectorW, typename MatrixZ,
                          typename VectorISUPPZ, typename Workspace>
                inline typename boost::enable_if<detail::is_workspace<Workspace>,
                                                 std::ptrdiff_t>::type
                heevr(const char jobz, const char range, MatrixA& a,
                      const typename remove_imaginary<typename bindings::value_type<
                          MatrixA>::type>::type vl, const typename remove_imaginary<
                          typename bindings::value_type<MatrixA>::type>::type vu,
                      const fortran_int_t il, const fortran_int_t iu,
                      const typename remove_imaginary<typename bindings::value_type<
                          MatrixA>::type>::type abstol, fortran_int_t& m, VectorW& w,
                      MatrixZ& z, VectorISUPPZ& isuppz, Workspace work)
                {
                    return heevr_impl<typename bindings::value_type<
                        MatrixA>::type>::invoke(jobz, range, a, vl, vu, il, iu, abstol,
                                                m, w, z, isuppz, work);
                }

                //
                // Overloaded function for heevr. Its overload differs for
                // * Default workspace-type (optimal)
                //
                template <typename MatrixA, typename VectorW, typename MatrixZ,
                          typename VectorISUPPZ>
                inline typename boost::disable_if<detail::is_workspace<VectorISUPPZ>,
                                                  std::ptrdiff_t>::type
                heevr(const char jobz, const char range, MatrixA& a,
                      const typename remove_imaginary<typename bindings::value_type<
                          MatrixA>::type>::type vl, const typename remove_imaginary<
                          typename bindings::value_type<MatrixA>::type>::type vu,
                      const fortran_int_t il, const fortran_int_t iu,
                      const typename remove_imaginary<typename bindings::value_type<
                          MatrixA>::type>::type abstol, fortran_int_t& m, VectorW& w,
                      MatrixZ& z, VectorISUPPZ& isuppz)
                {
                    return heevr_impl<typename bindings::value_type<
                        MatrixA>::type>::invoke(jobz, range, a, vl, vu, il, iu, abstol,
                                                m, w, z, isuppz, optimal_workspace());
                }
            } // namespace lapack
        } // namespace bindings
    } // namespace numeric
} // namespace boost

#endif
