You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
330 lines
13 KiB
330 lines
13 KiB
// |
|
// 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_GERQF_HPP |
|
#define BOOST_NUMERIC_BINDINGS_LAPACK_COMPUTATIONAL_GERQF_HPP |
|
|
|
#include <boost/assert.hpp> |
|
#include <boost/numeric/bindings/begin.hpp> |
|
#include <boost/numeric/bindings/detail/array.hpp> |
|
#include <boost/numeric/bindings/is_column_major.hpp> |
|
#include <boost/numeric/bindings/is_complex.hpp> |
|
#include <boost/numeric/bindings/is_mutable.hpp> |
|
#include <boost/numeric/bindings/is_real.hpp> |
|
#include <boost/numeric/bindings/lapack/workspace.hpp> |
|
#include <boost/numeric/bindings/remove_imaginary.hpp> |
|
#include <boost/numeric/bindings/size.hpp> |
|
#include <boost/numeric/bindings/stride.hpp> |
|
#include <boost/numeric/bindings/traits/detail/utils.hpp> |
|
#include <boost/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 gerqf is the netlib-compatible backend. |
|
// |
|
#include <boost/numeric/bindings/lapack/detail/lapack.h> |
|
#include <boost/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 gerqf( const fortran_int_t m, const fortran_int_t n, |
|
float* a, const fortran_int_t lda, float* tau, float* work, |
|
const fortran_int_t lwork ) { |
|
fortran_int_t info(0); |
|
LAPACK_SGERQF( &m, &n, a, &lda, tau, work, &lwork, &info ); |
|
return info; |
|
} |
|
|
|
// |
|
// Overloaded function for dispatching to |
|
// * netlib-compatible LAPACK backend (the default), and |
|
// * double value-type. |
|
// |
|
inline std::ptrdiff_t gerqf( const fortran_int_t m, const fortran_int_t n, |
|
double* a, const fortran_int_t lda, double* tau, double* work, |
|
const fortran_int_t lwork ) { |
|
fortran_int_t info(0); |
|
LAPACK_DGERQF( &m, &n, a, &lda, tau, 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 gerqf( const fortran_int_t m, const fortran_int_t n, |
|
std::complex<float>* a, const fortran_int_t lda, |
|
std::complex<float>* tau, std::complex<float>* work, |
|
const fortran_int_t lwork ) { |
|
fortran_int_t info(0); |
|
LAPACK_CGERQF( &m, &n, a, &lda, tau, work, &lwork, &info ); |
|
return info; |
|
} |
|
|
|
// |
|
// Overloaded function for dispatching to |
|
// * netlib-compatible LAPACK backend (the default), and |
|
// * complex<double> value-type. |
|
// |
|
inline std::ptrdiff_t gerqf( const fortran_int_t m, const fortran_int_t n, |
|
std::complex<double>* a, const fortran_int_t lda, |
|
std::complex<double>* tau, std::complex<double>* work, |
|
const fortran_int_t lwork ) { |
|
fortran_int_t info(0); |
|
LAPACK_ZGERQF( &m, &n, a, &lda, tau, work, &lwork, &info ); |
|
return info; |
|
} |
|
|
|
} // namespace detail |
|
|
|
// |
|
// Value-type based template class. Use this class if you need a type |
|
// for dispatching to gerqf. |
|
// |
|
template< typename Value, typename Enable = void > |
|
struct gerqf_impl {}; |
|
|
|
// |
|
// This implementation is enabled if Value is a real type. |
|
// |
|
template< typename Value > |
|
struct gerqf_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 VectorTAU, typename WORK > |
|
static std::ptrdiff_t invoke( MatrixA& a, VectorTAU& tau, |
|
detail::workspace1< WORK > work ) { |
|
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< |
|
VectorTAU >::type >::type >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< MatrixA >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< VectorTAU >::value) ); |
|
BOOST_ASSERT( bindings::size(tau) >= std::min< |
|
std::ptrdiff_t >(bindings::size_row(a), |
|
bindings::size_column(a)) ); |
|
BOOST_ASSERT( bindings::size(work.select(real_type())) >= |
|
min_size_work( bindings::size_row(a) )); |
|
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::gerqf( bindings::size_row(a), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(tau), |
|
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 VectorTAU > |
|
static std::ptrdiff_t invoke( MatrixA& a, VectorTAU& tau, |
|
minimal_workspace ) { |
|
namespace bindings = ::boost::numeric::bindings; |
|
bindings::detail::array< real_type > tmp_work( min_size_work( |
|
bindings::size_row(a) ) ); |
|
return invoke( a, tau, 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 VectorTAU > |
|
static std::ptrdiff_t invoke( MatrixA& a, VectorTAU& tau, |
|
optimal_workspace ) { |
|
namespace bindings = ::boost::numeric::bindings; |
|
real_type opt_size_work; |
|
detail::gerqf( bindings::size_row(a), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(tau), &opt_size_work, -1 ); |
|
bindings::detail::array< real_type > tmp_work( |
|
traits::detail::to_int( opt_size_work ) ); |
|
return invoke( a, tau, workspace( tmp_work ) ); |
|
} |
|
|
|
// |
|
// Static member function that returns the minimum size of |
|
// workspace-array work. |
|
// |
|
static std::ptrdiff_t min_size_work( const std::ptrdiff_t m ) { |
|
return std::max< std::ptrdiff_t >(1,m); |
|
} |
|
}; |
|
|
|
// |
|
// This implementation is enabled if Value is a complex type. |
|
// |
|
template< typename Value > |
|
struct gerqf_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 VectorTAU, typename WORK > |
|
static std::ptrdiff_t invoke( MatrixA& a, VectorTAU& tau, |
|
detail::workspace1< WORK > work ) { |
|
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< |
|
VectorTAU >::type >::type >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< MatrixA >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< VectorTAU >::value) ); |
|
BOOST_ASSERT( bindings::size(tau) >= std::min< |
|
std::ptrdiff_t >(bindings::size_row(a), |
|
bindings::size_column(a)) ); |
|
BOOST_ASSERT( bindings::size(work.select(value_type())) >= |
|
min_size_work( bindings::size_row(a) )); |
|
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::gerqf( bindings::size_row(a), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(tau), |
|
bindings::begin_value(work.select(value_type())), |
|
bindings::size(work.select(value_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 VectorTAU > |
|
static std::ptrdiff_t invoke( MatrixA& a, VectorTAU& tau, |
|
minimal_workspace ) { |
|
namespace bindings = ::boost::numeric::bindings; |
|
bindings::detail::array< value_type > tmp_work( min_size_work( |
|
bindings::size_row(a) ) ); |
|
return invoke( a, tau, 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 VectorTAU > |
|
static std::ptrdiff_t invoke( MatrixA& a, VectorTAU& tau, |
|
optimal_workspace ) { |
|
namespace bindings = ::boost::numeric::bindings; |
|
value_type opt_size_work; |
|
detail::gerqf( bindings::size_row(a), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(tau), &opt_size_work, -1 ); |
|
bindings::detail::array< value_type > tmp_work( |
|
traits::detail::to_int( opt_size_work ) ); |
|
return invoke( a, tau, workspace( tmp_work ) ); |
|
} |
|
|
|
// |
|
// Static member function that returns the minimum size of |
|
// workspace-array work. |
|
// |
|
static std::ptrdiff_t min_size_work( const std::ptrdiff_t m ) { |
|
return std::max< std::ptrdiff_t >(1,m); |
|
} |
|
}; |
|
|
|
|
|
// |
|
// 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 gerqf_impl classes. In the |
|
// documentation, most overloads are collapsed to avoid a large number of |
|
// prototypes which are very similar. |
|
// |
|
|
|
// |
|
// Overloaded function for gerqf. Its overload differs for |
|
// * User-defined workspace |
|
// |
|
template< typename MatrixA, typename VectorTAU, typename Workspace > |
|
inline typename boost::enable_if< detail::is_workspace< Workspace >, |
|
std::ptrdiff_t >::type |
|
gerqf( MatrixA& a, VectorTAU& tau, Workspace work ) { |
|
return gerqf_impl< typename bindings::value_type< |
|
MatrixA >::type >::invoke( a, tau, work ); |
|
} |
|
|
|
// |
|
// Overloaded function for gerqf. Its overload differs for |
|
// * Default workspace-type (optimal) |
|
// |
|
template< typename MatrixA, typename VectorTAU > |
|
inline typename boost::disable_if< detail::is_workspace< VectorTAU >, |
|
std::ptrdiff_t >::type |
|
gerqf( MatrixA& a, VectorTAU& tau ) { |
|
return gerqf_impl< typename bindings::value_type< |
|
MatrixA >::type >::invoke( a, tau, optimal_workspace() ); |
|
} |
|
|
|
} // namespace lapack |
|
} // namespace bindings |
|
} // namespace numeric |
|
} // namespace boost |
|
|
|
#endif
|
|
|