//
// 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_GESVD_HPP
#define BOOST_NUMERIC_BINDINGS_LAPACK_DRIVER_GESVD_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/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 gesvd 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.
                    //
                    inline std::ptrdiff_t gesvd(const char jobu, const char jobvt,
                                                const fortran_int_t m, const fortran_int_t n, float* a,
                                                const fortran_int_t lda, float* s, float* u, const fortran_int_t ldu,
                                                float* vt, const fortran_int_t ldvt, float* work,
                                                const fortran_int_t lwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_SGESVD(&jobu, &jobvt, &m, &n, a, &lda, s, u, &ldu, vt, &ldvt,
                                      work, &lwork, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * double value-type.
                    //
                    inline std::ptrdiff_t gesvd(const char jobu, const char jobvt,
                                                const fortran_int_t m, const fortran_int_t n, double* a,
                                                const fortran_int_t lda, double* s, double* u,
                                                const fortran_int_t ldu, double* vt, const fortran_int_t ldvt,
                                                double* work, const fortran_int_t lwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_DGESVD(&jobu, &jobvt, &m, &n, a, &lda, s, u, &ldu, vt, &ldvt,
                                      work, &lwork, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * complex<float> value-type.
                    //
                    inline std::ptrdiff_t gesvd(const char jobu, const char jobvt,
                                                const fortran_int_t m, const fortran_int_t n, std::complex<float>* a,
                                                const fortran_int_t lda, float* s, std::complex<float>* u,
                                                const fortran_int_t ldu, std::complex<float>* vt,
                                                const fortran_int_t ldvt, std::complex<float>* work,
                                                const fortran_int_t lwork, float* rwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_CGESVD(&jobu, &jobvt, &m, &n, a, &lda, s, u, &ldu, vt, &ldvt,
                                      work, &lwork, rwork, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * complex<double> value-type.
                    //
                    inline std::ptrdiff_t gesvd(const char jobu, const char jobvt,
                                                const fortran_int_t m, const fortran_int_t n, std::complex<double>* a,
                                                const fortran_int_t lda, double* s, std::complex<double>* u,
                                                const fortran_int_t ldu, std::complex<double>* vt,
                                                const fortran_int_t ldvt, std::complex<double>* work,
                                                const fortran_int_t lwork, double* rwork)
                    {
                        fortran_int_t info(0);
                        LAPACK_ZGESVD(&jobu, &jobvt, &m, &n, a, &lda, s, u, &ldu, vt, &ldvt,
                                      work, &lwork, rwork, &info);
                        return info;
                    }
                } // namespace detail

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

                //
                // This implementation is enabled if Value is a real type.
                //
                template <typename Value>
                struct gesvd_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 VectorS, typename MatrixU,
                              typename MatrixVT, typename WORK>
                    static std::ptrdiff_t invoke(const char jobu, const char jobvt,
                                                 MatrixA& a, VectorS& s, MatrixU& u, MatrixVT& vt,
                                                 detail::workspace1<WORK> work)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixU>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixVT>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixA>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                VectorS>::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<
                                                                MatrixU>::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<
                                                                MatrixVT>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorS>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixU>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixVT>::value));
                        BOOST_ASSERT(bindings::size(s) >= std::min<
                            std::ptrdiff_t>(bindings::size_row(a),
                                            bindings::size_column(a)));
                        BOOST_ASSERT(bindings::size(work.select(real_type())) >=
                            min_size_work(jobu, jobvt, bindings::size_row(a),
                                          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(u) == 1 ||
                            bindings::stride_minor(u) == 1);
                        BOOST_ASSERT(bindings::size_minor(vt) == 1 ||
                            bindings::stride_minor(vt) == 1);
                        BOOST_ASSERT(bindings::size_row(a) >= 0);
                        BOOST_ASSERT(bindings::stride_major(a) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_row(a)));
                        BOOST_ASSERT(jobu == 'A' || jobu == 'S' || jobu == 'O' ||
                            jobu == 'N');
                        BOOST_ASSERT(jobvt == 'A' || jobvt == 'S' || jobvt == 'O' ||
                            jobvt == 'N');
                        return detail::gesvd(jobu, jobvt, bindings::size_row(a),
                                             bindings::size_column(a), bindings::begin_value(a),
                                             bindings::stride_major(a), bindings::begin_value(s),
                                             bindings::begin_value(u), bindings::stride_major(u),
                                             bindings::begin_value(vt), bindings::stride_major(vt),
                                             bindings::begin_value(work.select(real_type())),
                                             bindings::size(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 MatrixA, typename VectorS, typename MatrixU,
                              typename MatrixVT>
                    static std::ptrdiff_t invoke(const char jobu, const char jobvt,
                                                 MatrixA& a, VectorS& s, MatrixU& u, MatrixVT& vt,
                                                 minimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        bindings::detail::array<real_type> tmp_work(min_size_work(jobu,
                                                                                  jobvt, bindings::size_row(a),
                                                                                  bindings::size_column(a)));
                        return invoke(jobu, jobvt, a, s, u, vt, workspace(tmp_work));
                    }

                    //
                    // 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 VectorS, typename MatrixU,
                              typename MatrixVT>
                    static std::ptrdiff_t invoke(const char jobu, const char jobvt,
                                                 MatrixA& a, VectorS& s, MatrixU& u, MatrixVT& vt,
                                                 optimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        real_type opt_size_work;
                        detail::gesvd(jobu, jobvt, bindings::size_row(a),
                                      bindings::size_column(a), bindings::begin_value(a),
                                      bindings::stride_major(a), bindings::begin_value(s),
                                      bindings::begin_value(u), bindings::stride_major(u),
                                      bindings::begin_value(vt), bindings::stride_major(vt),
                                      &opt_size_work, -1);
                        bindings::detail::array<real_type> tmp_work(
                            traits::detail::to_int(opt_size_work));
                        return invoke(jobu, jobvt, a, s, u, vt, workspace(tmp_work));
                    }

                    //
                    // Static member function that returns the minimum size of
                    // workspace-array work.
                    //
                    static std::ptrdiff_t min_size_work(const char jobu, const char jobvt,
                                                        const std::ptrdiff_t m, const std::ptrdiff_t n)
                    {
                        //
                        // Contributed by Marco Guazzone
                        // Also see http://tinyurl.com/5rbpdc5
                        //
                        if (m == 0 || n == 0)
                        {
                            return 1;
                        }
                        else if (m >= n)
                        {
                            if (jobu == 'N')
                            {
                                return 5 * n;
                            }
                            else
                            {
                                return std::max<std::ptrdiff_t>(3 * n + m, 5 * n);
                            }
                        }
                        else
                        {
                            if (jobvt == 'N')
                            {
                                return 5 * m;
                            }
                            else
                            {
                                return std::max<std::ptrdiff_t>(3 * m + n, 5 * m);
                            }
                        }
                    }
                };

                //
                // This implementation is enabled if Value is a complex type.
                //
                template <typename Value>
                struct gesvd_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 VectorS, typename MatrixU,
                              typename MatrixVT, typename WORK, typename RWORK>
                    static std::ptrdiff_t invoke(const char jobu, const char jobvt,
                                                 MatrixA& a, VectorS& s, MatrixU& u, MatrixVT& vt,
                                                 detail::workspace2<WORK, RWORK> work)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixU>::value));
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixVT>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixA>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                MatrixU>::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<
                                                                MatrixVT>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixA>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorS>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixU>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<MatrixVT>::value));
                        std::ptrdiff_t minmn = std::min<std::ptrdiff_t>(size_row(a),
                                                                        size_column(a));
                        BOOST_ASSERT(bindings::size(s) >= std::min<
                            std::ptrdiff_t>(bindings::size_row(a),
                                            bindings::size_column(a)));
                        BOOST_ASSERT(bindings::size(work.select(real_type())) >=
                            min_size_rwork(minmn));
                        BOOST_ASSERT(bindings::size(work.select(value_type())) >=
                            min_size_work(jobu, jobvt, bindings::size_row(a),
                                          bindings::size_column(a), minmn));
                        BOOST_ASSERT(bindings::size_column(a) >= 0);
                        BOOST_ASSERT(bindings::size_minor(a) == 1 ||
                            bindings::stride_minor(a) == 1);
                        BOOST_ASSERT(bindings::size_minor(u) == 1 ||
                            bindings::stride_minor(u) == 1);
                        BOOST_ASSERT(bindings::size_minor(vt) == 1 ||
                            bindings::stride_minor(vt) == 1);
                        BOOST_ASSERT(bindings::size_row(a) >= 0);
                        BOOST_ASSERT(bindings::stride_major(a) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_row(a)));
                        BOOST_ASSERT(jobu == 'A' || jobu == 'S' || jobu == 'O' ||
                            jobu == 'N');
                        BOOST_ASSERT(jobvt == 'A' || jobvt == 'S' || jobvt == 'O' ||
                            jobvt == 'N');
                        return detail::gesvd(jobu, jobvt, bindings::size_row(a),
                                             bindings::size_column(a), bindings::begin_value(a),
                                             bindings::stride_major(a), bindings::begin_value(s),
                                             bindings::begin_value(u), bindings::stride_major(u),
                                             bindings::begin_value(vt), bindings::stride_major(vt),
                                             bindings::begin_value(work.select(value_type())),
                                             bindings::size(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 MatrixA, typename VectorS, typename MatrixU,
                              typename MatrixVT>
                    static std::ptrdiff_t invoke(const char jobu, const char jobvt,
                                                 MatrixA& a, VectorS& s, MatrixU& u, MatrixVT& vt,
                                                 minimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        std::ptrdiff_t minmn = std::min<std::ptrdiff_t>(size_row(a),
                                                                        size_column(a));
                        bindings::detail::array<value_type> tmp_work(min_size_work(jobu,
                                                                                   jobvt, bindings::size_row(a),
                                                                                   bindings::size_column(a),
                                                                                   minmn));
                        bindings::detail::array<real_type> tmp_rwork(min_size_rwork(
                            minmn));
                        return invoke(jobu, jobvt, a, s, u, vt, 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 MatrixA, typename VectorS, typename MatrixU,
                              typename MatrixVT>
                    static std::ptrdiff_t invoke(const char jobu, const char jobvt,
                                                 MatrixA& a, VectorS& s, MatrixU& u, MatrixVT& vt,
                                                 optimal_workspace)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        std::ptrdiff_t minmn = std::min<std::ptrdiff_t>(size_row(a),
                                                                        size_column(a));
                        value_type opt_size_work;
                        bindings::detail::array<real_type> tmp_rwork(min_size_rwork(
                            minmn));
                        detail::gesvd(jobu, jobvt, bindings::size_row(a),
                                      bindings::size_column(a), bindings::begin_value(a),
                                      bindings::stride_major(a), bindings::begin_value(s),
                                      bindings::begin_value(u), bindings::stride_major(u),
                                      bindings::begin_value(vt), bindings::stride_major(vt),
                                      &opt_size_work, -1, bindings::begin_value(tmp_rwork));
                        bindings::detail::array<value_type> tmp_work(
                            traits::detail::to_int(opt_size_work));
                        return invoke(jobu, jobvt, a, s, u, vt, workspace(tmp_work,
                                                                          tmp_rwork));
                    }

                    //
                    // Static member function that returns the minimum size of
                    // workspace-array work.
                    //
                    static std::ptrdiff_t min_size_work(const char jobu, const char jobvt,
                                                        const std::ptrdiff_t m, const std::ptrdiff_t n,
                                                        const std::ptrdiff_t minmn)
                    {
                        //
                        // Contributed by Marco Guazzone
                        // Also see http://tinyurl.com/5rbpdc5
                        //
                        if (minmn == 0)
                        {
                            return 1;
                        }
                        else if (m >= n)
                        {
                            if (jobu == 'N')
                            {
                                return 3 * n;
                            }
                            else
                            {
                                return 2 * n + m;
                            }
                        }
                        else
                        {
                            if (jobvt == 'N')
                            {
                                return 3 * m;
                            }
                            else
                            {
                                return 2 * m + n;
                            }
                        }
                    }

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


                //
                // 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 gesvd_impl classes. In the
                // documentation, most overloads are collapsed to avoid a large number of
                // prototypes which are very similar.
                //

                //
                // Overloaded function for gesvd. Its overload differs for
                // * User-defined workspace
                //
                template <typename MatrixA, typename VectorS, typename MatrixU,
                          typename MatrixVT, typename Workspace>
                inline typename boost::enable_if<detail::is_workspace<Workspace>,
                                                 std::ptrdiff_t>::type
                gesvd(const char jobu, const char jobvt, MatrixA& a, VectorS& s,
                      MatrixU& u, MatrixVT& vt, Workspace work)
                {
                    return gesvd_impl<typename bindings::value_type<
                        MatrixA>::type>::invoke(jobu, jobvt, a, s, u, vt, work);
                }

                //
                // Overloaded function for gesvd. Its overload differs for
                // * Default workspace-type (optimal)
                //
                template <typename MatrixA, typename VectorS, typename MatrixU,
                          typename MatrixVT>
                inline typename boost::disable_if<detail::is_workspace<MatrixVT>,
                                                  std::ptrdiff_t>::type
                gesvd(const char jobu, const char jobvt, MatrixA& a, VectorS& s,
                      MatrixU& u, MatrixVT& vt)
                {
                    return gesvd_impl<typename bindings::value_type<
                        MatrixA>::type>::invoke(jobu, jobvt, a, s, u, vt,
                                                optimal_workspace());
                }
            } // namespace lapack
        } // namespace bindings
    } // namespace numeric
} // namespace boost

#endif
