fn_var.hpp 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  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_var
  16. //! @{
  17. template<typename T1>
  18. arma_warn_unused
  19. inline
  20. typename
  21. enable_if2
  22. <
  23. is_arma_type<T1>::value && resolves_to_vector<T1>::yes,
  24. typename T1::pod_type
  25. >::result
  26. var(const T1& X, const uword norm_type = 0)
  27. {
  28. arma_extra_debug_sigprint();
  29. return op_var::var_vec(X, norm_type);
  30. }
  31. template<typename T1>
  32. arma_warn_unused
  33. inline
  34. typename
  35. enable_if2
  36. <
  37. is_arma_type<T1>::value && resolves_to_vector<T1>::no,
  38. const mtOp<typename T1::pod_type, T1, op_var>
  39. >::result
  40. var(const T1& X, const uword norm_type = 0)
  41. {
  42. arma_extra_debug_sigprint();
  43. return mtOp<typename T1::pod_type, T1, op_var>(X, norm_type, 0);
  44. }
  45. template<typename T1>
  46. arma_warn_unused
  47. inline
  48. typename
  49. enable_if2
  50. <
  51. is_arma_type<T1>::value,
  52. const mtOp<typename T1::pod_type, T1, op_var>
  53. >::result
  54. var(const T1& X, const uword norm_type, const uword dim)
  55. {
  56. arma_extra_debug_sigprint();
  57. return mtOp<typename T1::pod_type, T1, op_var>(X, norm_type, dim);
  58. }
  59. template<typename T>
  60. arma_warn_unused
  61. arma_inline
  62. typename arma_scalar_only<T>::result
  63. var(const T&)
  64. {
  65. return T(0);
  66. }
  67. template<typename T1>
  68. arma_warn_unused
  69. inline
  70. typename
  71. enable_if2
  72. <
  73. is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::yes,
  74. typename T1::pod_type
  75. >::result
  76. var(const T1& X, const uword norm_type = 0)
  77. {
  78. arma_extra_debug_sigprint();
  79. return spop_var::var_vec(X, norm_type);
  80. }
  81. template<typename T1>
  82. arma_warn_unused
  83. inline
  84. typename
  85. enable_if2
  86. <
  87. is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::no,
  88. const mtSpOp<typename T1::pod_type, T1, spop_var>
  89. >::result
  90. var(const T1& X, const uword norm_type = 0)
  91. {
  92. arma_extra_debug_sigprint();
  93. return mtSpOp<typename T1::pod_type, T1, spop_var>(X, norm_type, 0);
  94. }
  95. template<typename T1>
  96. arma_warn_unused
  97. inline
  98. typename
  99. enable_if2
  100. <
  101. is_arma_sparse_type<T1>::value,
  102. const mtSpOp<typename T1::pod_type, T1, spop_var>
  103. >::result
  104. var(const T1& X, const uword norm_type, const uword dim)
  105. {
  106. arma_extra_debug_sigprint();
  107. return mtSpOp<typename T1::pod_type, T1, spop_var>(X, norm_type, dim);
  108. }
  109. //! @}