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.
468 lines
19 KiB
468 lines
19 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_DRIVER_HEGVD_HPP |
|
#define BOOST_NUMERIC_BINDINGS_LAPACK_DRIVER_HEGVD_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/uplo_tag.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 hegvd 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. |
|
// |
|
template< typename UpLo > |
|
inline std::ptrdiff_t hegvd( const fortran_int_t itype, const char jobz, |
|
const UpLo, const fortran_int_t n, float* a, const fortran_int_t lda, |
|
float* b, const fortran_int_t ldb, float* w, float* work, |
|
const fortran_int_t lwork, fortran_int_t* iwork, |
|
const fortran_int_t liwork ) { |
|
fortran_int_t info(0); |
|
LAPACK_SSYGVD( &itype, &jobz, &lapack_option< UpLo >::value, &n, a, &lda, |
|
b, &ldb, w, 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 hegvd( const fortran_int_t itype, const char jobz, |
|
const UpLo, const fortran_int_t n, double* a, const fortran_int_t lda, |
|
double* b, const fortran_int_t ldb, double* w, double* work, |
|
const fortran_int_t lwork, fortran_int_t* iwork, |
|
const fortran_int_t liwork ) { |
|
fortran_int_t info(0); |
|
LAPACK_DSYGVD( &itype, &jobz, &lapack_option< UpLo >::value, &n, a, &lda, |
|
b, &ldb, w, 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 hegvd( const fortran_int_t itype, const char jobz, |
|
const UpLo, const fortran_int_t n, std::complex<float>* a, |
|
const fortran_int_t lda, std::complex<float>* b, |
|
const fortran_int_t ldb, float* w, 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_CHEGVD( &itype, &jobz, &lapack_option< UpLo >::value, &n, a, &lda, |
|
b, &ldb, w, 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 hegvd( const fortran_int_t itype, const char jobz, |
|
const UpLo, const fortran_int_t n, std::complex<double>* a, |
|
const fortran_int_t lda, std::complex<double>* b, |
|
const fortran_int_t ldb, double* w, 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_ZHEGVD( &itype, &jobz, &lapack_option< UpLo >::value, &n, a, &lda, |
|
b, &ldb, w, 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 hegvd. |
|
// |
|
template< typename Value, typename Enable = void > |
|
struct hegvd_impl {}; |
|
|
|
// |
|
// This implementation is enabled if Value is a real type. |
|
// |
|
template< typename Value > |
|
struct hegvd_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 MatrixB, typename VectorW, |
|
typename WORK, typename IWORK > |
|
static std::ptrdiff_t invoke( const fortran_int_t itype, |
|
const char jobz, MatrixA& a, MatrixB& b, VectorW& w, |
|
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< MatrixB >::value) ); |
|
BOOST_STATIC_ASSERT( (boost::is_same< typename remove_const< |
|
typename bindings::value_type< MatrixA >::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< MatrixA >::type >::type, |
|
typename remove_const< typename bindings::value_type< |
|
VectorW >::type >::type >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< MatrixA >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< MatrixB >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< VectorW >::value) ); |
|
BOOST_ASSERT( bindings::size(work.select(fortran_int_t())) >= |
|
min_size_iwork( jobz, bindings::size_column(a) )); |
|
BOOST_ASSERT( bindings::size(work.select(real_type())) >= |
|
min_size_work( jobz, 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(b) == 1 || |
|
bindings::stride_minor(b) == 1 ); |
|
BOOST_ASSERT( bindings::stride_major(a) >= std::max< std::ptrdiff_t >(1, |
|
bindings::size_column(a)) ); |
|
BOOST_ASSERT( bindings::stride_major(b) >= std::max< std::ptrdiff_t >(1, |
|
bindings::size_column(a)) ); |
|
BOOST_ASSERT( jobz == 'N' || jobz == 'V' ); |
|
return detail::hegvd( itype, jobz, uplo(), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(b), bindings::stride_major(b), |
|
bindings::begin_value(w), |
|
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 MatrixB, typename VectorW > |
|
static std::ptrdiff_t invoke( const fortran_int_t itype, |
|
const char jobz, MatrixA& a, MatrixB& b, VectorW& w, |
|
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( jobz, |
|
bindings::size_column(a) ) ); |
|
bindings::detail::array< fortran_int_t > tmp_iwork( |
|
min_size_iwork( jobz, bindings::size_column(a) ) ); |
|
return invoke( itype, jobz, a, b, w, 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 MatrixB, typename VectorW > |
|
static std::ptrdiff_t invoke( const fortran_int_t itype, |
|
const char jobz, MatrixA& a, MatrixB& b, VectorW& w, |
|
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::hegvd( itype, jobz, uplo(), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(b), bindings::stride_major(b), |
|
bindings::begin_value(w), &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( itype, jobz, a, b, w, 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 char jobz, |
|
const std::ptrdiff_t n ) { |
|
if ( n < 2 ) |
|
return 1; |
|
else { |
|
if ( jobz == 'N' ) |
|
return 2*n + 1; |
|
else |
|
return 1 + 6*n + 2*n*n; |
|
} |
|
} |
|
|
|
// |
|
// Static member function that returns the minimum size of |
|
// workspace-array iwork. |
|
// |
|
static std::ptrdiff_t min_size_iwork( const char jobz, |
|
const std::ptrdiff_t n ) { |
|
if ( jobz == 'N' || n < 2 ) |
|
return 1; |
|
else |
|
return 3 + 5*n; |
|
} |
|
}; |
|
|
|
// |
|
// This implementation is enabled if Value is a complex type. |
|
// |
|
template< typename Value > |
|
struct hegvd_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 MatrixB, typename VectorW, |
|
typename WORK, typename RWORK, typename IWORK > |
|
static std::ptrdiff_t invoke( const fortran_int_t itype, |
|
const char jobz, MatrixA& a, MatrixB& b, VectorW& w, |
|
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< MatrixB >::value) ); |
|
BOOST_STATIC_ASSERT( (boost::is_same< typename remove_const< |
|
typename bindings::value_type< MatrixA >::type >::type, |
|
typename remove_const< typename bindings::value_type< |
|
MatrixB >::type >::type >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< MatrixA >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< MatrixB >::value) ); |
|
BOOST_STATIC_ASSERT( (bindings::is_mutable< VectorW >::value) ); |
|
BOOST_ASSERT( bindings::size(work.select(fortran_int_t())) >= |
|
min_size_iwork( jobz, bindings::size_column(a) )); |
|
BOOST_ASSERT( bindings::size(work.select(real_type())) >= |
|
min_size_rwork( jobz, bindings::size_column(a) )); |
|
BOOST_ASSERT( bindings::size(work.select(value_type())) >= |
|
min_size_work( jobz, 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(b) == 1 || |
|
bindings::stride_minor(b) == 1 ); |
|
BOOST_ASSERT( bindings::stride_major(a) >= std::max< std::ptrdiff_t >(1, |
|
bindings::size_column(a)) ); |
|
BOOST_ASSERT( bindings::stride_major(b) >= std::max< std::ptrdiff_t >(1, |
|
bindings::size_column(a)) ); |
|
BOOST_ASSERT( jobz == 'N' || jobz == 'V' ); |
|
return detail::hegvd( itype, jobz, uplo(), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(b), bindings::stride_major(b), |
|
bindings::begin_value(w), |
|
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 MatrixB, typename VectorW > |
|
static std::ptrdiff_t invoke( const fortran_int_t itype, |
|
const char jobz, MatrixA& a, MatrixB& b, VectorW& w, |
|
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( jobz, |
|
bindings::size_column(a) ) ); |
|
bindings::detail::array< real_type > tmp_rwork( min_size_rwork( jobz, |
|
bindings::size_column(a) ) ); |
|
bindings::detail::array< fortran_int_t > tmp_iwork( |
|
min_size_iwork( jobz, bindings::size_column(a) ) ); |
|
return invoke( itype, jobz, a, b, w, 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 MatrixB, typename VectorW > |
|
static std::ptrdiff_t invoke( const fortran_int_t itype, |
|
const char jobz, MatrixA& a, MatrixB& b, VectorW& w, |
|
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::hegvd( itype, jobz, uplo(), bindings::size_column(a), |
|
bindings::begin_value(a), bindings::stride_major(a), |
|
bindings::begin_value(b), bindings::stride_major(b), |
|
bindings::begin_value(w), &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( itype, jobz, a, b, w, 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 char jobz, |
|
const std::ptrdiff_t n ) { |
|
if ( n < 2 ) |
|
return 1; |
|
else { |
|
if ( jobz == 'N' ) |
|
return n+1; |
|
else |
|
return 2*n + n*n; |
|
} |
|
} |
|
|
|
// |
|
// Static member function that returns the minimum size of |
|
// workspace-array rwork. |
|
// |
|
static std::ptrdiff_t min_size_rwork( const char jobz, |
|
const std::ptrdiff_t n ) { |
|
if ( n < 2 ) |
|
return 1; |
|
else { |
|
if ( jobz == 'N' ) |
|
return n; |
|
else |
|
return 1 + 5*n + 2*n*n; |
|
} |
|
} |
|
|
|
// |
|
// Static member function that returns the minimum size of |
|
// workspace-array iwork. |
|
// |
|
static std::ptrdiff_t min_size_iwork( const char jobz, |
|
const std::ptrdiff_t n ) { |
|
if ( jobz == 'N' || n < 2 ) |
|
return 1; |
|
else |
|
return 3 + 5*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 hegvd_impl classes. In the |
|
// documentation, most overloads are collapsed to avoid a large number of |
|
// prototypes which are very similar. |
|
// |
|
|
|
// |
|
// Overloaded function for hegvd. Its overload differs for |
|
// * User-defined workspace |
|
// |
|
template< typename MatrixA, typename MatrixB, typename VectorW, |
|
typename Workspace > |
|
inline typename boost::enable_if< detail::is_workspace< Workspace >, |
|
std::ptrdiff_t >::type |
|
hegvd( const fortran_int_t itype, const char jobz, MatrixA& a, |
|
MatrixB& b, VectorW& w, Workspace work ) { |
|
return hegvd_impl< typename bindings::value_type< |
|
MatrixA >::type >::invoke( itype, jobz, a, b, w, work ); |
|
} |
|
|
|
// |
|
// Overloaded function for hegvd. Its overload differs for |
|
// * Default workspace-type (optimal) |
|
// |
|
template< typename MatrixA, typename MatrixB, typename VectorW > |
|
inline typename boost::disable_if< detail::is_workspace< VectorW >, |
|
std::ptrdiff_t >::type |
|
hegvd( const fortran_int_t itype, const char jobz, MatrixA& a, |
|
MatrixB& b, VectorW& w ) { |
|
return hegvd_impl< typename bindings::value_type< |
|
MatrixA >::type >::invoke( itype, jobz, a, b, w, |
|
optimal_workspace() ); |
|
} |
|
|
|
} // namespace lapack |
|
} // namespace bindings |
|
} // namespace numeric |
|
} // namespace boost |
|
|
|
#endif
|
|
|