Eigen  5.0.1
 
Loading...
Searching...
No Matches
SelfadjointMatrixVector_BLAS.h
1/*
2 Copyright (c) 2011, Intel Corporation. All rights reserved.
3
4 Redistribution and use in source and binary forms, with or without modification,
5 are permitted provided that the following conditions are met:
6
7 * Redistributions of source code must retain the above copyright notice, this
8 list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright notice,
10 this list of conditions and the following disclaimer in the documentation
11 and/or other materials provided with the distribution.
12 * Neither the name of Intel Corporation nor the names of its contributors may
13 be used to endorse or promote products derived from this software without
14 specific prior written permission.
15
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27 ********************************************************************************
28 * Content : Eigen bindings to BLAS F77
29 * Selfadjoint matrix-vector product functionality based on ?SYMV/?HEMV.
30 ********************************************************************************
31*/
32// SPDX-License-Identifier: BSD-3-Clause
33
34#ifndef EIGEN_SELFADJOINT_MATRIX_VECTOR_BLAS_H
35#define EIGEN_SELFADJOINT_MATRIX_VECTOR_BLAS_H
36
37// IWYU pragma: private
38#include "../InternalHeaderCheck.h"
39
40namespace Eigen {
41
42namespace internal {
43
44/**********************************************************************
45 * This file implements selfadjoint matrix-vector multiplication using BLAS
46 **********************************************************************/
47
48// symv/hemv specialization
49
50template <typename Scalar, typename Index, int StorageOrder, int UpLo, bool ConjugateLhs, bool ConjugateRhs>
51struct selfadjoint_matrix_vector_product_symv
52 : selfadjoint_matrix_vector_product<Scalar, Index, StorageOrder, UpLo, ConjugateLhs, ConjugateRhs, BuiltIn> {};
53
54#define EIGEN_BLAS_SYMV_SPECIALIZE(Scalar) \
55 template <typename Index, int StorageOrder, int UpLo, bool ConjugateLhs, bool ConjugateRhs> \
56 struct selfadjoint_matrix_vector_product<Scalar, Index, StorageOrder, UpLo, ConjugateLhs, ConjugateRhs, \
57 Specialized> { \
58 static void run(Index size, const Scalar* lhs, Index lhsStride, const Scalar* _rhs, Scalar* res, Scalar alpha) { \
59 enum { IsColMajor = StorageOrder == ColMajor }; \
60 EIGEN_IF_CONSTEXPR (IsColMajor == ConjugateLhs) { \
61 selfadjoint_matrix_vector_product<Scalar, Index, StorageOrder, UpLo, ConjugateLhs, ConjugateRhs, \
62 BuiltIn>::run(size, lhs, lhsStride, _rhs, res, alpha); \
63 } else { \
64 selfadjoint_matrix_vector_product_symv<Scalar, Index, StorageOrder, UpLo, ConjugateLhs, ConjugateRhs>::run( \
65 size, lhs, lhsStride, _rhs, res, alpha); \
66 } \
67 } \
68 };
69
70EIGEN_BLAS_SYMV_SPECIALIZE(double)
71EIGEN_BLAS_SYMV_SPECIALIZE(float)
72EIGEN_BLAS_SYMV_SPECIALIZE(dcomplex)
73EIGEN_BLAS_SYMV_SPECIALIZE(scomplex)
74
75#define EIGEN_BLAS_SYMV_SPECIALIZATION(EIGTYPE, BLASTYPE, BLASFUNC) \
76 template <typename Index, int StorageOrder, int UpLo, bool ConjugateLhs, bool ConjugateRhs> \
77 struct selfadjoint_matrix_vector_product_symv<EIGTYPE, Index, StorageOrder, UpLo, ConjugateLhs, ConjugateRhs> { \
78 typedef Matrix<EIGTYPE, Dynamic, 1, ColMajor> SYMVVector; \
79 \
80 static void run(Index size, const EIGTYPE* lhs, Index lhsStride, const EIGTYPE* _rhs, EIGTYPE* res, \
81 EIGTYPE alpha) { \
82 if (size == 0) return; \
83 enum { IsRowMajor = StorageOrder == RowMajor ? 1 : 0, IsLower = UpLo == Lower ? 1 : 0 }; \
84 BlasIndex n = convert_index<BlasIndex>(size), lda = convert_index<BlasIndex>(lhsStride), incx = 1, incy = 1; \
85 EIGTYPE beta(1); \
86 const EIGTYPE* x_ptr; \
87 char uplo = (IsRowMajor) ? (IsLower ? 'U' : 'L') : (IsLower ? 'L' : 'U'); \
88 SYMVVector x_tmp; \
89 EIGEN_IF_CONSTEXPR (ConjugateRhs) { \
90 Map<const SYMVVector, 0> map_x(_rhs, size, 1); \
91 x_tmp = map_x.conjugate(); \
92 x_ptr = x_tmp.data(); \
93 } else \
94 x_ptr = _rhs; \
95 BLASFUNC(&uplo, &n, (const BLASTYPE*)&numext::real_ref(alpha), (const BLASTYPE*)lhs, &lda, \
96 (const BLASTYPE*)x_ptr, &incx, (const BLASTYPE*)&numext::real_ref(beta), (BLASTYPE*)res, &incy); \
97 } \
98 };
99
100#ifdef EIGEN_USE_MKL
101EIGEN_BLAS_SYMV_SPECIALIZATION(double, double, dsymv)
102EIGEN_BLAS_SYMV_SPECIALIZATION(float, float, ssymv)
103EIGEN_BLAS_SYMV_SPECIALIZATION(dcomplex, MKL_Complex16, zhemv)
104EIGEN_BLAS_SYMV_SPECIALIZATION(scomplex, MKL_Complex8, chemv)
105#else
106EIGEN_BLAS_SYMV_SPECIALIZATION(double, double, EIGEN_BLAS_SYM(dsymv))
107EIGEN_BLAS_SYMV_SPECIALIZATION(float, float, EIGEN_BLAS_SYM(ssymv))
108EIGEN_BLAS_SYMV_SPECIALIZATION(dcomplex, double, EIGEN_BLAS_SYM(zhemv))
109EIGEN_BLAS_SYMV_SPECIALIZATION(scomplex, float, EIGEN_BLAS_SYM(chemv))
110#endif
111
112#undef EIGEN_BLAS_SYMV_SPECIALIZATION
113#undef EIGEN_BLAS_SYMV_SPECIALIZE
114} // end namespace internal
115
116} // end namespace Eigen
117
118#endif // EIGEN_SELFADJOINT_MATRIX_VECTOR_BLAS_H