/
Types.pm.PL
952 lines (734 loc) · 23.6 KB
/
Types.pm.PL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
use strict;
use Config;
use File::Basename qw(&basename &dirname);
my @TYPE_VERBATIM = qw/
realctype ppforcetype usenan real unsigned integer identifier
/;
# Figure out the 4 byte integer type on this machine
sub packtypeof_PDL_Indx {
if ($Config{'ivsize'} == 8) {
return 'q*';
}
elsif ($Config{'ivsize'} == 4 ) {
return 'l*';
}
else {
die "Types.pm.PL: packtype for ivsize==$Config{'ivsize'} not handled\n";
}
}
# Data types *must* be listed in order of complexity!!
# this is critical for type conversions!!!
#
my @types = (
{
identifier => 'SB',
onecharident => 'A', # only needed if different from identifier
pdlctype => 'PDL_SByte',# to be defined in pdl.h
realctype => 'signed char',
ppforcetype => 'sbyte', # for some types different from ctype
usenan => 0, # do we need NaN handling for this type?
packtype => 'c*', # the perl pack type
defaultbadval => 'SCHAR_MIN',
real=>1,
integer=>1,
unsigned=>0,
},
{
identifier => 'B',
pdlctype => 'PDL_Byte',# to be defined in pdl.h
realctype => 'unsigned char',
ppforcetype => 'byte', # for some types different from ctype
usenan => 0, # do we need NaN handling for this type?
packtype => 'C*', # the perl pack type
defaultbadval => 'UCHAR_MAX',
real=>1,
integer=>1,
unsigned=>1,
},
{
identifier => 'S',
pdlctype => 'PDL_Short',
realctype => 'short',
ppforcetype => 'short',
usenan => 0,
packtype => 's*',
defaultbadval => 'SHRT_MIN',
real=>1,
integer=>1,
unsigned=>0,
},
{
identifier => 'US',
onecharident => 'U', # only needed if different from identifier
pdlctype => 'PDL_Ushort',
realctype => 'unsigned short',
ppforcetype => 'ushort',
usenan => 0,
packtype => 'S*',
defaultbadval => 'USHRT_MAX',
real=>1,
integer=>1,
unsigned=>1,
},
{
identifier => 'L',
pdlctype => 'PDL_Long',
realctype => 'int32_t',
ppforcetype => 'int',
usenan => 0,
packtype => 'l*',
defaultbadval => 'INT32_MIN',
real=>1,
integer=>1,
unsigned=>0,
},
{
identifier => 'UL',
onecharident => 'K', # only needed if different from identifier
pdlctype => 'PDL_ULong',
realctype => 'uint32_t',
ppforcetype => 'uint',
usenan => 0,
packtype => 'L*',
defaultbadval => 'UINT32_MAX',
real=>1,
integer=>1,
unsigned=>1,
},
# The PDL_Indx type will be either the same as PDL_Long or, probably,
# the same as PDL_LongLong depending on the platform. Will need to
# determine the actual type at build time.
{
identifier => 'IND',
onecharident => 'N', # only needed if different from identifier
pdlctype => 'PDL_Indx',
realctype => 'ptrdiff_t',
ppforcetype => 'indx',
usenan => 0,
packtype => &packtypeof_PDL_Indx,
defaultbadval => 'PTRDIFF_MIN',
real=>1,
integer=>1,
unsigned=>0,
},
# note that the I/O routines have *not* been updated to be aware of
# such a type yet
{ # this one before LL so last integer is signed, to avoid default-type (last in list) changing to unsigned
identifier => 'ULL',
onecharident => 'P', # only needed if different from identifier
pdlctype => 'PDL_ULongLong',
realctype => 'uint64_t',
ppforcetype => 'ulonglong',
usenan => 0,
packtype => 'Q*',
defaultbadval => 'UINT64_MAX',
real=>1,
integer=>1,
unsigned=>1,
},
{
identifier => 'LL',
onecharident => 'Q', # only needed if different from identifier
pdlctype => 'PDL_LongLong',
realctype => 'int64_t',
ppforcetype => 'longlong',
usenan => 0,
packtype => 'q*',
defaultbadval => 'INT64_MIN',
real=>1,
integer=>1,
unsigned=>0,
},
# IMPORTANT:
# PDL_F *must* be the first non-integer type in this list
# as there are many places in the code (.c/.xs/.pm/.pd)
# with tests like this:
# if (ndarraytype < PDL_F) { ... }
{
identifier => 'F',
pdlctype => 'PDL_Float',
realctype => 'float',
ppforcetype => 'float',
usenan => 1,
packtype => 'f*',
defaultbadval => '-FLT_MAX',
real=>1,
complexversion=> 'G',
integer=>0,
unsigned=>0,
isnan=>'isnan(%1$s)',
isfinite=>'isfinite(%1$s)',
floatsuffix=>'f',
},
{
identifier => 'D',
pdlctype => 'PDL_Double',
realctype => 'double',
ppforcetype => 'double',
usenan => 1,
packtype => 'd*',
defaultbadval => '-DBL_MAX',
real=>1,
complexversion=> 'C',
integer=>0,
unsigned=>0,
isnan=>'isnan(%1$s)',
isfinite=>'isfinite(%1$s)',
floatsuffix=>'',
},
{
identifier => 'LD',
onecharident => 'E', # only needed if different from identifier
pdlctype => 'PDL_LDouble',
realctype => 'long double',
ppforcetype => 'ldouble',
usenan => 1,
packtype => 'D*',
defaultbadval => '-LDBL_MAX',
real=>1,
complexversion=> 'CLD',
integer=>0,
unsigned=>0,
isnan=>'isnan(%1$s)',
isfinite=>'isfinite(%1$s)',
floatsuffix=>'l',
},
# the complex types need to be in the same order as their real
# counterparts, because the "real" ppforcetype relies on a fixed interval
# between real and complex versions
# they also need to occur at the end of the types, as a < PDL_CF
# comparison is done at C level to see if a type is real, analogous to
# the < PDL_F above
{
identifier => 'CF',
onecharident => 'G', # only needed if different from identifier
pdlctype => 'PDL_CFloat',
realctype => 'complex float',
ppforcetype => 'cfloat',
usenan => 1,
packtype => '(ff)*',
defaultbadval => '(-FLT_MAX - I*FLT_MAX)',
real=>0,
realversion=>'F',
integer=>0,
unsigned=>0,
isnan=>'(isnan(crealf(%1$s)) || isnan(cimagf(%1$s)))',
isfinite=>'(isfinite(crealf(%1$s)) && isfinite(cimagf(%1$s)))',
floatsuffix=>'f',
},
{
identifier => 'CD',
onecharident => 'C', # only needed if different from identifier
pdlctype => 'PDL_CDouble',
realctype => 'complex double',
ppforcetype => 'cdouble',
usenan => 1,
packtype => '(dd)*',
defaultbadval => '(-DBL_MAX - I*DBL_MAX)',
real=>0,
realversion=>'D',
integer=>0,
unsigned=>0,
isnan=>'(isnan(creal(%1$s)) || isnan(cimag(%1$s)))',
isfinite=>'(isfinite(creal(%1$s)) && isfinite(cimag(%1$s)))',
floatsuffix=>'',
},
{
identifier => 'CLD',
onecharident => 'H', # only needed if different from identifier
pdlctype => 'PDL_CLDouble',
realctype => 'complex long double',
ppforcetype => 'cldouble',
usenan => 1,
packtype => '(DD)*',
defaultbadval => '(-LDBL_MAX - I*LDBL_MAX)',
real=>0,
realversion=>'LD',
integer=>0,
unsigned=>0,
isnan=>'(isnan(creall(%1$s)) || isnan(cimagl(%1$s)))',
isfinite=>'(isfinite(creall(%1$s)) && isfinite(cimagl(%1$s)))',
floatsuffix=>'l',
},
);
sub checktypehas {
my ($key,@types) = @_;
for my $type (@types) {
die "type is not a HASH ref" unless ref $type eq 'HASH';
die "type hash doesn't have a key '$key'" unless exists $type->{$key};
}
}
sub gentypevars {
my @types = @_;
checktypehas 'identifier', @types;
my @ret = map {"\$PDL_$_->{identifier}"} @types;
return wantarray ? @ret : $ret[0];
}
sub genexports {
my @types = @_;
return join ' ', gentypevars @types;
}
sub gentypenames {
my @types = @_;
checktypehas 'identifier', @types;
my @ret = map {"PDL_$_->{identifier}"} @types;
return wantarray ? @ret : $ret[0];
}
sub genpacktypes {
my @types = @_;
checktypehas 'packtype', @types;
my @ret = map {"$_->{packtype}"} @types;
return wantarray ? @ret : $ret[0];
}
sub convertfunc {
my ($type) = @_;
return $type->{'convertfunc'} if exists $type->{'convertfunc'};
checktypehas 'pdlctype', $type;
my $cfunc = $type->{pdlctype};
$cfunc =~ s/PDL_//;
return lc $cfunc;
}
sub gentypehashentry ($$) {
my ($type,$num) = @_;
checktypehas $_, $type
for qw/pdlctype defaultbadval/, @TYPE_VERBATIM;
my $convertfunc = convertfunc($type);
(my $shortctype = $type->{pdlctype}) =~ s/PDL_//;
my $ppsym = $type->{onecharident} || $type->{identifier};
+{
ctype => $type->{pdlctype},
ppsym => $ppsym,
convertfunc => $convertfunc,
sym => &gentypenames($type),
numval => $num,
ioname => $convertfunc,
defbval => $type->{defaultbadval},
shortctype => $shortctype,
realversion => $type->{realversion} || $ppsym,
complexversion => $type->{complexversion} || (!$type->{real} ? $ppsym : 'G'),
(map +($_ => $type->{$_}), @TYPE_VERBATIM, qw(isnan isfinite floatsuffix)),
};
}
sub gentypehashcode {
my @types = @_;
use Data::Dumper;
local $Data::Dumper::Terse = 1;
local $Data::Dumper::Indent = 1;
local $Data::Dumper::Sortkeys = 1;
local $Data::Dumper::Pad = "\t\t";
my $i = 0;
my $perlcode = '';
$perlcode .= "our %typehash = (\n";
for my $type (@types) {
$perlcode .= "\t".gentypenames($type)." =>\n";
$perlcode .= Data::Dumper::Dumper(gentypehashentry($type, $i++));
$perlcode .= "\t\t,\n";
}
$perlcode .= "); # end typehash definition\n";
return $perlcode;
}
# List explicitly here the variables you want Configure to
# generate. Metaconfig only looks for shell variables, so you
# have to mention them as if they were shell variables, not
# %Config entries. Thus you write
# $startperl
# to ensure Configure will look for $Config{startperl}.
# This forces PL files to create target in same directory as PL file.
# This is so that make depend always knows where to find PL derivatives.
chdir(dirname($0));
my $file;
($file = basename($0)) =~ s/\.PL$//;
$file =~ s/\.pl$//
if ($Config{'osname'} eq 'VMS' or
$Config{'osname'} eq 'OS2'); # "case-forgiving"
open OUT,">$file" or die "Can't create $file: $!";
print "Extracting $file\n";
chmod 0644, $file;
# in the following we generate the type dependent
# parts of Types.pm
# all the required info is extracted from the @types
# array defined above
# the guts how this is done is encapsulated in the subroutines
# that follow the definition of @types
# set up some variables that we will use below
my $typeexports = genexports @types;
my $ntypesm1 = @types - 1; # number of types - 1
my $typevars = join ', ',gentypevars @types;
my $packtypes = join ' ', genpacktypes @types;
my $typenames = join ' ', gentypenames @types;
print OUT sprintf qq{#line %d "%s"\n}, __LINE__ + 2, 'Basic/Core/Types.pm.PL';
print OUT <<'!NO!SUBS!';
### Generated from Types.pm.PL automatically - do not modify! ###
package PDL::Types;
use strict;
use warnings;
require Exporter;
use Carp;
!NO!SUBS!
print OUT qq{
our \@EXPORT = qw( $typeexports
\@pack \%typehash );
};
print OUT <<'!NO!SUBS!';
our @EXPORT_OK = (@EXPORT,
qw/types typesrtkeys mapfld typefld
ppdefs ppdefs_complex ppdefs_all
/
);
our %EXPORT_TAGS = (
All=>[@EXPORT,@EXPORT_OK],
);
our @ISA = qw( Exporter );
!NO!SUBS!
print OUT qq{
# Data types/sizes (bytes) [must be in order of complexity]
# Enum
our ( $typevars ) = (0..$ntypesm1);
# Corresponding pack types
our \@pack= qw/$packtypes/;
our \@names= qw/$typenames/;
};
# generate the typehash output
print OUT gentypehashcode @types;
print OUT <<'!NO!SUBS!';
# Cross-reference by common names
my @HASHES = sort {$a->{numval} <=> $b->{numval}} values %typehash;
my @RTKEYS = map $_->{sym}, @HASHES;
our %typenames;
for my $h (@HASHES) {
my $n = $h->{numval};
$typenames{$_} = $n for $n, @$h{qw(sym ioname ctype ppforcetype ppsym identifier)};
}
=head1 NAME
PDL::Types - define fundamental PDL Datatypes
=head1 SYNOPSIS
use PDL::Types;
$pdl = ushort( 2.0, 3.0 );
print "The actual c type used to store ushort's is '" .
$pdl->type->realctype() . "'\n";
The actual c type used to store ushort's is 'unsigned short'
=head1 DESCRIPTION
Internal module - holds all the PDL Type info. The type info can be
accessed easily using the C<PDL::Type> object returned by
the L<type|PDL::Core/type> method as shown in the synopsis.
Skip to the end of this document to find out how to change
the set of types supported by PDL.
=head1 FUNCTIONS
A number of functions are available for module writers
to get/process type information. These are used in various
places (e.g. C<PDL::PP>, C<PDL::Core>) to generate the
appropriate type loops, etc.
=head2 typesrtkeys
=for ref
Returns an array of keys of typehash sorted in order of type complexity
=for example
pdl> @typelist = PDL::Types::typesrtkeys;
pdl> print @typelist;
PDL_B PDL_S PDL_US PDL_L PDL_IND PDL_LL PDL_F PDL_D
=cut
sub typesrtkeys { @RTKEYS }
=head2 ppdefs
=for ref
Returns an array of pp symbols for all real types. This informs the
default C<GenericTypes> for C<pp_def> functions, making support for
complex types require an "opt-in".
=for example
pdl> print PDL::Types::ppdefs
B S U L N Q F D
=cut
my @PPDEFS = map $_->{ppsym}, grep $_->{real}, @HASHES;
sub ppdefs { @PPDEFS }
=head2 ppdefs_complex
=for ref
Returns an array of pp symbols for all complex types.
=for example
pdl> print PDL::Types::ppdefs_complex
G C
=cut
my @PPDEFS_CPLX = map $_->{ppsym}, grep !$_->{real}, @HASHES;
sub ppdefs_complex { @PPDEFS_CPLX }
=head2 ppdefs_all
=for ref
Returns an array of pp symbols for all types including complex.
=for example
pdl> print PDL::Types::ppdefs_all
B S U L N Q F D G C
=cut
my @PPDEFS_ALL = map $_->{ppsym}, @HASHES;
sub ppdefs_all { @PPDEFS_ALL }
sub typefld {
my ($type,$fld) = @_;
croak "unknown type $type" unless exists $typehash{$type};
croak "unknown field $fld in type $type"
unless exists $typehash{$type}->{$fld};
return $typehash{$type}->{$fld};
}
sub mapfld {
my ($type,$src,$trg) = @_;
my @keys = grep {$typehash{$_}->{$src} eq $type} typesrtkeys;
return @keys > 0 ? $typehash{$keys[0]}->{$trg} : undef;
}
=head2 typesynonyms
=for ref
return type related synonym definitions to be included in pdl.h .
This routine must be updated to include new types as required.
Mostly the automatic updating should take care of the vital
things.
=cut
sub typesynonyms {
my $add = join "\n",
map {"#define PDL_".typefld($_,'ppsym')." ".typefld($_,'sym')}
grep {"PDL_".typefld($_,'ppsym') ne typefld($_,'sym')} typesrtkeys;
return "$add\n";
}
=head1 PDL TYPES OVERVIEW
As of 2.065, PDL supports these types:
=over
=item SByte
Signed 8-bit value.
=item Byte
Unsigned 8-bit value.
=item Short
Signed 16-bit value.
=item UShort
Unsigned 16-bit value.
=item Long
Signed 32-bit value.
=item ULong
Unsigned 32-bit value.
=item Indx
Signed value, same size as a pointer on the system in use.
=item LongLong
Signed 64-bit value.
=item ULongLong
Unsigned 64-bit value.
=item Float
L<IEEE 754|https://en.wikipedia.org/wiki/IEEE_754> single-precision real
floating-point value.
=item Double
IEEE 754 double-precision real value.
=item LDouble
A C99 "long double", defined as "at least as precise as a double",
but often more precise.
=item CFloat
A C99 complex single-precision floating-point value.
=item CDouble
A C99 complex double-precision floating-point value.
=item CLDouble
A C99 complex "long double" - see above for description.
=back
=head1 PDL::Type OBJECTS
This module declares one class - C<PDL::Type> - objects of this class
are returned by the L<type|PDL::Core/type> method of an ndarray. It has
several methods, listed below, which provide an easy way to access
type information:
Additionally, comparison and stringification are overloaded so that
you can compare and print type objects, e.g.
$nofloat = 1 if $pdl->type < float;
die "must be double" if $type != double;
For further examples check again the
L<type|PDL::Core/type> method.
=over 4
=item enum
Returns the number representing this datatype (see L<get_datatype|PDL::Core/PDL::get_datatype>).
=item symbol
Returns one of 'PDL_B', 'PDL_S', 'PDL_US', 'PDL_L', 'PDL_IND', 'PDL_LL',
'PDL_F' or 'PDL_D'.
=item ctype
Returns the macro used to represent this type in C code (eg 'PDL_Long').
=item ppsym
The letter used to represent this type in PP code (eg 'U' for L<ushort|PDL::Core/ushort>).
=item realctype
The actual C type used to store this type.
=item shortctype
The value returned by C<ctype> without the 'PDL_' prefix.
=item badvalue
The special numerical value used to represent bad values for this type.
See L<PDL::Bad/badvalue> for more details.
=item isnan
Given a string representing a C value, will return a C expression for
this type that indicates whether that value is NaN (for complex values,
if I<either> is NaN).
=item isfinite
Given a string representing a C value, will return a C expression for
this type that indicates whether that value is finite (for complex values,
if I<both> are finite).
=item floatsuffix
The string appended to floating-point functions for this floating-point
type. Dies if called on non-floating-point type.
=item orig_badvalue
The default special numerical value used to represent bad values for this
type. (You can change the value that represents bad values for each type
during runtime.) See the
L<orig_badvalue routine in PDL::Bad|PDL::Bad/orig_badvalue> for more details.
=item bswap
Returns the appropriate C<bswap*> from L<PDL::IO::Misc> for the size of
this type, including a no-op for types of size 1. Note this means a
one-line construction means you must call the return value:
$pdl->type->bswap->($pdl);
=back
=cut
my @CACHED_TYPES = map bless([$_->{numval}, $_], 'PDL::Type'), @HASHES;
# return all known types as type objects
sub types { @CACHED_TYPES }
{
package PDL::Type;
use Carp;
sub new {
my ($type,$val) = @_;
return $val if "PDL::Type" eq ref $val;
if(ref $val and $val->isa('PDL')) {
PDL::Core::barf("Can't make a type out of non-scalar ndarray $val!")
if $val->getndims != 0;
$val = $val->at;
}
confess "Can't make a type out of non-scalar $val (".
(ref $val).")!" if ref $val;
confess "Unknown type string '$val' (should be one of ".
join(",",map $PDL::Types::typehash{$_}->{ioname}, @names).
")\n"
if !defined $PDL::Types::typenames{$val};
$CACHED_TYPES[$PDL::Types::typenames{$val}];
}
sub enum { $_[0][0] }
*symbol = \&sym;
sub realversion {
$CACHED_TYPES[$PDL::Types::typenames{ $_[0][1]{realversion} }];
}
sub complexversion {
$CACHED_TYPES[$PDL::Types::typenames{ $_[0][1]{complexversion} }];
}
sub isnan { sprintf $_[0][1]{isnan}, $_[1] }
sub isfinite { sprintf $_[0][1]{isfinite}, $_[1] }
sub floatsuffix { $_[0][1]{floatsuffix} // 'floatsuffix called on non-float type' }
my %bswap_cache;
sub bswap {
PDL::Core::barf('Usage: $type->bswap with no args') if @_ > 1;
return $bswap_cache{$_[0][0]} if $bswap_cache{$_[0][0]};
my $size = PDL::Core::howbig($_[0][0]);
return $bswap_cache{$_[0][0]} = sub {} if $size < 2;
require PDL::IO::Misc;
$bswap_cache{$_[0][0]} =
$size == 2 ? \&PDL::bswap2 :
$size == 4 ? \&PDL::bswap4 :
$size == 8 ? \&PDL::bswap8 :
PDL::Core::barf("bswap couldn't find swap function for $_[0][1]{shortctype}");
}
!NO!SUBS!
foreach my $name ( qw( ctype ppsym convertfunc shortctype
sym numval ioname defbval
), @TYPE_VERBATIM ) {
print OUT << "EOS";
sub $name { \$_[0][1]{$name}; }
EOS
}
print OUT <<'!NO!SUBS!';
sub badvalue {
PDL::_badvalue_int( $_[1], $_[0][0] );
}
sub orig_badvalue {
PDL::_default_badvalue_int($_[0][0]);
}
# make life a bit easier
use overload (
'""' => sub { lc $_[0]->shortctype },
"eq" => sub { my ($self, $other, $swap) = @_; ("$self" eq $other); },
"cmp" => sub { my ($self, $other, $swap) = @_;
$swap ? $other cmp "$self" : "$self" cmp $other;
},
"<=>" => sub { $_[2] ? $_[1][0] <=> $_[0][0] : $_[0][0] <=> $_[1][0] },
);
} # package: PDL::Type
# Return
1;
__END__
=head1 DEVELOPER NOTES ON ADDING/REMOVING TYPEs
You can change the types that PDL knows about by editing entries in
the definition of the variable C<@types> that appears close to the
top of the file F<Types.pm.PL> (i.e. the file from which this module
was generated).
=head2 Format of a type entry
Each entry in the C<@types> array is a hash reference. Here is an example
taken from the actual code that defines the C<ushort> type:
{
identifier => 'US',
onecharident => 'U', # only needed if different from identifier
pdlctype => 'PDL_Ushort',
realctype => 'unsigned short',
ppforcetype => 'ushort',
usenan => 0,
packtype => 'S*',
defaultbadval => 'USHRT_MAX',
real=>1,
integer=>1,
unsigned=>1,
},
Before we start to explain the fields please take this important
message on board:
I<entries must be listed in order of increasing complexity>. This
is critical to ensure that PDL's type conversion works correctly.
Basically, a less complex type will be converted to a more complex
type as required.
=head2 Fields in a type entry
Each type entry has a number of required and optional entry.
A list of all the entries:
=over
=item *
identifier
I<Required>. A short sequence of upercase letters that identifies this
type uniquely. More than three characters is probably overkill.
=item *
onecharident
I<Optional>. Only required if the C<identifier> has more than one character.
This should be a unique uppercase character that will be used to reference
this type in PP macro expressions of the C<TBSULFD> type - see L<PDL::PP/$T>.
=item *
pdlctype
I<Required>. The C<typedef>ed name that will be used to access this type
from C code.
=item *
realctype
I<Required>. The C compiler type that is used to implement this type.
For portability reasons this one might be platform dependent.
=item *
ppforcetype
I<Required>. The type name used in PP signatures to refer to this type.
=item *
usenan
I<Required>. Flag that signals if this type has to deal with NaN issues.
Generally only required for floating point types.
=item *
packtype
I<Required>. The Perl pack type used to pack Perl values into the machine representation for this type. For details see C<perldoc -f pack>.
=item *
integer
I<Required>. Boolean - is this an integer type?
=item *
unsigned
I<Required>. Boolean - is this an unsigned type?
=item *
real
I<Required>. Boolean - is this a real (not complex) type?
=item *
realversion
String - the real version of this type (e.g. cdouble -> 'D').
=item *
complexversion
String - the complex version of this type (e.g. double -> 'C').
=back
Also have a look at the entries at the top of F<Types.pm.PL>.
The syntax is not written into stone yet and might change as the
concept matures.
=head2 Other things you need to do
You need to check modules that do I/O (generally in the F<IO>
part of the directory tree). In the future we might add fields to
type entries to automate this. This requires changes to those IO
modules first though.
You should also make sure that any type macros in PP files
(i.e. C<$TBSULFD...>) are updated to reflect the new type. PDL::PP::Dump
has a mode to check for type macros requiring updating. Do something like
find . -name \*.pd -exec perl -Mblib=. -M'PDL::PP::Dump=typecheck' {} \;
from the PDL root directory I<after> updating F<Types.pm.PL> to check
for such places.
=cut
!NO!SUBS!