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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Norms</title>
<link rel="stylesheet" href="../math.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="Math Toolkit 4.2.1">
<link rel="up" href="../vector_functionals.html" title="Chapter 7. Vector Functionals - Norms">
<link rel="prev" href="../vector_functionals.html" title="Chapter 7. Vector Functionals - Norms">
<link rel="next" href="../special.html" title="Chapter 8. Special Functions">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../vector_functionals.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../vector_functionals.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../special.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="math_toolkit.norms"></a><a class="link" href="norms.html" title="Norms">Norms</a>
</h2></div></div></div>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
All of the functions below require at least C++17
</p></td></tr>
</table></div>
<h4>
<a name="math_toolkit.norms.h0"></a>
<span class="phrase"><a name="math_toolkit.norms.synopsis"></a></span><a class="link" href="norms.html#math_toolkit.norms.synopsis">Synopsis</a>
</h4>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">math</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">norms</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
<span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">math</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">tools</span> <span class="special">{</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l0_pseudo_norm</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l0_pseudo_norm</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="identifier">size_t</span> <span class="identifier">hamming_distance</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first2</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="identifier">size_t</span> <span class="identifier">hamming_distance</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">u</span><span class="special">,</span> <span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l1_norm</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l1_norm</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l1_distance</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v1</span><span class="special">,</span> <span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v2</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l1_distance</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first2</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l2_norm</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l2_norm</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l2_distance</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v1</span><span class="special">,</span> <span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v2</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">l2_distance</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first2</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">sup_norm</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">sup_norm</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">sup_distance</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v1</span><span class="special">,</span> <span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v2</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">sup_distance</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first2</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">lp_norm</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">p</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">lp_norm</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">p</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">lp_distance</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v1</span><span class="special">,</span> <span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v2</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">p</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">lp_distance</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last1</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">first2</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">p</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Container</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">total_variation</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">ForwardIterator</span><span class="special">></span>
<span class="keyword">auto</span> <span class="identifier">total_variation</span><span class="special">(</span><span class="identifier">ForwardIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="identifier">last</span><span class="special">);</span>
<span class="special">}}}</span>
</pre>
<h4>
<a name="math_toolkit.norms.h1"></a>
<span class="phrase"><a name="math_toolkit.norms.description"></a></span><a class="link" href="norms.html#math_toolkit.norms.description">Description</a>
</h4>
<p>
The file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">math</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">norms</span><span class="special">.</span><span class="identifier">hpp</span></code> is a set of facilities for computing
scalar values traditionally useful in numerical analysis from vectors.
</p>
<p>
Our examples use <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span></code> to
hold the data, but this not required. In general, you can store your data in
an Eigen array, an Armadillo vector, <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">array</span></code>,
and for many of the routines, a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">forward_list</span></code>.
These routines are usable in float, double, long double, and Boost.Multiprecision
precision, as well as their complex extensions whenever the computation is
well-defined. Integral datatypes are supported for most routines.
</p>
<h4>
<a name="math_toolkit.norms.h2"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_u221e_norm"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_u221e_norm">ℓ<sup>∞</sup> norm</a>
</h4>
<p>
Computes the supremum norm of a dataset:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{-</span><span class="number">3</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">sup</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">sup_norm</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">cbegin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">cend</span><span class="special">());</span>
<span class="comment">// sup = 3</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">complex</span><span class="special"><</span><span class="keyword">double</span><span class="special">>></span> <span class="identifier">v</span><span class="special">{{</span><span class="number">0</span><span class="special">,</span> <span class="special">-</span><span class="number">8</span><span class="special">},</span> <span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">},</span> <span class="special">{-</span><span class="number">3</span><span class="special">,</span><span class="number">2</span><span class="special">}};</span>
<span class="comment">// Range call:</span>
<span class="keyword">double</span> <span class="identifier">sup</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">sup_norm</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
<span class="comment">// sup = 8</span>
</pre>
<p>
Supports real, integral, and complex arithmetic. Container must be forward
iterable and is not modified.
</p>
<h4>
<a name="math_toolkit.norms.h3"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_u221e_distance"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_u221e_distance">ℓ<sup>∞</sup> distance</a>
</h4>
<p>
Computes the supremum norm distance between two vectors:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{-</span><span class="number">3</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">1</span><span class="special">};</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">w</span><span class="special">{</span><span class="number">6</span><span class="special">,</span> <span class="special">-</span><span class="number">2</span><span class="special">,</span> <span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">sup</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">sup_distance</span><span class="special">(</span><span class="identifier">w</span><span class="special">,</span> <span class="identifier">v</span><span class="special">);</span>
<span class="comment">// sup = 9</span>
</pre>
<p>
Supports real, integral, and complex arithmetic. Container must be forward
iterable and is not modified. If the input it integral, the output is a double
precision float.
</p>
<h4>
<a name="math_toolkit.norms.h4"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_p_norm"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_p_norm">ℓ<sup><span class="emphasis"><em>p</em></span></sup> norm</a>
</h4>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{-</span><span class="number">8</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">sup</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">lp_norm</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">cbegin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">cend</span><span class="special">(),</span> <span class="number">7</span><span class="special">);</span>
<span class="comment">// sup = 8</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">complex</span><span class="special"><</span><span class="keyword">double</span><span class="special">>></span> <span class="identifier">v</span><span class="special">{{</span><span class="number">1</span><span class="special">,</span> <span class="number">0</span><span class="special">},</span> <span class="special">{</span><span class="number">0</span><span class="special">,</span><span class="number">1</span><span class="special">},</span> <span class="special">{</span><span class="number">0</span><span class="special">,-</span><span class="number">1</span><span class="special">}};</span>
<span class="keyword">double</span> <span class="identifier">sup</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">lp_norm</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">cbegin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">cend</span><span class="special">(),</span> <span class="number">3</span><span class="special">);</span>
<span class="comment">// sup = cbrt(3)</span>
</pre>
<p>
Supports both real, integral, and complex arithmetic. If the input is integral,
the output is a double precision float. The container must be forward iterable
and the contents are not modified.
</p>
<p>
Only supports integral <span class="emphasis"><em>p</em></span> for two reasons: The computation
is much slower for real <span class="emphasis"><em>p</em></span>, and the non-integral ℓ<sup><span class="emphasis"><em>p</em></span></sup> norm
is rarely used.
</p>
<h4>
<a name="math_toolkit.norms.h5"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_p_distance"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_p_distance">ℓ<sup><span class="emphasis"><em>p</em></span></sup> distance</a>
</h4>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{-</span><span class="number">8</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">};</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">w</span><span class="special">{</span><span class="number">8</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">dist</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">lp_distance</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">w</span><span class="special">,</span> <span class="number">7</span><span class="special">);</span>
<span class="comment">// dist = 16</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">complex</span><span class="special"><</span><span class="keyword">double</span><span class="special">>></span> <span class="identifier">v</span><span class="special">{{</span><span class="number">1</span><span class="special">,</span> <span class="number">0</span><span class="special">},</span> <span class="special">{</span><span class="number">0</span><span class="special">,</span><span class="number">1</span><span class="special">},</span> <span class="special">{</span><span class="number">0</span><span class="special">,-</span><span class="number">1</span><span class="special">}};</span>
<span class="keyword">double</span> <span class="identifier">dist</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">lp_distance</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">v</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="comment">// dist = 0</span>
</pre>
<p>
Supports both real, integral, and complex arithmetic. If the input is integral,
the output is a double precision float. The container must be forward iterable
and the contents are not modified.
</p>
<p>
Only supports integer <span class="emphasis"><em>p</em></span>.
</p>
<h4>
<a name="math_toolkit.norms.h6"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_0_pseudo_norm"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_0_pseudo_norm">ℓ<sup>0</sup> pseudo-norm</a>
</h4>
<p>
Counts the number of non-zero elements in a container.
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">0</span><span class="special">,</span><span class="number">0</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="identifier">size_t</span> <span class="identifier">count</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">l0_pseudo_norm</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span>
<span class="comment">// count = 1</span>
</pre>
<p>
Supports real, integral, and complex numbers. The container must be forward
iterable and the contents are not modified. Note that this measure is not robust
against numerical noise and is therefore not as useful as (say) the Hoyer sparsity
in numerical applications. Works with real, complex, and integral inputs.
</p>
<h4>
<a name="math_toolkit.norms.h7"></a>
<span class="phrase"><a name="math_toolkit.norms.hamming_distance"></a></span><a class="link" href="norms.html#math_toolkit.norms.hamming_distance">Hamming
Distance</a>
</h4>
<p>
Compute the number of non-equal elements between two vectors <span class="emphasis"><em>w</em></span>
and <span class="emphasis"><em>v</em></span>:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">0</span><span class="special">,</span><span class="number">0</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">w</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">0</span><span class="special">,</span><span class="number">0</span><span class="special">};</span>
<span class="identifier">size_t</span> <span class="identifier">count</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">hamming_distance</span><span class="special">(</span><span class="identifier">w</span><span class="special">,</span> <span class="identifier">v</span><span class="special">);</span>
<span class="comment">// count = 2</span>
</pre>
<p>
Works for any datatype for which the operator <code class="computeroutput"><span class="special">!=</span></code>
is defined.
</p>
<h4>
<a name="math_toolkit.norms.h8"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_1_norm"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_1_norm">ℓ<sup>1</sup> norm</a>
</h4>
<p>
The ℓ<sup>1</sup> norm is a special case of the ℓ<sup><span class="emphasis"><em>p</em></span></sup> norm,
but is much faster:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">l1</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">l1_norm</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span>
<span class="comment">// l1 = 3</span>
</pre>
<p>
Requires a forward iterable input, does not modify input data, and works with
real, integral, and complex numbers.
</p>
<h4>
<a name="math_toolkit.norms.h9"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_1_distance"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_1_distance">ℓ<sup>1</sup> distance</a>
</h4>
<p>
Computes the ℓ<sup>1</sup> distance between two vectors:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">w</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">dist</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">l1_distance</span><span class="special">(</span><span class="identifier">w</span><span class="special">,</span> <span class="identifier">v</span><span class="special">);</span>
<span class="comment">// dist = 0</span>
</pre>
<p>
Requires a forward iterable inputs, does not modify input data, and works with
real, integral, and complex numbers. If the input type is integral, the output
is a double precision float.
</p>
<h4>
<a name="math_toolkit.norms.h10"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_2_norm"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_2_norm">ℓ<sup>2</sup> norm</a>
</h4>
<p>
The ℓ<sup>2</sup> norm is again a special case of the ℓ<sup><span class="emphasis"><em>p</em></span></sup> norm,
but is much faster:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">l2</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">l2_norm</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span>
<span class="comment">// l2 = sqrt(3)</span>
</pre>
<p>
Requires a forward iterable input, does not modify input data, and works with
real, complex and integral data. If the input is integral, the output is a
double precision float.
</p>
<h4>
<a name="math_toolkit.norms.h11"></a>
<span class="phrase"><a name="math_toolkit.norms.u2113_super_2_distance"></a></span><a class="link" href="norms.html#math_toolkit.norms.u2113_super_2_distance">ℓ<sup>2</sup> distance</a>
</h4>
<p>
Compute the ℓ<sup>2</sup> distance between two vectors <span class="emphasis"><em>w</em></span> and
<span class="emphasis"><em>v</em></span>:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">w</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">dist</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">l2_distance</span><span class="special">(</span><span class="identifier">w</span><span class="special">,</span> <span class="identifier">v</span><span class="special">);</span>
<span class="comment">// dist = 1</span>
</pre>
<p>
Requires a forward iterable input, does not modify input data, and works with
real, complex numbers, and integral data. If the input type is integral, the
output is a double precision float.
</p>
<h4>
<a name="math_toolkit.norms.h12"></a>
<span class="phrase"><a name="math_toolkit.norms.total_variation"></a></span><a class="link" href="norms.html#math_toolkit.norms.total_variation">Total
Variation</a>
</h4>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">tv</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">total_variation</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span>
<span class="comment">// no variation in v, so tv = 0.</span>
<span class="identifier">v</span> <span class="special">=</span> <span class="special">{</span><span class="number">0</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">tv</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">total_variation</span><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(),</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">end</span><span class="special">());</span>
<span class="comment">// variation is 1, so tv = 1.</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">v</span><span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">};</span>
<span class="keyword">double</span> <span class="identifier">tv</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">tools</span><span class="special">::</span><span class="identifier">total_variation</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
</pre>
<p>
The total variation only supports real numbers and integers. If the input is
integral, the output is a double precision float.
</p>
<p>
All the constituent operations to compute the total variation are well-defined
for complex numbers, but the computed result is not meaningful; a 2D total
variation is more appropriate. The container must be forward iterable, and
the contents are not modified.
</p>
<p>
As an aside, the total variation is not technically a norm, since <span class="emphasis"><em>TV(v)
= 0</em></span> does not imply <span class="emphasis"><em>v = 0</em></span>. However, it satisfies
the triangle inequality and is absolutely 1-homogeneous, so it is a seminorm,
and hence is grouped with the other norms here.
</p>
<h4>
<a name="math_toolkit.norms.h13"></a>
<span class="phrase"><a name="math_toolkit.norms.references"></a></span><a class="link" href="norms.html#math_toolkit.norms.references">References</a>
</h4>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
Higham, Nicholas J. <span class="emphasis"><em>Accuracy and stability of numerical algorithms.</em></span>
Vol. 80. Siam, 2002.
</li>
<li class="listitem">
Mallat, Stephane. <span class="emphasis"><em>A wavelet tour of signal processing: the sparse
way.</em></span> Academic press, 2008.
</li>
<li class="listitem">
Hurley, Niall, and Scott Rickard. <span class="emphasis"><em>Comparing measures of sparsity.</em></span>
IEEE Transactions on Information Theory 55.10 (2009): 4723-4741.
</li>
</ul></div>
</div>
<div class="copyright-footer">Copyright © 2006-2021 Nikhar Agrawal, Anton Bikineev, Matthew Borland,
Paul A. Bristow, Marco Guazzone, Christopher Kormanyos, Hubert Holin, Bruno
Lalande, John Maddock, Evan Miller, Jeremy Murphy, Matthew Pulver, Johan Råde,
Gautam Sewani, Benjamin Sobotta, Nicholas Thompson, Thijs van den Berg, Daryle
Walker and Xiaogang Zhang<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../vector_functionals.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../vector_functionals.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../special.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
