From eda5bc26f44ee9a6f83dcf8c91f17296d7fc509d Mon Sep 17 00:00:00 2001 From: Nao Pross Date: Mon, 12 Feb 2024 14:52:43 +0100 Subject: Move into version control --- .../include/armadillo_bits/sp_auxlib_bones.hpp | 283 +++++++++++++++++++++ 1 file changed, 283 insertions(+) create mode 100644 src/armadillo/include/armadillo_bits/sp_auxlib_bones.hpp (limited to 'src/armadillo/include/armadillo_bits/sp_auxlib_bones.hpp') diff --git a/src/armadillo/include/armadillo_bits/sp_auxlib_bones.hpp b/src/armadillo/include/armadillo_bits/sp_auxlib_bones.hpp new file mode 100644 index 0000000..698265b --- /dev/null +++ b/src/armadillo/include/armadillo_bits/sp_auxlib_bones.hpp @@ -0,0 +1,283 @@ +// SPDX-License-Identifier: Apache-2.0 +// +// Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au) +// Copyright 2008-2016 National ICT Australia (NICTA) +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ------------------------------------------------------------------------ + + +//! \addtogroup sp_auxlib +//! @{ + + +//! wrapper for accesing external functions in ARPACK and SuperLU +class sp_auxlib + { + public: + + enum form_type + { + form_none, form_lm, form_sm, form_lr, form_la, form_sr, form_li, form_si, form_sa, form_sigma + }; + + inline static form_type interpret_form_str(const char* form_str); + + // + // eigs_sym() for real matrices + + template + inline static bool eigs_sym(Col& eigval, Mat& eigvec, const SpBase& X, const uword n_eigvals, const form_type form_val, const eigs_opts& opts); + + template + inline static bool eigs_sym(Col& eigval, Mat& eigvec, const SpBase& X, const uword n_eigvals, const eT sigma, const eigs_opts& opts); + + template + inline static bool eigs_sym_newarp(Col& eigval, Mat& eigvec, const SpMat& X, const uword n_eigvals, const form_type form_val, const eigs_opts& opts); + + template + inline static bool eigs_sym_newarp(Col& eigval, Mat& eigvec, const SpMat& X, const uword n_eigvals, const eT sigma, const eigs_opts& opts); + + template + inline static bool eigs_sym_arpack(Col& eigval, Mat& eigvec, const SpMat& X, const uword n_eigvals, const form_type form_val, const eT sigma, const eigs_opts& opts); + + // + // eigs_gen() for real matrices + + template + inline static bool eigs_gen(Col< std::complex >& eigval, Mat< std::complex >& eigvec, const SpBase& X, const uword n_eigvals, const form_type form_val, const eigs_opts& opts); + + template + inline static bool eigs_gen(Col< std::complex >& eigval, Mat< std::complex >& eigvec, const SpBase& X, const uword n_eigvals, const std::complex sigma, const eigs_opts& opts); + + template + inline static bool eigs_gen_newarp(Col< std::complex >& eigval, Mat< std::complex >& eigvec, const SpMat& X, const uword n_eigvals, const form_type form_val, const eigs_opts& opts); + + template + inline static bool eigs_gen_arpack(Col< std::complex >& eigval, Mat< std::complex >& eigvec, const SpMat& X, const uword n_eigvals, const form_type form_val, const std::complex sigma, const eigs_opts& opts); + + // + // eigs_gen() for complex matrices + + template + inline static bool eigs_gen(Col< std::complex >& eigval, Mat< std::complex >& eigvec, const SpBase< std::complex, T1>& X, const uword n_eigvals, const form_type form_val, const eigs_opts& opts); + + template + inline static bool eigs_gen(Col< std::complex >& eigval, Mat< std::complex >& eigvec, const SpBase< std::complex, T1>& X, const uword n_eigvals, const std::complex sigma, const eigs_opts& opts); + + template + inline static bool eigs_gen(Col< std::complex >& eigval, Mat< std::complex >& eigvec, const SpMat< std::complex >& X, const uword n_eigvals, const form_type form_val, const std::complex sigma, const eigs_opts& opts); + + // + // spsolve() via SuperLU + + template + inline static bool spsolve_simple(Mat& out, const SpBase& A, const Base& B, const superlu_opts& user_opts); + + template + inline static bool spsolve_refine(Mat& out, typename T1::pod_type& out_rcond, const SpBase& A, const Base& B, const superlu_opts& user_opts); + + // + // support functions + + #if defined(ARMA_USE_SUPERLU) + + template + inline static typename get_pod_type::result norm1(superlu::SuperMatrix* A); + + template + inline static typename get_pod_type::result lu_rcond(superlu::SuperMatrix* L, superlu::SuperMatrix* U, typename get_pod_type::result norm_val); + + inline static void set_superlu_opts(superlu::superlu_options_t& options, const superlu_opts& user_opts); + + template + inline static bool copy_to_supermatrix(superlu::SuperMatrix& out, const SpMat& A); + + template + inline static bool copy_to_supermatrix_with_shift(superlu::SuperMatrix& out, const SpMat& A, const eT shift); + + // // for debugging only + // template + // inline static void copy_to_spmat(SpMat& out, const superlu::SuperMatrix& A); + + template + inline static bool wrap_to_supermatrix(superlu::SuperMatrix& out, const Mat& A); + + inline static void destroy_supermatrix(superlu::SuperMatrix& out); + + #endif + + + + private: + + // calls arpack saupd()/naupd() because the code is so similar for each + // all of the extra variables are later used by seupd()/neupd(), but those + // functions are very different and we can't combine their code + + template + inline static void run_aupd_plain + ( + const uword n_eigvals, char* which, + const SpMat& X, const SpMat& Xst, const bool sym, + blas_int& n, eT& tol, blas_int& maxiter, + podarray& resid, blas_int& ncv, podarray& v, blas_int& ldv, + podarray& iparam, podarray& ipntr, + podarray& workd, podarray& workl, blas_int& lworkl, podarray& rwork, + blas_int& info + ); + + template + inline static void run_aupd_shiftinvert + ( + const uword n_eigvals, const T sigma, + const SpMat& X, const bool sym, + blas_int& n, eT& tol, blas_int& maxiter, + podarray& resid, blas_int& ncv, podarray& v, blas_int& ldv, + podarray& iparam, podarray& ipntr, + podarray& workd, podarray& workl, blas_int& lworkl, podarray& rwork, + blas_int& info + ); + + + template + inline static bool rudimentary_sym_check(const SpMat& X); + + template + inline static bool rudimentary_sym_check(const SpMat< std::complex >& X); + }; + + + +template +struct eigs_randu_filler + { + std::mt19937_64 local_engine; + std::uniform_real_distribution local_u_distr; + + inline eigs_randu_filler(); + + inline void fill(podarray& X, const uword N); + }; + + +template +struct eigs_randu_filler< std::complex > + { + std::mt19937_64 local_engine; + std::uniform_real_distribution local_u_distr; + + inline eigs_randu_filler(); + + inline void fill(podarray< std::complex >& X, const uword N); + }; + + + +#if defined(ARMA_USE_SUPERLU) + +class superlu_supermatrix_wrangler + { + private: + + bool used = false; + + arma_aligned superlu::SuperMatrix m; + + public: + + inline ~superlu_supermatrix_wrangler(); + inline superlu_supermatrix_wrangler(); + + inline superlu_supermatrix_wrangler(const superlu_supermatrix_wrangler&) = delete; + inline void operator= (const superlu_supermatrix_wrangler&) = delete; + + inline superlu::SuperMatrix& get_ref(); + inline superlu::SuperMatrix* get_ptr(); + }; + + +class superlu_stat_wrangler + { + private: + + arma_aligned superlu::SuperLUStat_t stat; + + public: + + inline ~superlu_stat_wrangler(); + inline superlu_stat_wrangler(); + + inline superlu_stat_wrangler(const superlu_stat_wrangler&) = delete; + inline void operator= (const superlu_stat_wrangler&) = delete; + + inline superlu::SuperLUStat_t* get_ptr(); + }; + + +template +class superlu_array_wrangler + { + private: + + arma_aligned eT* mem = nullptr; + + public: + + inline ~superlu_array_wrangler(); + inline superlu_array_wrangler(); + inline superlu_array_wrangler(const uword n_elem); + + inline void set_size(const uword n_elem); + inline void reset(); + + inline superlu_array_wrangler(const superlu_array_wrangler&) = delete; + inline void operator= (const superlu_array_wrangler&) = delete; + + inline eT* get_ptr(); + }; + + +template +class superlu_worker + { + private: + + bool factorisation_valid = false; + + superlu_supermatrix_wrangler* l = nullptr; + superlu_supermatrix_wrangler* u = nullptr; + + superlu_array_wrangler perm_c; + superlu_array_wrangler perm_r; + + superlu_stat_wrangler stat; + + public: + + inline ~superlu_worker(); + inline superlu_worker(); + + inline bool factorise(typename get_pod_type::result& out_rcond, const SpMat& A, const superlu_opts& user_opts); + + inline bool solve(Mat& X, const Mat& B); + + inline superlu_worker(const superlu_worker&) = delete; + inline void operator= (const superlu_worker&) = delete; + }; + +#endif + + + +//! @} + -- cgit v1.2.1