summaryrefslogtreecommitdiffstats
path: root/src/armadillo/include/armadillo_bits/fn_var.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/armadillo/include/armadillo_bits/fn_var.hpp')
-rw-r--r--src/armadillo/include/armadillo_bits/fn_var.hpp143
1 files changed, 143 insertions, 0 deletions
diff --git a/src/armadillo/include/armadillo_bits/fn_var.hpp b/src/armadillo/include/armadillo_bits/fn_var.hpp
new file mode 100644
index 0000000..090f4ce
--- /dev/null
+++ b/src/armadillo/include/armadillo_bits/fn_var.hpp
@@ -0,0 +1,143 @@
+// 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_var
+//! @{
+
+
+
+template<typename T1>
+arma_warn_unused
+inline
+typename
+enable_if2
+ <
+ is_arma_type<T1>::value && resolves_to_vector<T1>::yes,
+ typename T1::pod_type
+ >::result
+var(const T1& X, const uword norm_type = 0)
+ {
+ arma_extra_debug_sigprint();
+
+ return op_var::var_vec(X, norm_type);
+ }
+
+
+
+template<typename T1>
+arma_warn_unused
+inline
+typename
+enable_if2
+ <
+ is_arma_type<T1>::value && resolves_to_vector<T1>::no,
+ const mtOp<typename T1::pod_type, T1, op_var>
+ >::result
+var(const T1& X, const uword norm_type = 0)
+ {
+ arma_extra_debug_sigprint();
+
+ return mtOp<typename T1::pod_type, T1, op_var>(X, norm_type, 0);
+ }
+
+
+
+template<typename T1>
+arma_warn_unused
+inline
+typename
+enable_if2
+ <
+ is_arma_type<T1>::value,
+ const mtOp<typename T1::pod_type, T1, op_var>
+ >::result
+var(const T1& X, const uword norm_type, const uword dim)
+ {
+ arma_extra_debug_sigprint();
+
+ return mtOp<typename T1::pod_type, T1, op_var>(X, norm_type, dim);
+ }
+
+
+
+template<typename T>
+arma_warn_unused
+inline
+typename arma_scalar_only<T>::result
+var(const T&)
+ {
+ return T(0);
+ }
+
+
+
+template<typename T1>
+arma_warn_unused
+inline
+typename
+enable_if2
+ <
+ is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::yes,
+ typename T1::pod_type
+ >::result
+var(const T1& X, const uword norm_type = 0)
+ {
+ arma_extra_debug_sigprint();
+
+ return spop_var::var_vec(X, norm_type);
+ }
+
+
+
+template<typename T1>
+arma_warn_unused
+inline
+typename
+enable_if2
+ <
+ is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::no,
+ const mtSpOp<typename T1::pod_type, T1, spop_var>
+ >::result
+var(const T1& X, const uword norm_type = 0)
+ {
+ arma_extra_debug_sigprint();
+
+ return mtSpOp<typename T1::pod_type, T1, spop_var>(X, norm_type, 0);
+ }
+
+
+
+template<typename T1>
+arma_warn_unused
+inline
+typename
+enable_if2
+ <
+ is_arma_sparse_type<T1>::value,
+ const mtSpOp<typename T1::pod_type, T1, spop_var>
+ >::result
+var(const T1& X, const uword norm_type, const uword dim)
+ {
+ arma_extra_debug_sigprint();
+
+ return mtSpOp<typename T1::pod_type, T1, spop_var>(X, norm_type, dim);
+ }
+
+
+
+//! @}