Scroll to navigation

Exporter(3pm) User Contributed Perl Documentation Exporter(3pm)

NAME

PDL::Exporter - PDL export control

DESCRIPTION

Implements the standard conventions for import of PDL modules in to the namespace

Hopefully will be extended to allow fine control of which namespace is used.

SYNOPSIS

use PDL::Exporter;

 use PDL::MyModule;       # Import default function list ':Func'
 use PDL::MyModule '';    # Import nothing (OO)
 use PDL::MyModule '...'; # Same behaviour as Exporter

SUMMARY

"PDL::Exporter" is a drop-in replacement for the Exporter module. It confers the standard PDL export conventions to your module. Usage is fairly straightforward and best illustrated by an example. The following shows typical usage near the top of a simple PDL module:

   package PDL::MyMod;
   use strict;
   
   # For Perl 5.6:
   use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
   # For more modern Perls:
   our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
   
   require PDL::Exporter;
   
   @ISA = qw(PDL::Exporter);
   @EXPORT_OK = qw(inc myfunc); # these will be exported by default
   %EXPORT_TAGS = (Func=>[@EXPORT_OK],
                   Internal => [qw/internfunc1 internfunc2/],
                  );
   
    # ... body of your module
   
   1; # end of simple module

SEE ALSO

Exporter

AUTHOR

Copyright (C) Karl Glazebrook (kgb@aaoepp.aao.gov.au). Some docs by Christian Soeller. All rights reserved. There is no warranty. You are allowed to redistribute this software / documentation under certain conditions. For details, see the file COPYING in the PDL distribution. If this file is separated from the PDL distribution, the copyright notice should be included in the file.

2023-06-17 perl v5.36.0