fn_sqrtmat.hpp 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. // Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
  2. // Copyright 2008-2016 National ICT Australia (NICTA)
  3. //
  4. // Licensed under the Apache License, Version 2.0 (the "License");
  5. // you may not use this file except in compliance with the License.
  6. // You may obtain a copy of the License at
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. // ------------------------------------------------------------------------
  15. //! \addtogroup fn_sqrtmat
  16. //! @{
  17. template<typename T1>
  18. arma_warn_unused
  19. arma_inline
  20. 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
  21. sqrtmat(const Base<typename T1::elem_type,T1>& X)
  22. {
  23. arma_extra_debug_sigprint();
  24. return mtOp<std::complex<typename T1::elem_type>, T1, op_sqrtmat>(X.get_ref());
  25. }
  26. template<typename T1>
  27. arma_warn_unused
  28. arma_inline
  29. 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
  30. sqrtmat(const Base<typename T1::elem_type,T1>& X)
  31. {
  32. arma_extra_debug_sigprint();
  33. return Op<T1, op_sqrtmat_cx>(X.get_ref());
  34. }
  35. template<typename T1>
  36. inline
  37. typename enable_if2< (is_supported_blas_type<typename T1::elem_type>::value && is_cx<typename T1::elem_type>::no), bool >::result
  38. sqrtmat(Mat< std::complex<typename T1::elem_type> >& Y, const Base<typename T1::elem_type,T1>& X)
  39. {
  40. arma_extra_debug_sigprint();
  41. const bool status = op_sqrtmat::apply_direct(Y, X.get_ref());
  42. if(status == false)
  43. {
  44. arma_debug_warn("sqrtmat(): given matrix seems singular; may not have a square root");
  45. }
  46. return status;
  47. }
  48. template<typename T1>
  49. inline
  50. typename enable_if2< (is_supported_blas_type<typename T1::elem_type>::value && is_cx<typename T1::elem_type>::yes), bool >::result
  51. sqrtmat(Mat<typename T1::elem_type>& Y, const Base<typename T1::elem_type,T1>& X)
  52. {
  53. arma_extra_debug_sigprint();
  54. const bool status = op_sqrtmat_cx::apply_direct(Y, X.get_ref());
  55. if(status == false)
  56. {
  57. arma_debug_warn("sqrtmat(): given matrix seems singular; may not have a square root");
  58. }
  59. return status;
  60. }
  61. //
  62. template<typename T1>
  63. arma_warn_unused
  64. arma_inline
  65. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, const Op<T1, op_sqrtmat_sympd> >::result
  66. sqrtmat_sympd(const Base<typename T1::elem_type,T1>& X)
  67. {
  68. arma_extra_debug_sigprint();
  69. return Op<T1, op_sqrtmat_sympd>(X.get_ref());
  70. }
  71. template<typename T1>
  72. inline
  73. typename enable_if2< is_supported_blas_type<typename T1::elem_type>::value, bool >::result
  74. sqrtmat_sympd(Mat<typename T1::elem_type>& Y, const Base<typename T1::elem_type,T1>& X)
  75. {
  76. arma_extra_debug_sigprint();
  77. const bool status = op_sqrtmat_sympd::apply_direct(Y, X.get_ref());
  78. if(status == false)
  79. {
  80. Y.soft_reset();
  81. arma_debug_warn("sqrtmat_sympd(): transformation failed");
  82. }
  83. return status;
  84. }
  85. //! @}