//
// 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_COMPUTATIONAL_GEEQU_HPP
#define BOOST_NUMERIC_BINDINGS_LAPACK_COMPUTATIONAL_GEEQU_HPP

#include <boost/assert.hpp>
#include <Core/Utils/numeric/bindings/begin.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/remove_imaginary.hpp>
#include <Core/Utils/numeric/bindings/size.hpp>
#include <Core/Utils/numeric/bindings/stride.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 geequ 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 geequ(const fortran_int_t m, const fortran_int_t n,
                                                const float* a, const fortran_int_t lda, float* r, float* c,
                                                float& rowcnd, float& colcnd, float& amax)
                    {
                        fortran_int_t info(0);
                        LAPACK_SGEEQU(&m, &n, a, &lda, r, c, &rowcnd, &colcnd, &amax, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * double value-type.
                    //
                    inline std::ptrdiff_t geequ(const fortran_int_t m, const fortran_int_t n,
                                                const double* a, const fortran_int_t lda, double* r, double* c,
                                                double& rowcnd, double& colcnd, double& amax)
                    {
                        fortran_int_t info(0);
                        LAPACK_DGEEQU(&m, &n, a, &lda, r, c, &rowcnd, &colcnd, &amax, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * complex<float> value-type.
                    //
                    inline std::ptrdiff_t geequ(const fortran_int_t m, const fortran_int_t n,
                                                const std::complex<float>* a, const fortran_int_t lda, float* r,
                                                float* c, float& rowcnd, float& colcnd, float& amax)
                    {
                        fortran_int_t info(0);
                        LAPACK_CGEEQU(&m, &n, a, &lda, r, c, &rowcnd, &colcnd, &amax, &info);
                        return info;
                    }

                    //
                    // Overloaded function for dispatching to
                    // * netlib-compatible LAPACK backend (the default), and
                    // * complex<double> value-type.
                    //
                    inline std::ptrdiff_t geequ(const fortran_int_t m, const fortran_int_t n,
                                                const std::complex<double>* a, const fortran_int_t lda, double* r,
                                                double* c, double& rowcnd, double& colcnd, double& amax)
                    {
                        fortran_int_t info(0);
                        LAPACK_ZGEEQU(&m, &n, a, &lda, r, c, &rowcnd, &colcnd, &amax, &info);
                        return info;
                    }
                } // namespace detail

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

                //
                // This implementation is enabled if Value is a real type.
                //
                template <typename Value>
                struct geequ_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, that
                    // * Deduces the required arguments for dispatching to LAPACK, and
                    // * Asserts that most arguments make sense.
                    //
                    template <typename MatrixA, typename VectorR, typename VectorC>
                    static std::ptrdiff_t invoke(const MatrixA& a, VectorR& r, VectorC& c,
                                                 real_type& rowcnd, real_type& colcnd, real_type& amax)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixA>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<MatrixA>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                VectorR>::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<
                                                                VectorC>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorR>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorC>::value));
                        BOOST_ASSERT(bindings::size_column(a) >= 0);
                        BOOST_ASSERT(bindings::size_minor(a) == 1 ||
                            bindings::stride_minor(a) == 1);
                        BOOST_ASSERT(bindings::size_row(a) >= 0);
                        BOOST_ASSERT(bindings::stride_major(a) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_row(a)));
                        return detail::geequ(bindings::size_row(a), bindings::size_column(a),
                                             bindings::begin_value(a), bindings::stride_major(a),
                                             bindings::begin_value(r), bindings::begin_value(c), rowcnd,
                                             colcnd, amax);
                    }
                };

                //
                // This implementation is enabled if Value is a complex type.
                //
                template <typename Value>
                struct geequ_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, that
                    // * Deduces the required arguments for dispatching to LAPACK, and
                    // * Asserts that most arguments make sense.
                    //
                    template <typename MatrixA, typename VectorR, typename VectorC>
                    static std::ptrdiff_t invoke(const MatrixA& a, VectorR& r, VectorC& c,
                                                 real_type& rowcnd, real_type& colcnd, real_type& amax)
                    {
                        namespace bindings = ::boost::numeric::bindings;
                        BOOST_STATIC_ASSERT((bindings::is_column_major<MatrixA>::value));
                        BOOST_STATIC_ASSERT((boost::is_same<typename remove_const<
                                                                typename bindings::value_type<VectorR>::type>::type,
                                                            typename remove_const<typename bindings::value_type<
                                                                VectorC>::type>::type>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorR>::value));
                        BOOST_STATIC_ASSERT((bindings::is_mutable<VectorC>::value));
                        BOOST_ASSERT(bindings::size_column(a) >= 0);
                        BOOST_ASSERT(bindings::size_minor(a) == 1 ||
                            bindings::stride_minor(a) == 1);
                        BOOST_ASSERT(bindings::size_row(a) >= 0);
                        BOOST_ASSERT(bindings::stride_major(a) >= std::max<std::ptrdiff_t>(1,
                                                                                           bindings::size_row(a)));
                        return detail::geequ(bindings::size_row(a), bindings::size_column(a),
                                             bindings::begin_value(a), bindings::stride_major(a),
                                             bindings::begin_value(r), bindings::begin_value(c), rowcnd,
                                             colcnd, amax);
                    }
                };


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

                //
                // Overloaded function for geequ. Its overload differs for
                //
                template <typename MatrixA, typename VectorR, typename VectorC>
                inline std::ptrdiff_t geequ(const MatrixA& a, VectorR& r, VectorC& c,
                                            typename remove_imaginary<typename bindings::value_type<
                                                MatrixA>::type>::type& rowcnd, typename remove_imaginary<
                                                typename bindings::value_type<MatrixA>::type>::type& colcnd,
                                            typename remove_imaginary<typename bindings::value_type<
                                                MatrixA>::type>::type& amax)
                {
                    return geequ_impl<typename bindings::value_type<
                        MatrixA>::type>::invoke(a, r, c, rowcnd, colcnd, amax);
                }
            } // namespace lapack
        } // namespace bindings
    } // namespace numeric
} // namespace boost

#endif
