File: type_traits.rst

package info (click to toggle)
xsimd 13.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,716 kB
  • sloc: cpp: 36,557; sh: 541; makefile: 184; python: 117
file content (60 lines) | stat: -rw-r--r-- 1,908 bytes parent folder | download
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
.. Copyright (c) 2016, Johan Mabille, Sylvain Corlay 

   Distributed under the terms of the BSD 3-Clause License.

   The full license is in the file LICENSE, distributed with this software.

.. raw:: html

   <style>
   .rst-content table.docutils {
       width: 100%;
       table-layout: fixed;
   }

   table.docutils .line-block {
       margin-left: 0;
       margin-bottom: 0;
   }

   table.docutils code.literal {
       color: initial;
   }

   code.docutils {
       background: initial;
   }
   </style>

.. _Type Traits:

Type Traits
===========

`xsimd` provides a few type traits to interact with scalar and batch types in an
uniformeous manner.


Type check:

+---------------------------------------+----------------------------------------------------+
| :cpp:class:`is_batch`                 | batch type detection                               |
+---------------------------------------+----------------------------------------------------+
| :cpp:class:`is_batch_bool`            | mask batch type detection                          |
+---------------------------------------+----------------------------------------------------+
| :cpp:class:`is_batch_complex`         | complex batch type detection                       |
+---------------------------------------+----------------------------------------------------+

Type access:

+---------------------------------------+----------------------------------------------------+
| :cpp:class:`scalar_type`              | batch element type                                 |
+---------------------------------------+----------------------------------------------------+
| :cpp:class:`mask_type`                | batch mask type                                    |
+---------------------------------------+----------------------------------------------------+

----

.. doxygengroup:: batch_traits
   :project: xsimd
   :content-only: