Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

CHM / PDL-2.4.9_992 / Example / InlinePdlpp / Module / MyInlineMod.pm 

            

              
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

              
# Below is the stub of documentation for your module. You better edit it!
=head1 NAME
PDL::MyInlineMod - a simple PDL module containing inlined Pdlpp code
=head1 SYNOPSIS
  use PDL::MyInlineMod;
  $a = zeroes 10, 10;
  $twos = $a->plus2;  # a simple function
=head1 DESCRIPTION
A simple example module that demonstrates the usage of inlined Pdlpp
in a module that can be installed in the usual way.
=head1 FUNCTIONS
=cut
package PDL::MyInlineMod;
# use strict;  # strict results in trouble with barewords when using Inline :(
# no strict 'vars';
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
require PDL::Exporter;
@ISA = qw(PDL::Exporter);
# functions you want to export into the caller's name space
@EXPORT_OK = qw(myinc plus2);
%EXPORT_TAGS = (Func=>[@EXPORT_OK]);
BEGIN { # in BEGIN to make sure we can use $VERSION in the
        # 'use Inline...' call below
$VERSION = '0.60'; # Inline requires this to be a *string* that matches
                   #          /^\d\.\d\d$/
                   # see Inline-FAQ for more info
}
use PDL::LiteF;
# quirk 1 follows
use Inline::MakePdlppInstallable;  # allow installation of this module
use Inline Pdlpp => DATA => # inlined PP code is below in DATA section
  NAME => PDL::MyInlineMod,    # required info for module installation
  VERSION => $VERSION;      # ditto, see Inline-FAQ for more info
# quirk 2 follows
Inline->init;               # you need this if you want to 'use' your module
                            # from within perldl or pdl2 and your Pdlpp code
                            # resides in the DATA section (as in this example)
# following required to make exported functions work!
# PDL::PP used to make these automatically but now we have
# to make them manually since *we* are writing the pm-file
*myinc = \&PDL::myinc;      # make alias in this module's name space
*plus2 = \&PDL::plus2;      # ditto
1;
__DATA__
__Pdlpp__
# some simple functions to test the whole thing
=head2 myinc
=for ref
a very simple pp function that increments its argument
=for sig
  myinc(i();[o] o())
=cut
pp_def('myinc',
          Pars => 'i();[o] o()',
          Code => '$o() = $i() + 1;',
         );
=head2 plus2
=for ref
a very simple pp function that increments its argument by 2
=for sig
  plus2(i();[o] o())
=cut
pp_def('plus2',
          Pars => 'i();[o] o()',
          Code => '$o() = $i() + 2;',
         );
=head1 AUTHOR
C. Soeller (C) 2002. All rights reserved. This code can be distributed
under the same terms as PDL itself (see the file COPYING in the PDL
distribution).
=head1 SEE ALSO
perl(1).
L<Inline>.
L<Inline::Pdlpp>.
=cut