annotate libinterp/corefcn/mx-type-traits.h @ 33617:ec2635a02328 bytecode-interpreter tip

maint: Merge default to bytecode-interpreter.
author Markus Mützel <markus.muetzel@gmx.de>
date Tue, 21 May 2024 18:29:03 +0200
parents 3606817b9994
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 ////////////////////////////////////////////////////////////////////////
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 //
32632
2e484f9f1f18 maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31706
diff changeset
3 // Copyright (C) 2020-2024 The Octave Project Developers
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 //
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 // distribution or <https://octave.org/copyright/>.
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 //
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 // This file is part of Octave.
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 //
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 // under the terms of the GNU General Public License as published by
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 // (at your option) any later version.
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 //
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 // GNU General Public License for more details.
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 //
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 // You should have received a copy of the GNU General Public License
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 // along with Octave; see the file COPYING. If not, see
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22 // <https://www.gnu.org/licenses/>.
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23 //
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24 ////////////////////////////////////////////////////////////////////////
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 #if ! defined (octave_mx_type_traits_h)
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 #define octave_mx_type_traits_h 1
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 #include "octave-config.h"
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30
33344
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases
John W. Eaton <jwe@octave.org>
parents: 32633
diff changeset
31 #include <string>
3606817b9994 take adavantage of compiler warnings for unhandled enum switch cases
John W. Eaton <jwe@octave.org>
parents: 32633
diff changeset
32
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 #include "mxtypes.h"
30435
1f0a2689cab2 Use forward declarations for octave_int<T> where possible (bug #59820).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29359
diff changeset
34 #include "oct-inttypes-fwd.h"
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 template <typename T>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
37 class mx_type_traits
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 static const mxClassID mx_class;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 typedef T mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
45 class mx_type_traits<bool>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 static const mxClassID mx_class = mxLOGICAL_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 typedef mxDouble mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
53 class mx_type_traits<char>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 static const mxClassID mx_class = mxCHAR_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 typedef mxChar mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
61 class mx_type_traits<double>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 static const mxClassID mx_class = mxDOUBLE_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 typedef mxDouble mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
69 class mx_type_traits<float>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72 static const mxClassID mx_class = mxSINGLE_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 typedef mxSingle mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
75
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
77 class mx_type_traits<octave_int8>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 static const mxClassID mx_class = mxINT8_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81 typedef mxInt8 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
82 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
84 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
85 class mx_type_traits<octave_uint8>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
86 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
87 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
88 static const mxClassID mx_class = mxUINT8_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
89 typedef mxUint8 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
90 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
91
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
92 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
93 class mx_type_traits<octave_int16>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
94 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
96 static const mxClassID mx_class = mxINT16_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
97 typedef mxInt16 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
98 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
99
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
100 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
101 class mx_type_traits<octave_uint16>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
102 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
104 static const mxClassID mx_class = mxUINT16_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
105 typedef mxUint16 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
106 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
107
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
108 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
109 class mx_type_traits<octave_int32>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
110 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
111 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
112 static const mxClassID mx_class = mxINT32_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
113 typedef mxInt32 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
115
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
116 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
117 class mx_type_traits<octave_uint32>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
118 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
119 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
120 static const mxClassID mx_class = mxUINT32_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
121 typedef mxUint32 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
122 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
123
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
124 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
125 class mx_type_traits<octave_int64>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
126 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
127 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
128 static const mxClassID mx_class = mxINT64_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
129 typedef mxInt64 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
130 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
131
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
132 template <>
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31706
diff changeset
133 class mx_type_traits<octave_uint64>
28640
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
134 {
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
135 public:
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
136 static const mxClassID mx_class = mxUINT64_CLASS;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
137 typedef mxUint64 mx_type;
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
138 };
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
139
308cee7cf3ee octave -> mxArray type traits
John W. Eaton <jwe@octave.org>
parents:
diff changeset
140 #endif