diff options
Diffstat (limited to 'src/armadillo/include/armadillo_bits/fn_normalise.hpp')
-rw-r--r-- | src/armadillo/include/armadillo_bits/fn_normalise.hpp | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/src/armadillo/include/armadillo_bits/fn_normalise.hpp b/src/armadillo/include/armadillo_bits/fn_normalise.hpp new file mode 100644 index 0000000..ae07430 --- /dev/null +++ b/src/armadillo/include/armadillo_bits/fn_normalise.hpp @@ -0,0 +1,116 @@ +// 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_normalise +//! @{ + + + +template<typename T1> +arma_warn_unused +inline +typename +enable_if2 + < + is_arma_type<T1>::value && resolves_to_vector<T1>::yes, + const Op<T1, op_normalise_vec> + >::result +normalise + ( + const T1& X, + const uword p = uword(2), + const arma_empty_class junk1 = arma_empty_class(), + const typename arma_real_or_cx_only<typename T1::elem_type>::result* junk2 = nullptr + ) + { + arma_extra_debug_sigprint(); + arma_ignore(junk1); + arma_ignore(junk2); + + return Op<T1, op_normalise_vec>(X, p, 0); + } + + + +template<typename T1> +arma_warn_unused +inline +typename +enable_if2 + < + is_arma_type<T1>::value && resolves_to_vector<T1>::no, + const Op<T1, op_normalise_mat> + >::result +normalise + ( + const T1& X, + const uword p = uword(2), + const uword dim = 0, + const typename arma_real_or_cx_only<typename T1::elem_type>::result* junk = nullptr + ) + { + arma_extra_debug_sigprint(); + arma_ignore(junk); + + return Op<T1, op_normalise_mat>(X, p, dim); + } + + + +template<typename T1> +arma_warn_unused +inline +const SpOp<T1, spop_normalise> +normalise + ( + const SpBase<typename T1::elem_type, T1>& expr, + const uword p = uword(2), + const uword dim = 0, + const typename arma_real_or_cx_only<typename T1::elem_type>::result* junk = nullptr + ) + { + arma_extra_debug_sigprint(); + arma_ignore(junk); + + return SpOp<T1, spop_normalise>(expr.get_ref(), p, dim); + } + + + +//! for compatibility purposes: allows compiling user code designed for earlier versions of Armadillo +template<typename T> +arma_warn_unused +arma_inline +typename +enable_if2 + < + is_supported_blas_type<T>::value, + Col<T> + >::result +normalise(const T& val) + { + Col<T> out(1, arma_nozeros_indicator()); + + out[0] = (val != T(0)) ? T(val / (std::abs)(val)) : T(val); + + return out; + } + + + +//! @} |