Repository navigation
Expand file tree
/
Copy pathdip-DimensionArray-T.html
More file actions
1395 lines (1393 loc) · 100 KB
/
Copy pathdip-DimensionArray-T.html
File metadata and controls
1395 lines (1393 loc) · 100 KB
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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::DimensionArray class | DIPlib | a library for quantitative image analysis</title>
<link rel="stylesheet" href="m-dip+documentation.compiled.css" />
<link rel="icon" href="DIPlib_logo_32.png" type="image/png" />
<link rel="search" type="application/opensearchdescription+xml" href="opensearch.xml" title="Search DIPlib documentation" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#ffffff" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
<a href="https://diplib.org"><img src="DIPlib_logo.svg" alt="" />DIPlib</a><span class="m-breadcrumb">┃</span><a href="index.html" class="m-thin">a library for quantitative image analysis</a><span class="m-breadcrumb">┃</span><a href="https://github.com/DIPlib/diplib/releases/tag/3.6.1" class="m-thin">version 3.6.1</a> </span>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
</svg></a>
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="pages.html">Pages</a></li>
<li><a href="modules.html">Modules</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li><a href="classes.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<div class="m-doc-include m-thin m-right-m m-text-right">
<a href="supporttypes.html" class="m-doc">Support types</a> module<br/><span class="m-code m-thin">#include <a href="file--diplib-h.html">"diplib.h"</a></span> </div>
<div class="m-doc-template"><span class="m-doc-wrap-bumper">template<</span><span class="m-doc-wrap">typename T></span></div>
<span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span>DimensionArray <span class="m-thin">class</span> </h1>
<p>A dynamic array type optimized for few elements.</p>
<div class="m-index m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#typeless-methods">Constructors, destructors, assignment and conversion operators</a></li>
<li><a href="#alias-members">Aliases</a></li>
<li><a href="#function-members">Functions</a></li>
<li><a href="#operator-members">Operators</a></li>
<li><a href="#related">Related</a></li>
</ul>
</li>
</ul>
</div>
<p><code>dip::DimensionArray</code> is similar to <code>std::vector</code> but optimized for one particular
use within the <em>DIPlib</em> library: hold one element per image dimension. Most images have
only two or three dimensions, and for internal processing we might add the
tensor dimension to the mix, yielding up to four dimensions for most
applications. However, <em>DIPlib</em> does not limit image dimensionality, and we
need to be able to hold more than four dimensions if the user needs to do
so. We want the array holding the image dimensions to be as efficient in
use as a static array of size 4, but without the limitation of a static
array. So this version of <code>std::vector</code> has a static array of size 4, which
is used if that is sufficient, and also a pointer we can use if we need to
allocate space on the heap.</p>
<p>It also differs from std::vector in that it doesn’t grow or shrink
efficiently, don’t use this type when repeatedly using <code>push_back()</code> or
similar functionality. The <em>DIPlib</em> codebase uses dip::DimensionArray only
where the array holds one value per image dimension, or when more often
than not the array will have very few elements, and <code>std::vector</code> everywhere
else.</p>
<p>The interface tries to copy that of the STL containers, but only partially.
We do not include some of the <code>std::vector</code> functionality, and do include
some custom functionality useful for the specific application of the container.
We also have some custom algorithms such as dip::DimensionArray::sort() that
assumes the array is short.</p>
<p>This container can only be used with trivially copyable types (this means that
the destructor performs no action, and the object can be copied by copying its
bit pattern).</p>
<p>An array of size 0 has space for writing four values in it, <code>data()</code> won’t
return a <code>nullptr</code>, and nothing will break if you call front(). But don’t
do any of these things! The implementation could change. Plus, you’re just
being silly and making unreadable code.</p>
<section id="typeless-methods">
<h2>Constructors, destructors, assignment and conversion operators</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper"><a href="#dip-DimensionArray-T-DimensionArray" class="m-doc">DimensionArray</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>The default-initialized array has zero size.</dd>
<dt>
<span class="m-doc-wrap-bumper"><a href="#dip-DimensionArray-T-DimensionArray-size_type--T-" class="m-doc">DimensionArray</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> sz,
T newval = T()) <span class="m-label m-flat m-info">explicit</span> </span>
</dt>
<dd>Like <code>std::vector</code>, you can initialize with a size and a default value.</dd>
<dt>
<span class="m-doc-wrap-bumper"><a href="#dip-DimensionArray-T-DimensionArray-std-initializer_list%3CT%3E-C" class="m-doc">DimensionArray</a>(</span><span class="m-doc-wrap">std::initializer_list<T> const init)</span>
</dt>
<dd>Like <code>std::vector</code>, you can initialize with a set of values in braces.</dd>
<dt>
<span class="m-doc-wrap-bumper"><a href="#dip-DimensionArray-T-DimensionArray-DimensionArray%3CT%3E-CL" class="m-doc">DimensionArray</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other)</span>
</dt>
<dd>Copy constructor, initializes with a copy of <code>other</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper"><a href="#dip-DimensionArray-T-DimensionArray-DimensionArray%3CT%3E-R" class="m-doc">DimensionArray</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&& other) <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Move constructor, initializes by stealing the contents of <code>other</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%3D-DimensionArray%3CT%3E-CL" class="m-doc">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&</span>
</dt>
<dd>Copy assignment, copies over data from <code>other</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%3D-DimensionArray%3CT%3E-R" class="m-doc">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&& other) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Move assignment, steals the contents of <code>other</code>.</dd>
</dl>
</section>
<section id="alias-members">
<h2>Aliases</h2>
<dl class="m-doc">
<dt>
using <a href="#dip-DimensionArray-T-const_iterator" class="m-doc">const_iterator</a> = T const*
</dt>
<dd>Type of container’s const iterator</dd>
<dt>
using <a href="#dip-DimensionArray-T-const_reverse_iterator" class="m-doc">const_reverse_iterator</a> = std::reverse_iterator<const_iterator>
</dt>
<dd>Type of container’s const reverse iterator</dd>
<dt>
using <a href="#dip-DimensionArray-T-iterator" class="m-doc">iterator</a> = T*
</dt>
<dd>Type of container’s iterator</dd>
<dt>
using <a href="#dip-DimensionArray-T-reverse_iterator" class="m-doc">reverse_iterator</a> = std::reverse_iterator<iterator>
</dt>
<dd>Type of container’s reverse iterator</dd>
<dt>
using <a href="#dip-DimensionArray-T-size_type" class="m-doc">size_type</a> = std::size_t
</dt>
<dd>Type of index into container</dd>
<dt>
using <a href="#dip-DimensionArray-T-value_type" class="m-doc">value_type</a> = T
</dt>
<dd>Type of values stored in container</dd>
</dl>
</section>
<section id="function-members">
<h2>Functions</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-all-C" class="m-doc">all</a>(</span><span class="m-doc-wrap">) const -> bool</span>
</dt>
<dd>True if all elements are non-zero.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-any-C" class="m-doc">any</a>(</span><span class="m-doc-wrap">) const -> bool</span>
</dt>
<dd>True if one element is non-zero.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-append-DimensionArray%3CT%3E-CL" class="m-doc">append</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& values)</span>
</dt>
<dd>Adds all values in source array to the back.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-back" class="m-doc">back</a>(</span><span class="m-doc-wrap">) -> T&</span>
</dt>
<dd>Accesses the last element of the array</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-back-C" class="m-doc">back</a>(</span><span class="m-doc-wrap">) const -> T const&</span>
</dt>
<dd>Accesses the last element of the array</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-begin" class="m-doc">begin</a>(</span><span class="m-doc-wrap">) -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-iterator" class="m-doc">dip::DimensionArray::iterator</a></span>
</dt>
<dd>Returns an iterator to the beginning</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-begin-C" class="m-doc">begin</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_iterator" class="m-doc">dip::DimensionArray::const_iterator</a></span>
</dt>
<dd>Returns an iterator to the beginning</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-clear" class="m-doc">clear</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Clears the contents of the array, set its length to 0.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-count-C" class="m-doc">count</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a></span>
</dt>
<dd>Count of number of elements that are non-zero.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-data" class="m-doc">data</a>(</span><span class="m-doc-wrap">) -> T*</span>
</dt>
<dd>Returns a pointer to the underlying data</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-data-C" class="m-doc">data</a>(</span><span class="m-doc-wrap">) const -> T const*</span>
</dt>
<dd>Returns a pointer to the underlying data</dd>
<dt>
<div class="m-doc-template">template<typename O></div>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-DimensionArray%3CT%3E-T-DimensionArray%3CO%3E-CL" class="m-doc">DimensionArray<T></a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other)</span>
</dt>
<dd>Cast constructor, initializes with a copy of <code>other</code>.
Casting done as default in C++, not through <code>dip::clamp_cast</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-empty-C" class="m-doc">empty</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Checks whether the array is empty (size is 0).</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-end" class="m-doc">end</a>(</span><span class="m-doc-wrap">) -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-iterator" class="m-doc">dip::DimensionArray::iterator</a></span>
</dt>
<dd>Returns an iterator to the end</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-end-C" class="m-doc">end</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_iterator" class="m-doc">dip::DimensionArray::const_iterator</a></span>
</dt>
<dd>Returns an iterator to the end</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-erase-size_type-" class="m-doc">erase</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> index)</span>
</dt>
<dd>Removes the value at the given location, moving subsequent values forward by one.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-fill-T-CL" class="m-doc">fill</a>(</span><span class="m-doc-wrap">T const& value)</span>
</dt>
<dd>Assigns one same value to each element in the array</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-find-T--C" class="m-doc">find</a>(</span><span class="m-doc-wrap">T value) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a></span>
</dt>
<dd>Finds the first occurrence of <code>value</code> in the array, returns the index or <code>size()</code> if it is not present.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-front" class="m-doc">front</a>(</span><span class="m-doc-wrap">) -> T&</span>
</dt>
<dd>Accesses the first element of the array</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-front-C" class="m-doc">front</a>(</span><span class="m-doc-wrap">) const -> T const&</span>
</dt>
<dd>Accesses the first element of the array</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-insert-size_type--T-CL" class="m-doc">insert</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> index,
T const& value)</span>
</dt>
<dd>Adds a value at the given location, moving the current value at that
location and subsequent values forward by one.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-inverse_permute-DimensionArray%3Csize_type%3E-CL-C" class="m-doc">inverse_permute</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& order) const -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Inverse orders the elements in the array according to the <code>order</code> array, such as returned by <code>sorted_indices</code>. <a href="#dip-DimensionArray-T-inverse_permute-DimensionArray%3Csize_type%3E-CL-C">more...</a></dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-maximum-C" class="m-doc">maximum</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a></span>
</dt>
<dd>Find the maximum element in the array, returns the index or 0 if the array is empty.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-maximum_value-C" class="m-doc">maximum_value</a>(</span><span class="m-doc-wrap">) const -> T</span>
</dt>
<dd>Find the maximum element in the array, returns the value. The array must not be empty.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-maximum_value" class="m-doc">maximum_value</a>(</span><span class="m-doc-wrap">) -> T&</span>
</dt>
<dd>Find the maximum element in the array, returns the value. The array must not be empty.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-minimum-C" class="m-doc">minimum</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a></span>
</dt>
<dd>Find the minimum element in the array, returns the index or 0 if the array is empty.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-minimum_value-C" class="m-doc">minimum_value</a>(</span><span class="m-doc-wrap">) const -> T</span>
</dt>
<dd>Find the minimum element in the array, returns the value. The array must not be empty.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-minimum_value" class="m-doc">minimum_value</a>(</span><span class="m-doc-wrap">) -> T&</span>
</dt>
<dd>Find the minimum element in the array, returns the value. The array must not be empty.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-norm_square-C" class="m-doc">norm_square</a>(</span><span class="m-doc-wrap">) const -> double</span>
</dt>
<dd>Compute the sum of the squares of the elements in the array.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-permute-DimensionArray%3Csize_type%3E-CL-C" class="m-doc">permute</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& order) const -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Order the elements in the array according to the <code>order</code> array, such as returned by <code>sorted_indices</code>. <a href="#dip-DimensionArray-T-permute-DimensionArray%3Csize_type%3E-CL-C">more...</a></dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-pop_back" class="m-doc">pop_back</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Removes the value at the back.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-product-C" class="m-doc">product</a>(</span><span class="m-doc-wrap">) const -> T</span>
</dt>
<dd>Compute the product of the elements in the array. Returns 1 for an empty array.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-push_back-T-CL" class="m-doc">push_back</a>(</span><span class="m-doc-wrap">T const& value)</span>
</dt>
<dd>Adds a value to the back. Not efficient – prefer <code>std::vector</code> if you need
to use this repeatedly.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-rbegin" class="m-doc">rbegin</a>(</span><span class="m-doc-wrap">) -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-reverse_iterator" class="m-doc">dip::DimensionArray::reverse_iterator</a></span>
</dt>
<dd>Returns a reverse iterator to the beginning</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-rbegin-C" class="m-doc">rbegin</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_reverse_iterator" class="m-doc">dip::DimensionArray::const_reverse_iterator</a></span>
</dt>
<dd>Returns a reverse iterator to the beginning</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-rend" class="m-doc">rend</a>(</span><span class="m-doc-wrap">) -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-reverse_iterator" class="m-doc">dip::DimensionArray::reverse_iterator</a></span>
</dt>
<dd>Returns a reverse iterator to the end</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-rend-C" class="m-doc">rend</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_reverse_iterator" class="m-doc">dip::DimensionArray::const_reverse_iterator</a></span>
</dt>
<dd>Returns a reverse iterator to the end</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-resize-size_type--T-" class="m-doc">resize</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> newsz,
T newval = T())</span>
</dt>
<dd>Resizes the array, making it either larger or smaller. Initializes
new elements with <code>newval</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-reverse" class="m-doc">reverse</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Reverses the elements in the array, putting the first element at the end.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-size-C" class="m-doc">size</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Returns the size of the array.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-sort" class="m-doc">sort</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Sort the contents of the array from smallest to largest.</dd>
<dt>
<div class="m-doc-template">template<typename S></div>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-sort-T-DimensionArray%3CS%3E-L" class="m-doc">sort</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& other)</span>
</dt>
<dd>Sort the contents of the array from smallest to largest, and keeping <code>other</code> in the same order.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-sorted_indices-C" class="m-doc">sorted_indices</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Returns an array with indices into the array, sorted from smallest value to largest.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-sum-C" class="m-doc">sum</a>(</span><span class="m-doc-wrap">) const -> T</span>
</dt>
<dd>Compute the sum of the elements in the array.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-DimensionArray-T-swap-DimensionArray%3CT%3E-L" class="m-doc">swap</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& other) <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Swaps the contents of two arrays.</dd>
</dl>
</section>
<section id="operator-members">
<h2>Operators</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%2A%3D-T-CL" class="m-doc">operator*=</a>(</span><span class="m-doc-wrap">T const& v) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&</span>
</dt>
<dd>Multiplies each element in the array by a constant.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%2B%3D-T-CL" class="m-doc">operator+=</a>(</span><span class="m-doc-wrap">T const& v) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&</span>
</dt>
<dd>Adds a constant to each element in the array.</dd>
<dt>
<div class="m-doc-template">template<typename S></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%2B%3D-T-DimensionArray%3CS%3E-CL" class="m-doc">operator+=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&</span>
</dt>
<dd>Adds an array to <code>this</code>, element-wise. <code>other</code> must have the same number of elements.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator-%3D-T-CL" class="m-doc">operator-=</a>(</span><span class="m-doc-wrap">T const& v) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&</span>
</dt>
<dd>Subtracts a constant from each element in the array.</dd>
<dt>
<div class="m-doc-template">template<typename S></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator-%3D-T-DimensionArray%3CS%3E-CL" class="m-doc">operator-=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&</span>
</dt>
<dd>Subtracts an array from <code>this</code>, element-wise. <code>other</code> must have the same number of elements.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%2F%3D-T-CL" class="m-doc">operator/=</a>(</span><span class="m-doc-wrap">T const& v) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&</span>
</dt>
<dd>Divides each element in the array by a constant.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%5B%5D-size_type-" class="m-doc">operator[]</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> index) -> T&</span>
</dt>
<dd>Accesses an element of the array</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-DimensionArray-T-operator%5B%5D-size_type--C" class="m-doc">operator[]</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> index) const -> T const&</span>
</dt>
<dd>Accesses an element of the array</dd>
</dl>
</section>
<section id="related">
<h2>Related</h2>
<dl class="m-doc">
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Distance-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />Distance</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& v1,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& v2) -> double</span>
</dt>
<dd>Computes the Square Euclidean distance between two points.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%21%3D-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />operator!=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& rhs) -> bool</span>
</dt>
<dd>Compares two arrays, returns true if they have different size and/or contain different values.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%21%3D-T-DimensionArray%3CT%3E-CL-T-CL" class="m-doc">dip::<wbr />operator!=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
T const& rhs) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Compares an array to a scalar, returns a boolean array.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3C-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />operator<</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& rhs) -> bool</span>
</dt>
<dd>Compares two arrays, returns true only if they have the same size and all <code>lhs</code> elements are smaller
than all <code>rhs</code> elements.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3C-T-DimensionArray%3CT%3E-CL-T-CL" class="m-doc">dip::<wbr />operator<</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
T const& rhs) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Compares an array to a scalar, returns a boolean array.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3C%3C-T-std-ostream-L-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />operator<<</a>(</span><span class="m-doc-wrap">std::ostream& os,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& array) -> std::ostream&</span>
</dt>
<dd>Writes the array to a stream</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3C%3D-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />operator<=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& rhs) -> bool</span>
</dt>
<dd>Compares two arrays, returns true only if they have the same size and all <code>lhs</code> elements are smaller
or equal than all <code>rhs</code> elements.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3C%3D-T-DimensionArray%3CT%3E-CL-T-CL" class="m-doc">dip::<wbr />operator<=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
T const& rhs) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Compares an array to a scalar, returns a boolean array.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3D%3D-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />operator==</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& rhs) -> bool</span>
</dt>
<dd>Compares two arrays, returns true only if they have the same size and contain the same values.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3D%3D-T-DimensionArray%3CT%3E-CL-T-CL" class="m-doc">dip::<wbr />operator==</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
T const& rhs) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Compares an array to a scalar, returns a boolean array.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3E-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />operator></a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& rhs) -> bool</span>
</dt>
<dd>Compares two arrays, returns true only if they have the same size and all <code>lhs</code> elements are larger
than all <code>rhs</code> elements.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3E-T-DimensionArray%3CT%3E-CL-T-CL" class="m-doc">dip::<wbr />operator></a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
T const& rhs) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Compares an array to a scalar, returns a boolean array.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3E%3D-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />operator>=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& rhs) -> bool</span>
</dt>
<dd>Compares two arrays, returns true only if they have the same size and all <code>lhs</code> elements are larger
or equal than all <code>rhs</code> elements.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-operator%3E%3D-T-DimensionArray%3CT%3E-CL-T-CL" class="m-doc">dip::<wbr />operator>=</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& lhs,
T const& rhs) -> <a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a></span>
</dt>
<dd>Compares an array to a scalar, returns a boolean array.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">void <a href="#dip-sortIndices-T-DimensionArray%3Ctypename%20DimensionArray%3CT%3E-size_type%3E-L-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />sortIndices</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& indices,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& data)</span>
</dt>
<dd>Sorts the <code>indices</code> array with indices into the <code>data</code> array, from smallest to largest. The sort is stable.</dd>
<dt>
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-SquareDistance-T-DimensionArray%3CT%3E-CL-DimensionArray%3CT%3E-CL" class="m-doc">dip::<wbr />SquareDistance</a>(</span><span class="m-doc-wrap"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& v1,
<a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& v2) -> double</span>
</dt>
<dd>Computes the Square Euclidean distance between two points.</dd>
</dl>
</section>
<section>
<h2>Alias documentation</h2>
<section class="m-doc-details" id="dip-DimensionArray-T-value_type"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">using </span><span class="m-doc-name"><a href="#dip-DimensionArray-T-value_type" class="m-doc-self">value_type</a></span> = T </h3>
<p>Type of values stored in container</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-iterator"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">using </span><span class="m-doc-name"><a href="#dip-DimensionArray-T-iterator" class="m-doc-self">iterator</a></span> = T* </h3>
<p>Type of container’s iterator</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-const_iterator"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">using </span><span class="m-doc-name"><a href="#dip-DimensionArray-T-const_iterator" class="m-doc-self">const_iterator</a></span> = T const* </h3>
<p>Type of container’s const iterator</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-reverse_iterator"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">using </span><span class="m-doc-name"><a href="#dip-DimensionArray-T-reverse_iterator" class="m-doc-self">reverse_iterator</a></span> = std::reverse_iterator<iterator> </h3>
<p>Type of container’s reverse iterator</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-const_reverse_iterator"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">using </span><span class="m-doc-name"><a href="#dip-DimensionArray-T-const_reverse_iterator" class="m-doc-self">const_reverse_iterator</a></span> = std::reverse_iterator<const_iterator> </h3>
<p>Type of container’s const reverse iterator</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-size_type"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">using </span><span class="m-doc-name"><a href="#dip-DimensionArray-T-size_type" class="m-doc-self">size_type</a></span> = std::size_t </h3>
<p>Type of index into container</p>
</div></section>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="dip-DimensionArray-T-DimensionArray"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-DimensionArray" class="m-doc-self">DimensionArray</a></span>(
) </h3>
<p>The default-initialized array has zero size.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-DimensionArray-size_type--T-"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-DimensionArray-size_type--T-" class="m-doc-self">DimensionArray</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> sz, </span><span class="m-doc-arg">T newval = T()</span>) <span class="m-label m-info">explicit</span> </h3>
<p>Like <code>std::vector</code>, you can initialize with a size and a default value.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-DimensionArray-std-initializer_list%3CT%3E-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-DimensionArray-std-initializer_list%3CT%3E-C" class="m-doc-self">DimensionArray</a></span>(
<span class="m-doc-arg">std::initializer_list<T> const init</span>) </h3>
<p>Like <code>std::vector</code>, you can initialize with a set of values in braces.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-DimensionArray-DimensionArray%3CT%3E-CL"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-DimensionArray-DimensionArray%3CT%3E-CL" class="m-doc-self">DimensionArray</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other</span>) </h3>
<p>Copy constructor, initializes with a copy of <code>other</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-DimensionArray-DimensionArray%3CT%3E-R"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-DimensionArray-DimensionArray%3CT%3E-R" class="m-doc-self">DimensionArray</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&& other</span>) <span class="m-label m-success">noexcept</span> </h3>
<p>Move constructor, initializes by stealing the contents of <code>other</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-operator%3D-DimensionArray%3CT%3E-CL"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-operator%3D-DimensionArray%3CT%3E-CL" class="m-doc-self">operator=</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other</span>) </h3>
<p>Copy assignment, copies over data from <code>other</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-operator%3D-DimensionArray%3CT%3E-R"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-operator%3D-DimensionArray%3CT%3E-R" class="m-doc-self">operator=</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>&& other</span>) <span class="m-label m-success">noexcept</span> </h3>
<p>Move assignment, steals the contents of <code>other</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-DimensionArray%3CT%3E-T-DimensionArray%3CO%3E-CL"><div>
<h3>
<div class="m-doc-template">
template<typename T>
<br> template<typename O>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-DimensionArray%3CT%3E-T-DimensionArray%3CO%3E-CL" class="m-doc-self">DimensionArray<T></a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& other</span>) </h3>
<p>Cast constructor, initializes with a copy of <code>other</code>.
Casting done as default in C++, not through <code>dip::clamp_cast</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-swap-DimensionArray%3CT%3E-L"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-swap-DimensionArray%3CT%3E-L" class="m-doc-self">swap</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& other</span>) <span class="m-label m-success">noexcept</span> </h3>
<p>Swaps the contents of two arrays.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-resize-size_type--T-"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-resize-size_type--T-" class="m-doc-self">resize</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> newsz, </span><span class="m-doc-arg">T newval = T()</span>) </h3>
<p>Resizes the array, making it either larger or smaller. Initializes
new elements with <code>newval</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-clear"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-clear" class="m-doc-self">clear</a></span>(
) <span class="m-label m-success">noexcept</span> </h3>
<p>Clears the contents of the array, set its length to 0.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-empty-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">bool </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-empty-C" class="m-doc-self">empty</a></span>(
) const <span class="m-label m-success">noexcept</span> </h3>
<p>Checks whether the array is empty (size is 0).</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-size-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-size-C" class="m-doc-self">size</a></span>(
) const <span class="m-label m-success">noexcept</span> </h3>
<p>Returns the size of the array.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-front"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T& </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-front" class="m-doc-self">front</a></span>(
) </h3>
<p>Accesses the first element of the array</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-front-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T const& </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-front-C" class="m-doc-self">front</a></span>(
) const </h3>
<p>Accesses the first element of the array</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-back"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T& </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-back" class="m-doc-self">back</a></span>(
) </h3>
<p>Accesses the last element of the array</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-back-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T const& </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-back-C" class="m-doc-self">back</a></span>(
) const </h3>
<p>Accesses the last element of the array</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-data"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T* </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-data" class="m-doc-self">data</a></span>(
) </h3>
<p>Returns a pointer to the underlying data</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-data-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T const* </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-data-C" class="m-doc-self">data</a></span>(
) const </h3>
<p>Returns a pointer to the underlying data</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-begin"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-iterator" class="m-doc">dip::DimensionArray::iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-begin" class="m-doc-self">begin</a></span>(
) </h3>
<p>Returns an iterator to the beginning</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-begin-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_iterator" class="m-doc">dip::DimensionArray::const_iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-begin-C" class="m-doc-self">begin</a></span>(
) const </h3>
<p>Returns an iterator to the beginning</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-end"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-iterator" class="m-doc">dip::DimensionArray::iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-end" class="m-doc-self">end</a></span>(
) </h3>
<p>Returns an iterator to the end</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-end-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_iterator" class="m-doc">dip::DimensionArray::const_iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-end-C" class="m-doc-self">end</a></span>(
) const </h3>
<p>Returns an iterator to the end</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-rbegin"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-reverse_iterator" class="m-doc">dip::DimensionArray::reverse_iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-rbegin" class="m-doc-self">rbegin</a></span>(
) </h3>
<p>Returns a reverse iterator to the beginning</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-rbegin-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_reverse_iterator" class="m-doc">dip::DimensionArray::const_reverse_iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-rbegin-C" class="m-doc-self">rbegin</a></span>(
) const </h3>
<p>Returns a reverse iterator to the beginning</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-rend"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-reverse_iterator" class="m-doc">dip::DimensionArray::reverse_iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-rend" class="m-doc-self">rend</a></span>(
) </h3>
<p>Returns a reverse iterator to the end</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-rend-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-const_reverse_iterator" class="m-doc">dip::DimensionArray::const_reverse_iterator</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-rend-C" class="m-doc-self">rend</a></span>(
) const </h3>
<p>Returns a reverse iterator to the end</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-insert-size_type--T-CL"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-insert-size_type--T-CL" class="m-doc-self">insert</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> index, </span><span class="m-doc-arg">T const& value</span>) </h3>
<p>Adds a value at the given location, moving the current value at that
location and subsequent values forward by one.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-push_back-T-CL"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-push_back-T-CL" class="m-doc-self">push_back</a></span>(
<span class="m-doc-arg">T const& value</span>) </h3>
<p>Adds a value to the back. Not efficient – prefer <code>std::vector</code> if you need
to use this repeatedly.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-append-DimensionArray%3CT%3E-CL"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-append-DimensionArray%3CT%3E-CL" class="m-doc-self">append</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& values</span>) </h3>
<p>Adds all values in source array to the back.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-erase-size_type-"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-erase-size_type-" class="m-doc-self">erase</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> index</span>) </h3>
<p>Removes the value at the given location, moving subsequent values forward by one.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-pop_back"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-pop_back" class="m-doc-self">pop_back</a></span>(
) </h3>
<p>Removes the value at the back.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-sort"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-sort" class="m-doc-self">sort</a></span>(
) </h3>
<p>Sort the contents of the array from smallest to largest.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-sort-T-DimensionArray%3CS%3E-L"><div>
<h3>
<div class="m-doc-template">
template<typename T>
<br> template<typename S>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-sort-T-DimensionArray%3CS%3E-L" class="m-doc-self">sort</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a>& other</span>) </h3>
<p>Sort the contents of the array from smallest to largest, and keeping <code>other</code> in the same order.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-reverse"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-reverse" class="m-doc-self">reverse</a></span>(
) </h3>
<p>Reverses the elements in the array, putting the first element at the end.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-sorted_indices-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-sorted_indices-C" class="m-doc-self">sorted_indices</a></span>(
) const </h3>
<p>Returns an array with indices into the array, sorted from smallest value to largest.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-permute-DimensionArray%3Csize_type%3E-CL-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-permute-DimensionArray%3Csize_type%3E-CL-C" class="m-doc-self">permute</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& order</span>) const </h3>
<p>Order the elements in the array according to the <code>order</code> array, such as returned by <code>sorted_indices</code>.</p>
<p>Postcondition:</p>
<div class="m-code"><pre><span></span><span class="n">out</span><span class="p">[</span><span class="w"> </span><span class="n">ii</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="k">this</span><span class="p">)[</span><span class="w"> </span><span class="n">order</span><span class="p">[</span><span class="w"> </span><span class="n">ii</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">];</span>
</pre></div>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-inverse_permute-DimensionArray%3Csize_type%3E-CL-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-inverse_permute-DimensionArray%3Csize_type%3E-CL-C" class="m-doc-self">inverse_permute</a></span>(
<span class="m-doc-arg"><a href="dip-DimensionArray-T.html" class="m-doc">dip::DimensionArray</a> const& order</span>) const </h3>
<p>Inverse orders the elements in the array according to the <code>order</code> array, such as returned by <code>sorted_indices</code>.</p>
<p>Postcondition:</p>
<div class="m-code"><pre><span></span><span class="n">out</span><span class="p">[</span><span class="w"> </span><span class="n">order</span><span class="p">[</span><span class="w"> </span><span class="n">ii</span><span class="w"> </span><span class="p">]]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="k">this</span><span class="p">)[</span><span class="w"> </span><span class="n">ii</span><span class="w"> </span><span class="p">];</span>
</pre></div>
<p>Elements not indexed by <code>order</code> will be default-initialized.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-find-T--C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-find-T--C" class="m-doc-self">find</a></span>(
<span class="m-doc-arg">T value</span>) const </h3>
<p>Finds the first occurrence of <code>value</code> in the array, returns the index or <code>size()</code> if it is not present.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-sum-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-sum-C" class="m-doc-self">sum</a></span>(
) const </h3>
<p>Compute the sum of the elements in the array.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-product-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">T </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-product-C" class="m-doc-self">product</a></span>(
) const </h3>
<p>Compute the product of the elements in the array. Returns 1 for an empty array.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-norm_square-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return">double </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-norm_square-C" class="m-doc-self">norm_square</a></span>(
) const </h3>
<p>Compute the sum of the squares of the elements in the array.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-minimum-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> </span>
<span class="m-doc-name"><a href="#dip-DimensionArray-T-minimum-C" class="m-doc-self">minimum</a></span>(
) const </h3>
<p>Find the minimum element in the array, returns the index or 0 if the array is empty.</p>
</div></section>
<section class="m-doc-details" id="dip-DimensionArray-T-maximum-C"><div>
<h3>
<div class="m-doc-template">
template<typename T>
</div>
<span class="m-doc-return"><a href="dip-DimensionArray-T.html#dip-DimensionArray-T-size_type" class="m-doc">dip::DimensionArray::size_type</a> </span>