-
Notifications
You must be signed in to change notification settings - Fork 96
/
Copy pathtype_traits.html
908 lines (752 loc) · 80.6 KB
/
type_traits.html
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
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>Type Traits — matx documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'api/type_traits';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Example Applications" href="../examples/index.html" />
<link rel="prev" title="surf" href="viz/surf.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="../index.html">
<p class="title logo__title">matx documentation</p>
</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">MatX Documentation</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build.html">Build Integration</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../basics/index.html">Basics</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../basics/broadcast.html">Broadcasting</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/concepts.html">Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/creation.html">Creating Tensors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/datatype.html">Data Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/fusion.html">Operator Fusion</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/matlabpython.html">MatX For MATLAB/NumPy Users</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/nvtx.html">NVTX Profiling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/print.html">Printing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basics/tensor.html">Tensor Type</a></li>
</ul>
</li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2 has-children"><a class="reference internal" href="creation/index.html">Creating Operators and Tensors</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="creation/operators/index.html">Creation Operators</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/alternate.html">alternate</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/diag.html">diag</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/eye.html">eye</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/linspace.html">linspace</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/logspace.html">logspace</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/meshgrid.html">meshgrid</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/ones.html">ones</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/range.html">range</a></li>
<li class="toctree-l4"><a class="reference internal" href="creation/operators/zeros.html">zeros</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="creation/tensors/index.html">Tensor Creation</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="creation/tensors/make.html">Making Tensors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="manipulation/index.html">Manipulation Functions</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="manipulation/basic/index.html">Basic Manipulations</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="manipulation/basic/copy.html">copy</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/basic/if.html">IF</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/basic/ifelse.html">IFELSE</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/basic/slice.html">slice</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="manipulation/joinrepeat/index.html">Joining and Repeating</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="manipulation/joinrepeat/clone.html">clone</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/joinrepeat/concat.html">concat</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/joinrepeat/flatten.html">flatten</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/joinrepeat/lcollapse.html">lcollapse</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/joinrepeat/rcollapse.html">rcollapse</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/joinrepeat/repmat.html">repmat</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/joinrepeat/stack.html">stack</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="manipulation/rearranging/index.html">Rearranging</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/fliplr.html">fliplr</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/flipud.html">flipud</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/overlap.html">overlap</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/permute.html">permute</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/reshape.html">reshape</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/reverse.html">reverse</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/shift.html">shift</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/transpose.html">transpose</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/rearranging/transpose_matrix.html">transpose_matrix</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="manipulation/selecting/index.html">Selecting</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="manipulation/selecting/at.html">at</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/selecting/reduce.html">reduce</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/selecting/remap.html">remap</a></li>
<li class="toctree-l4"><a class="reference internal" href="manipulation/selecting/select.html">select</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="io/index.html">Input/Output</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-11"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="io/read_csv.html">read_csv</a></li>
<li class="toctree-l3"><a class="reference internal" href="io/read_mat.html">read_mat</a></li>
<li class="toctree-l3"><a class="reference internal" href="io/write_csv.html">write_csv</a></li>
<li class="toctree-l3"><a class="reference internal" href="io/write_mat.html">write_mat</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="math/index.html">Mathematical Functions</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-12"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/arithmetic/index.html">Arithmetic Operations</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-13"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/add.html">Addition (+)</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/div.html">Divide (/)</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/fmod.html">fmod</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/mod.html">Modulo (%)</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/mul.html">Multiply (*)</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/neg.html">Negate (-)</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/pow.html">pow</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/arithmetic/sub.html">Subtract (-)</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/complex/index.html">Complex Numbers</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/complex/angle.html">angle</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/complex/conj.html">conj</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/complex/hermitiant.html">hermitianT</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/complex/imag.html">imag</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/complex/norm.html">norm</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/complex/real.html">real</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/explog/index.html">Exponents and Logarithms</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/explog/exp.html">exp</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/explog/expj.html">expj</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/explog/log.html">log</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/explog/log10.html">log10</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/explog/log2.html">log2</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/extrema/index.html">Extrema Finding</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-16"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/extrema/max.html">max</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/extrema/min.html">min</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/extrema/rmax.html">rmax</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/extrema/rmin.html">rmin</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/misc/index.html">Miscellaneous</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-17"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/misc/abs.html">abs</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/misc/softmax.html">softmax</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/misc/sqrt.html">sqrt</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/round/index.html">Rounding</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-18"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/round/ceil.html">ceil</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/round/floor.html">floor</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/round/round.html">round</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/sumprod/index.html">Sums, Products, and Differences</a><input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-19"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/sumprod/cumsum.html">cumsum</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/sumprod/prod.html">prod</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/sumprod/sum.html">sum</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="math/trig/index.html">Trigonometric Functions</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-20"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="math/trig/acos.html">acos</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/acosh.html">acosh</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/asin.html">asin</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/asinh.html">asinh</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/atan.html">atan</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/atanh.html">atanh</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/cart2sph.html">cart2sph</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/cos.html">cos</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/cosh.html">cosh</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/sin.html">sin</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/sinh.html">sinh</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/sph2cart.html">sph2cart</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/tan.html">tan</a></li>
<li class="toctree-l4"><a class="reference internal" href="math/trig/tanh.html">tanh</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="linalg/index.html">Linear Algebra</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-21"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="linalg/decomp/index.html">Decompositions</a><input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-22"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="linalg/decomp/chol.html">chol</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/decomp/inverse.html">inv</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/decomp/lu.html">lu</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/decomp/qr.html">qr</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/decomp/svd.html">svd</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/decomp/svdbpi.html">svdbpi</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/decomp/svdpi.html">svdpi</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="linalg/eigenvalues/index.html">Eigenvalues and Eigenvectors</a><input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-23"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="linalg/eigenvalues/eig.html">eig</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="linalg/matvec/index.html">Matrix and Vector Products</a><input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-24"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="linalg/matvec/einsum.html">einsum</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/matvec/kron.html">kron</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/matvec/matmul.html">matmul</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/matvec/matvec.html">matvec</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="linalg/other/index.html">Other</a><input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-25"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="linalg/other/cgsolve.html">cgsolve</a></li>
<li class="toctree-l4"><a class="reference internal" href="linalg/other/trace.html">trace</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="stats/index.html">Statistics</a><input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-26"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="stats/avgvar/index.html">Averages and Variances</a><input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-27"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="stats/avgvar/mean.html">mean</a></li>
<li class="toctree-l4"><a class="reference internal" href="stats/avgvar/median.html">median</a></li>
<li class="toctree-l4"><a class="reference internal" href="stats/avgvar/stdd.html">stdd</a></li>
<li class="toctree-l4"><a class="reference internal" href="stats/avgvar/var.html">var</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="stats/corr/index.html">Correlating</a><input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-28"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="stats/corr/corr.html">corr</a></li>
<li class="toctree-l4"><a class="reference internal" href="stats/corr/cov.html">cov</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="stats/hist/index.html">Histograms</a><input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-29"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="stats/hist/hist.html">hist</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="stats/misc/index.html">Misc</a><input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-30"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="stats/misc/percentile.html">percentile</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="searchsort/index.html">Searching and Sorting</a><input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-31"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="searchsort/argmax.html">argmax</a></li>
<li class="toctree-l3"><a class="reference internal" href="searchsort/argmin.html">argmin</a></li>
<li class="toctree-l3"><a class="reference internal" href="searchsort/find.html">find</a></li>
<li class="toctree-l3"><a class="reference internal" href="searchsort/findidx.html">find_idx</a></li>
<li class="toctree-l3"><a class="reference internal" href="searchsort/sort.html">sort</a></li>
<li class="toctree-l3"><a class="reference internal" href="searchsort/unique.html">unique</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="logic/index.html">Logic Functions</a><input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-32"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="logic/bitwise/index.html">Bitwise Operations</a><input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-33"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="logic/bitwise/and.html">Bitwise AND (&)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/bitwise/or.html">Bitwise OR (|)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/bitwise/xor.html">Bitwise XOR (^)</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="logic/comparison/index.html">Comparison Operations</a><input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-34"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="logic/comparison/equal.html">Equal (==)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/comparison/gt.html">Greater than (>)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/comparison/gte.html">Greater than or equal (>=)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/comparison/isclose.html">isclose</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/comparison/lt.html">Less than (<)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/comparison/lte.html">Less than or equal (<=)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/comparison/neq.html">Not-equal (!=)</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="logic/logical/index.html">Logical Operations</a><input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-35"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="logic/logical/and.html">&& (AND)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/logical/not.html">! (NOT)</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/logical/or.html">|| (OR)</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="logic/truth/index.html">Truth Value Testing</a><input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-36"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="logic/truth/all.html">all</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/truth/allclose.html">allclose</a></li>
<li class="toctree-l4"><a class="reference internal" href="logic/truth/any.html">any</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="casting/index.html">Casting Operators</a><input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-37"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="casting/as_double.html">as_double</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_float.html">as_float</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_int16.html">as_int16</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_int32.html">as_int32</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_int8.html">as_int8</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_type.html">as_type</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_uint16.html">as_uint16</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_uint32.html">as_uint32</a></li>
<li class="toctree-l3"><a class="reference internal" href="casting/as_uint8.html">as_uint8</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="window/index.html">Windowing</a><input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-38"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="window/bartlett.html">bartlett</a></li>
<li class="toctree-l3"><a class="reference internal" href="window/blackman.html">blackman</a></li>
<li class="toctree-l3"><a class="reference internal" href="window/flattop.html">flattop</a></li>
<li class="toctree-l3"><a class="reference internal" href="window/hamming.html">hamming</a></li>
<li class="toctree-l3"><a class="reference internal" href="window/hanning.html">hanning</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="signalimage/index.html">Signal and Image Processing</a><input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-39"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="signalimage/convolution/index.html">Convolution</a><input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-40"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="signalimage/convolution/conv1d.html">conv1d</a></li>
<li class="toctree-l4"><a class="reference internal" href="signalimage/convolution/conv2d.html">conv2d</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="signalimage/filtering/index.html">Filtering</a><input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-41"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="signalimage/filtering/channelize_poly.html">channelize_poly</a></li>
<li class="toctree-l4"><a class="reference internal" href="signalimage/filtering/filter.html">filter</a></li>
<li class="toctree-l4"><a class="reference internal" href="signalimage/filtering/resample_poly.html">resample_poly</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="signalimage/general/index.html">General</a><input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-42"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="signalimage/general/chirp.html">chirp</a></li>
<li class="toctree-l4"><a class="reference internal" href="signalimage/general/downsample.html">downsample</a></li>
<li class="toctree-l4"><a class="reference internal" href="signalimage/general/pwelch.html">pwelch</a></li>
<li class="toctree-l4"><a class="reference internal" href="signalimage/general/upsample.html">upsample</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="signalimage/radar/index.html">Radar</a><input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-43"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="signalimage/radar/ambgfun.html">ambgfun</a></li>
<li class="toctree-l4"><a class="reference internal" href="signalimage/radar/mvdr.html">MVDR</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="polynomials/index.html">Polynomials</a><input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-44"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="polynomials/legendre.html">legendre</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="random/random.html">Random Number Generation</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="dft/index.html">Discrete Fourier Transform</a><input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-45"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="dft/dct/index.html">DCT Functions</a><input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-46"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="dft/dct/dct.html">dct</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="dft/fft/index.html">FFT Functions</a><input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-47"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="dft/fft/fft.html">fft</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/fft/fft2d.html">fft2</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/fft/ifft.html">ifft</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/fft/ifft2.html">ifft2</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/fft/r2c.html">r2c</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="dft/utility/index.html">Utility Functions</a><input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-48"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="dft/utility/fftfreq.html">fftfreq</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/utility/fftshift1d.html">fftshift1D</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/utility/fftshift2d.html">fftshift2D</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/utility/ifftshift1d.html">ifftshift1D</a></li>
<li class="toctree-l4"><a class="reference internal" href="dft/utility/ifftshift2d.html">ifftshift2D</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="viz/index.html">Visualization</a><input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-49"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="viz/bar.html">bar</a></li>
<li class="toctree-l3"><a class="reference internal" href="viz/contour.html">contour</a></li>
<li class="toctree-l3"><a class="reference internal" href="viz/line.html">line</a></li>
<li class="toctree-l3"><a class="reference internal" href="viz/scatter.html">scatter</a></li>
<li class="toctree-l3"><a class="reference internal" href="viz/surf.html">surf</a></li>
</ul>
</li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Type Traits</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../examples/index.html">Example Applications</a><input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-50"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../examples/fftconv.html">FFT Convolution</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../limitations.html">Limitations</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</label></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="../_sources/api/type_traits.rst" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.rst</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Type Traits</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article" role="main">
<section id="type-traits">
<h1>Type Traits<a class="headerlink" href="#type-traits" title="Permalink to this heading">#</a></h1>
<p>MatX type traits help advanced developers to make compile-time decisions about types. Most of these are used extensively
inside of MatX, and are not needed in most user applications.</p>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx14promote_half_tE">
<span id="_CPPv3I0EN4matx14promote_half_tE"></span><span id="_CPPv2I0EN4matx14promote_half_tE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a16912b2db83fd66d6cc6a8e45a38d5ee"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">promote_half_t</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">conditional_t</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx9is_half_vE" title="matx::is_half_v"><span class="n"><span class="pre">is_half_v</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx14promote_half_tE" title="matx::promote_half_t::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="o"><span class="pre">||</span></span><span class="w"> </span><span class="n"><span class="pre">is_matx_half_v</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx14promote_half_tE" title="matx::promote_half_t::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN4matx14promote_half_tE" title="matx::promote_half_t::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4I0EN4matx14promote_half_tE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Promote half precision floating point value to fp32, or leave untouched if not half. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to convert </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx12remove_cvrefE">
<span id="_CPPv3I0EN4matx12remove_cvrefE"></span><span id="_CPPv2I0EN4matx12remove_cvrefE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="structmatx_1_1remove__cvref"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">remove_cvref</span></span></span><a class="headerlink" href="#_CPPv4I0EN4matx12remove_cvrefE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Removes cv and reference qualifiers on a type. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to remove qualifiers </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx10is_matx_opEbv">
<span id="_CPPv3I0EN4matx10is_matx_opEv"></span><span id="_CPPv2I0EN4matx10is_matx_opEv"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a490d0a5c8da1927fb48c3e831b5fe29d"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_op</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN4matx10is_matx_opEbv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX operator. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx13is_executor_tEbv">
<span id="_CPPv3I0EN4matx13is_executor_tEv"></span><span id="_CPPv2I0EN4matx13is_executor_tEv"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a0ec0c05b2c1fb38d1858579a8f43385b"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_executor_t</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN4matx13is_executor_tEbv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX executor. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx16is_tensor_view_vE">
<span id="_CPPv3I0EN4matx16is_tensor_view_vE"></span><span id="_CPPv2I0EN4matx16is_tensor_view_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a943857369ab97c361c0bb60a86a21fbb"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_tensor_view_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_tensor_view</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN4matx12remove_cvrefE" title="matx::remove_cvref"><span class="n"><span class="pre">remove_cvref</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx16is_tensor_view_vE" title="matx::is_tensor_view_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx16is_tensor_view_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX tensor view type. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx19is_matx_reduction_vE">
<span id="_CPPv3I0EN4matx19is_matx_reduction_vE"></span><span id="_CPPv2I0EN4matx19is_matx_reduction_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a4dd4e79de6aebc36d8b95eb18c6027b8"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_reduction_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_matx_reduction_impl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx19is_matx_reduction_vE" title="matx::is_matx_reduction_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx19is_matx_reduction_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX reduction. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx25is_matx_index_reduction_vE">
<span id="_CPPv3I0EN4matx25is_matx_index_reduction_vE"></span><span id="_CPPv2I0EN4matx25is_matx_index_reduction_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a913ce698dcdd9352f628e809dc0a5649"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_index_reduction_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_matx_idx_reduction_impl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx25is_matx_index_reduction_vE" title="matx::is_matx_index_reduction_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx25is_matx_index_reduction_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX index reduction type. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx17is_cuda_complex_vE">
<span id="_CPPv3I0EN4matx17is_cuda_complex_vE"></span><span id="_CPPv2I0EN4matx17is_cuda_complex_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a6b10ed29e02713739cdeabcba7b17292"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_cuda_complex_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_cuda_complex</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">remove_cvref_t</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx17is_cuda_complex_vE" title="matx::is_cuda_complex_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx17is_cuda_complex_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a cuda::std::complex variant. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx12is_complex_vE">
<span id="_CPPv3I0EN4matx12is_complex_vE"></span><span id="_CPPv2I0EN4matx12is_complex_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1ae7ea9f8929824d2a32821e69a29a4031"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_complex_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_complex</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">remove_cvref_t</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx12is_complex_vE" title="matx::is_complex_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx12is_complex_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a complex type (any type supported) </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx17is_complex_half_vE">
<span id="_CPPv3I0EN4matx17is_complex_half_vE"></span><span id="_CPPv2I0EN4matx17is_complex_half_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a49402572db59c424356e3fbac243b6f4"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_complex_half_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_complex_half</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx17is_complex_half_vE" title="matx::is_complex_half_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx17is_complex_half_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX half precision wrapper (either matxFp16 or matxBf16) </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx10IsHalfTypeEbv">
<span id="_CPPv3I0EN4matx10IsHalfTypeEv"></span><span id="_CPPv2I0EN4matx10IsHalfTypeEv"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a5f483a363ca0c4f088f975f71e3ecd42"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">IsHalfType</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN4matx10IsHalfTypeEbv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Tests if a type is a half precision floating point. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>True if half precision floating point </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx9is_half_vE">
<span id="_CPPv3I0EN4matx9is_half_vE"></span><span id="_CPPv2I0EN4matx9is_half_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a23b5fdb292b5ea4cf0f85e5730c6df8e"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_half_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_half</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx9is_half_vE" title="matx::is_half_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx9is_half_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is half precision (either __half or __nv_bfloat16) </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx14is_matx_type_vE">
<span id="_CPPv3I0EN4matx14is_matx_type_vE"></span><span id="_CPPv2I0EN4matx14is_matx_type_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a2deb43f92e911de887627e71ee3a46c7"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_type_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_matx_type</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx14is_matx_type_vE" title="matx::is_matx_type_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx14is_matx_type_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX custom type (half precision wrappers) </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx15is_matx_shape_vE">
<span id="_CPPv3I0EN4matx15is_matx_shape_vE"></span><span id="_CPPv2I0EN4matx15is_matx_shape_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a6048d8d89b958e46dfd1a9575dab2769"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_shape_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_matx_shape</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN4matx12remove_cvrefE" title="matx::remove_cvref"><span class="n"><span class="pre">remove_cvref</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx15is_matx_shape_vE" title="matx::is_matx_shape_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx15is_matx_shape_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX shape type. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx17is_matx_storage_vE">
<span id="_CPPv3I0EN4matx17is_matx_storage_vE"></span><span id="_CPPv2I0EN4matx17is_matx_storage_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a2623b3f298a1a63989ab74d14efd6986"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_storage_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_matx_storage</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN4matx12remove_cvrefE" title="matx::remove_cvref"><span class="n"><span class="pre">remove_cvref</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx17is_matx_storage_vE" title="matx::is_matx_storage_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx17is_matx_storage_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX storage type. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx27is_matx_storage_container_vE">
<span id="_CPPv3I0EN4matx27is_matx_storage_container_vE"></span><span id="_CPPv2I0EN4matx27is_matx_storage_container_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a0efc9de102f9cbacf264874471988325"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_storage_container_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_matx_storage_container</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN4matx12remove_cvrefE" title="matx::remove_cvref"><span class="n"><span class="pre">remove_cvref</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx27is_matx_storage_container_vE" title="matx::is_matx_storage_container_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx27is_matx_storage_container_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX storage container. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4I0EN4matx20is_matx_descriptor_vE">
<span id="_CPPv3I0EN4matx20is_matx_descriptor_vE"></span><span id="_CPPv2I0EN4matx20is_matx_descriptor_vE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="namespacematx_1a9093fac363794bd38b7a3e5ef2b7f68f"></span><span class="k"><span class="pre">constexpr</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">matx</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">is_matx_descriptor_v</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_matx_descriptor</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN4matx12remove_cvrefE" title="matx::remove_cvref"><span class="n"><span class="pre">remove_cvref</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN4matx20is_matx_descriptor_vE" title="matx::is_matx_descriptor_v::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><a class="headerlink" href="#_CPPv4I0EN4matx20is_matx_descriptor_vE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Determine if a type is a MatX descriptor. </p>
<dl class="field-list simple">
<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>T</strong> – Type to test </p>
</dd>
</dl>
</dd></dl>
</section>
</article>
<footer class="bd-footer-article">
<div class="footer-article-items footer-article__inner">
<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="viz/surf.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">surf</p>
</div>
</a>
<a class="right-next"
href="../examples/index.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Example Applications</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div></div>
</div>
</footer>
</div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Nvidia
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2021, Nvidia.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>
<footer class="bd-footer">
</footer>
<style>
.wy-nav-content { max-width: 1600px; }
.wy-table-responsive table td, .wy-table-responsive table th {
white-space: normal;
}
</style>
</body>
</html>