1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
// 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);
out[0] = (val != T(0)) ? T(val / (std::abs)(val)) : T(val);
return out;
}
//! @}
|
