fn_cov.hpp 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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_cov
  16. //! @{
  17. template<typename T1>
  18. arma_warn_unused
  19. inline
  20. const Op<T1, op_cov>
  21. cov(const Base<typename T1::elem_type,T1>& X, const uword norm_type = 0)
  22. {
  23. arma_extra_debug_sigprint();
  24. arma_debug_check( (norm_type > 1), "cov(): parameter 'norm_type' must be 0 or 1" );
  25. return Op<T1, op_cov>(X.get_ref(), norm_type, 0);
  26. }
  27. template<typename T1, typename T2>
  28. arma_warn_unused
  29. inline
  30. const Glue<T1,T2,glue_cov>
  31. cov(const Base<typename T1::elem_type,T1>& A, const Base<typename T1::elem_type,T2>& B, const uword norm_type = 0)
  32. {
  33. arma_extra_debug_sigprint();
  34. arma_debug_check( (norm_type > 1), "cov(): parameter 'norm_type' must be 0 or 1" );
  35. return Glue<T1, T2, glue_cov>(A.get_ref(), B.get_ref(), norm_type);
  36. }
  37. //! @}