diff options
Diffstat (limited to 'src/armadillo/include/armadillo_bits/fn_sqrtmat.hpp')
-rw-r--r-- | src/armadillo/include/armadillo_bits/fn_sqrtmat.hpp | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/src/armadillo/include/armadillo_bits/fn_sqrtmat.hpp b/src/armadillo/include/armadillo_bits/fn_sqrtmat.hpp new file mode 100644 index 0000000..882aa15 --- /dev/null +++ b/src/armadillo/include/armadillo_bits/fn_sqrtmat.hpp @@ -0,0 +1,125 @@ +// 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 fn_sqrtmat +//! @{ + + + +template<typename T1> +arma_warn_unused +arma_inline +typename enable_if2< (is_supported_blas_type<typename T1::elem_type>::value && is_cx<typename T1::elem_type>::no), const mtOp<std::complex<typename T1::elem_type>, T1, op_sqrtmat> >::result +sqrtmat(const Base<typename T1::elem_type,T1>& X) + { + arma_extra_debug_sigprint(); + + return mtOp<std::complex<typename T1::elem_type>, T1, op_sqrtmat>(X.get_ref()); + } + + + +template<typename T1> +arma_warn_unused +arma_inline +typename enable_if2< (is_supported_blas_type<typename T1::elem_type>::value && is_cx<typename T1::elem_type>::yes), const Op<T1, op_sqrtmat_cx> >::result +sqrtmat(const Base<typename T1::elem_type,T1>& X) + { + arma_extra_debug_sigprint(); + + return Op<T1, op_sqrtmat_cx>(X.get_ref()); + } + + + +template<typename T1> +inline +typename enable_if2< (is_supported_blas_type<typename T1::elem_type>::value && is_cx<typename T1::elem_type>::no), bool >::result +sqrtmat(Mat< std::complex<typename T1::elem_type> >& Y, const Base<typename T1::elem_type,T1>& X) + { + arma_extra_debug_sigprint(); + + const bool status = op_sqrtmat::apply_direct(Y, X.get_ref()); + + if(status == false) + { + arma_debug_warn_level(3, "sqrtmat(): given matrix is singular; may not have a square root"); + } + + return status; + } + + + +template<typename T1> +inline +typename enable_if2< (is_supported_blas_type<typename T1::elem_type>::value && is_cx<typename T1::elem_type>::yes), bool >::result +sqrtmat(Mat<typename T1::elem_type>& Y, const Base<typename T1::elem_type,T1>& X) + { + arma_extra_debug_sigprint(); + + const bool status = op_sqrtmat_cx::apply_direct(Y, X.get_ref()); + + if(status == false) + { + arma_debug_warn_level(3, "sqrtmat(): given matrix is singular; may not have a square root"); + } + + return status; + } + + + +// + + + +template<typename T1> +arma_warn_unused +arma_inline +typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Op<T1, op_sqrtmat_sympd> >::result +sqrtmat_sympd(const Base<typename T1::elem_type,T1>& X) + { + arma_extra_debug_sigprint(); + + return Op<T1, op_sqrtmat_sympd>(X.get_ref()); + } + + + +template<typename T1> +inline +typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result +sqrtmat_sympd(Mat<typename T1::elem_type>& Y, const Base<typename T1::elem_type,T1>& X) + { + arma_extra_debug_sigprint(); + + const bool status = op_sqrtmat_sympd::apply_direct(Y, X.get_ref()); + + if(status == false) + { + Y.soft_reset(); + arma_debug_warn_level(3, "sqrtmat_sympd(): transformation failed"); + } + + return status; + } + + + +//! @} |