Skip to content

Commit

Permalink
split Perldl2 out to separate PDL::Perldl2 distro
Browse files Browse the repository at this point in the history
  • Loading branch information
mohawk2 committed Nov 26, 2024
1 parent e43e8a0 commit e7f84c5
Show file tree
Hide file tree
Showing 44 changed files with 70 additions and 1,579 deletions.
4 changes: 2 additions & 2 deletions Basic/lib/PDL.pm
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ L<PDL::Core>.
=head1 INTERACTIVE SHELL
The PDL package includes an interactive shell. You can learn about it,
run C<perldoc perldl>, or run the shell C<perldl> or C<pdl2> and type
run C<perldoc perldl>, or run the shell C<perldl> and type
C<help>.
=head1 LOOKING FOR A FUNCTION?
Expand All @@ -75,7 +75,7 @@ For example:
yvals Fills an ndarray with Y index values. See the CAVEAT for xvals.
zvals Fills an ndarray with Z index values. See the CAVEAT for xvals.
To learn more about the PDL shell, see L<perldl> or L<pdl2>.
To learn more about the PDL shell, see L<perldl>.
=head1 LANGUAGE DOCUMENTATION
Expand Down
8 changes: 4 additions & 4 deletions Basic/lib/PDL/AutoLoader.pm
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ will search /home/joe/PDL and all its subdirectories for .pdl files.
=head2 AUTO-SCANNING
The variable C<$PDL::AutoLoader::Rescan> controls whether files
are automatically re-scanned for changes at the C<perldl> or
C<pdl2> command line.
are automatically re-scanned for changes at the C<perldl>
command line.
If C<$PDL::AutoLoader::Rescan == 1> and the file is changed
then the new definition is reloaded auto-matically before
executing the C<perldl> or C<pdl2> command line. Which means
executing the C<perldl> command line. Which means
in practice you can edit files, save changes and have C<perldl>
or C<pdl2> see the changes automatically.
see the changes automatically.
The default is '0' - i.e. to have this feature disabled.
Expand Down
6 changes: 3 additions & 3 deletions Basic/lib/PDL/BadValues.pod
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ including complex.
120

C<demo bad>
within L<perldl|PDL::perldl> or L<pdl2|PDL::Perldl2> gives a demonstration of some of the things
within L<perldl|PDL::perldl> gives a demonstration of some of the things
possible with bad values. These are also available on PDL's web-site,
at F<http://pdl.perl.org/demos/>. See L<PDL::Bad> for useful routines for working
with bad values and F<t/bad.t> to see them in action.

To find out if a routine supports bad values, use the C<badinfo> command in
L<perldl> or L<pdl2> or the C<-b> option to L<pdldoc>.
L<perldl> or the C<-b> option to L<pdldoc>.

Each ndarray contains a flag - accessible via C<< $pdl->badflag >> - to say
whether there's any bad data present:
Expand Down Expand Up @@ -249,7 +249,7 @@ not sufficient, there's the C<BadDoc> option. For code written at
the Perl level - i.e. in a .pm file - use the C<=for bad> pod directive.

This information will be available via man/pod2man/html documentation. It's also
accessible from the C<perldl> or C<pdl2> shells - using the C<badinfo> command - and the C<pdldoc>
accessible from the C<perldl> shell - using the C<badinfo> command - and the C<pdldoc>
shell command - using the C<-b> option.

=head1 AUTHOR
Expand Down
6 changes: 3 additions & 3 deletions Basic/lib/PDL/Broadcasting.pod
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ N-dimensional matrices. They are highly optimized for numerical work.
=head1 THINKING IN TERMS OF BROADCASTING

If you have used PDL for a little while already, you may have been using
broadcasting without realising it. Start the PDL shell (type C<perldl> or
C<pdl2> on a terminal). Most examples in this tutorial use the PDL shell.
broadcasting without realising it. Start the PDL shell (type C<perldl>
on a terminal). Most examples in this tutorial use the PDL shell.
Make sure that L<PDL::NiceSlice> and L<PDL::AutoLoader>
are enabled. For example:

% pdl2
% perldl
perlDL shell v1.352
...
ReadLines, NiceSlice, MultiLines enabled
Expand Down
2 changes: 1 addition & 1 deletion Basic/lib/PDL/Bugs.pod
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ C<perl -Mblib perldl -V> from the top level of the PDL build directory.

The bug description and how to reproduce it.

Short examples using the PDL shells, C<pdl2> or C<perldl>, are excellent!
Short examples using the PDL shell, C<perldl>, are excellent!
Don't forget to include needed input data (as small as possible) so that
the code can be run with a cut and paste.

Expand Down
2 changes: 1 addition & 1 deletion Basic/lib/PDL/Course.pod
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ C<approx>.

=over

=item * The L<perldl> or L<pdl2|PDL::Perldl2> Shell
=item * The L<perldl> Shell

The Perldl Shell is a REPL (Read-Evaluate-Print-Loop, in other words,
a prompt or shell) that allows you to work with PDL (or any Perl, for
Expand Down
2 changes: 1 addition & 1 deletion Basic/lib/PDL/Dbg.pm
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ PDL::Dbg - functions to support debugging of PDL scripts
These packages implements a couple of functions that should come in
handy when debugging your PDL scripts. They make a lot of sense while
you're doing rapid prototyping of new PDL code, let's say inside the
perldl or pdl2 shell.
perldl shell.
=cut

Expand Down
2 changes: 1 addition & 1 deletion Basic/lib/PDL/Demos/BAD_demo.pm
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ my @demos = (
either because it does not make sense or it's too much work to do!
To find out the status of a particular routine, use the 'badinfo'
command in perldl or pdl2 shell (this information is also included
command in perldl shell (this information is also included
when you do 'help'), or the '-b' switch of pdldoc.
|],

Expand Down
2 changes: 1 addition & 1 deletion Basic/lib/PDL/Demos/Cartography_demo.pm
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ earth_image('day') call on the next screen.

[act => q&
### There are a large number of map projections -- to list them all,
### say "??cartography" in the perldl or pdl2 shell. Here are four
### say "??cartography" in the perldl shell. Here are four
### of them:
undef $w; # Close old window
Expand Down
2 changes: 1 addition & 1 deletion Basic/lib/PDL/Demos/General.pm
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ We hope you enjoyed these demos illustrating some
of the basic capabilities of PDL.
We encourage you to play with these commands in
the perldl or pdl2 shell and use its online help support
the perldl shell and use its online help support
to find out more about these and other commands and
features of PDL.
Expand Down
2 changes: 1 addition & 1 deletion Basic/lib/PDL/Doc/Perldl.pm
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ PDL::Doc::Perldl - commands for accessing PDL doc database from 'perldl' shell
This module provides a set of functions to
access the PDL documentation database, for use
from the I<perldl> or I<pdl2> shells as well as the
from the I<perldl> shell as well as the
I<pdldoc> command-line program.
Autoload files are also matched, via a search of the PDLLIB autoloader
Expand Down
32 changes: 16 additions & 16 deletions Basic/lib/PDL/FAQ.pod
Original file line number Diff line number Diff line change
Expand Up @@ -297,18 +297,18 @@ Use the command C<perldoc PDL> to start learning about PDL.

The easiest way by far, however, to get familiar with PDL is to use
the PDL on-line help facility from within the PDL
shell, C<pdl2> Just type C<pdl2> at your system prompt. Once you are inside the
C<pdl2> shell type C<help> . Using the C<help> and C<apropos> commands
shell, C<perldl> Just type C<perldl> at your system prompt. Once you are inside the
C<perldl> shell type C<help> . Using the C<help> and C<apropos> commands
inside the shell you should be able to find the way round the
documentation.

Even better, you can immediately try your newly acquired
knowledge about PDL by issuing PDL/Perl commands directly at the command
line. To illustrate this process, here is the record of a typical
C<pdl2> session of a PDL beginner (lengthy output is only symbolically
C<perldl> session of a PDL beginner (lengthy output is only symbolically
reproduced in braces ( <... ...> ) ):

unix> pdl2
unix> perldl
pdl> help
< ... help output ... >
pdl> help PDL::QuickStart
Expand Down Expand Up @@ -537,7 +537,7 @@ To guarantee a completely clean installation of PDL, you will need
to first delete the current installation files and folders. These
will be all directories named C<PDL> in the Perl C<@INC> path,
files named C<*Pdlpp*> in any C<Inline> directories, and the
programs C<pdl, pdldoc, pdl2, perldl, and pptemplate>. Then just build
programs C<pdl, pdldoc, perldl, and pptemplate>. Then just build
and install as usual. This is much easier to keep track of if you
always install C<PDL> into a non-standard location. See Q: 4.4 above.

Expand Down Expand Up @@ -730,23 +730,23 @@ variable contains.



=head2 Q: 6.1 What is perldl? What is pdl2?
=head2 Q: 6.1 What is perldl?


Sometimes C<perldl> (C<pdl2>) is used as a synonym for PDL. Strictly
speaking, however, the name C<perldl> (C<pdl2>) is reserved for the
Sometimes C<perldl> is used as a synonym for PDL. Strictly
speaking, however, the name C<perldl> is reserved for the
little shell that comes with the PDL distribution and is
supposed to be used for the interactive prototyping of PDL
scripts. For details check L<perldl> or L<pdl2>.
scripts. For details check L<perldl>.


=head2 Q: 6.2 How do I get on-line help for PDL?


Just type C<help> (shortcut = "?") at the C<pdl2> shell
Just type C<help> (shortcut = "?") at the C<perldl> shell
prompt and proceed from there. Another useful command
is the C<apropos> (shortcut = "??") command.
Also try the C<demo> command in the C<perldl> or C<pdl2>
Also try the C<demo> command in the C<perldl>
shell if you are new to PDL.


Expand Down Expand Up @@ -985,7 +985,7 @@ L<PDL::Indexing> and L<PDL::PP> .


The short answer is: read L<PDL::Objects> (e.g. type
C<help PDL::Objects> in the I<perldl> or I<pdl2> shell).
C<help PDL::Objects> in the I<perldl> shell).

The longer answer (extracted from L<PDL::Objects> ):
Since a PDL object is an opaque reference to a C struct, it is not
Expand Down Expand Up @@ -1174,9 +1174,9 @@ appropriate slices of the 3D ndarray C<$cube> .
=head2 Q: 6.20 Where are test files for the graphics modules?

The demo programs can be run most easily from the
C<perldl> or C<pdl2> interactive shell:
C<perldl> interactive shell:

perl -Mblib perldl or perl -Mblib Perldl2/pdl2
perl -Mblib perldl

followed by C<demo 3d> or C<demo 3d2> at the prompt.
C<demo> by itself will give you a list of the available PDL demos.
Expand All @@ -1188,7 +1188,7 @@ C<demo> by itself will give you a list of the available PDL demos.
Questions like this should be a thing of the past with the PDL
on-line help system in place. Just try (after installation):

un*x> pdl2
un*x> perldl
pdl> apropos trid

Check the output for promising hits and then try to look up
Expand All @@ -1208,7 +1208,7 @@ with the L<PGPLOT> module itself.

=head2 Q: 7.1 I am looking for a package to do XXX in PDL. Where shall I look for it?

The first stop is again C<perldl> or C<pdl2> and the on-line help
The first stop is again C<perldl> and the on-line help
or the PDL documentation. There is already a lot of functionality in
PDL which you might not be aware of. The easiest way to look for
functionality is to use the C<apropos> command:
Expand Down
22 changes: 1 addition & 21 deletions Basic/lib/PDL/Index.pod
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ L<PDL::Tutorials> - A guide to PDL's tutorial documentation.

=item *

L<pdl2|PDL::pdl2> - Simple shell (version 2) for PDL
L<perldl> - Simple shell for PDL

=item *

Expand Down Expand Up @@ -528,26 +528,6 @@ L<PDL::Options> - simplifies option passing by hash in PerlDL

=item *

L<PDL::Perldl2::Plugin::CleanErrors> - filter out Moose cruft

=item *

L<PDL::Perldl2::Plugin::NiceSlice> - enable PDL NiceSlice syntax

=item *

L<PDL::Perldl2::Plugin::PDLCommands> - implement perldl aliases/escapes

=item *

L<PDL::Perldl2::Plugin::PrintControl> - disable default print output

=item *

L<PDL::Perldl2::Profile::Perldl2> - profile for Perldl2 shell

=item *

L<PDL::Primitive> - primitive operations for pdl

=item *
Expand Down
4 changes: 2 additions & 2 deletions Basic/lib/PDL/Indexing.pod
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The values of an ndarray are stored compactly as typed values in a single block
not (as in a normal Perl list-of-lists) as individual Perl scalars.

In the sections that follow many "methods" are called out -- these are Perl operators
that apply to ndarrays. From the L<perldl> (or L<pdl2>) shell, you
that apply to ndarrays. From the L<perldl> shell, you
can find out more about each method by typing "?" followed by the method name.

=head2 Dimension lists
Expand Down Expand Up @@ -203,7 +203,7 @@ several screens full of digits).
----------------------------------------------------------------
$im Double D [5,5] P 0.20Kb

The interactive C<perldl> or C<pdl2> shells that come with PDL have
The interactive C<perldl> shells that come with PDL have
a C<help vars> command that provides information about ndarrays. Use
C<help help> for more.

Expand Down
13 changes: 7 additions & 6 deletions Basic/lib/PDL/MATLAB.pod
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ PDL programs.

=head2 PDL interactive shell

To start the interactive shell, open a terminal and run C<perldl> or C<pdl2>.
To start the interactive shell, open a terminal and run C<perldl>.
As in MATLAB, the interactive shell is the best way to learn the
language. To exit the shell, type C<exit>, just like MATLAB.

Expand All @@ -66,7 +66,7 @@ One popular IDE for Perl is called Padre (L<http://padre.perlide.org>).
It is cross platform and easy to use.

Whenever you write a stand-alone PDL program (i.e. outside the
C<perldl> or C<pdl2> shell) you must start the program with C<use PDL;>.
C<perldl> shell) you must start the program with C<use PDL;>.
This command imports the PDL module into Perl. Here is a sample
PDL program:

Expand Down Expand Up @@ -146,7 +146,8 @@ you need to do calculations based on offsets.

=item Displaying an object

MATLAB normally displays object contents automatically. In the PDL shells you
MATLAB normally displays object contents automatically unless you
end with a C<;>. In the PDL shells you need to
display objects explicitly with the C<print> command or the shortcut C<p>:

MATLAB:
Expand All @@ -156,7 +157,7 @@ MATLAB:
>> b = 23; % Suppress output.
>>

PDL Shell (perldl or pdl2):
PDL Shell (perldl):

pdl> $x = 12 # No output.
pdl> print $x # Print object.
Expand All @@ -165,7 +166,7 @@ PDL Shell (perldl or pdl2):
12
pdl>

In pdl2 there is the C<do_print> command that will toggle the "quiet"
In L<pdl2|PDL::Perldl2> (a shell available on CPAN) there is the C<do_print> command that will toggle the "quiet"
mode, which defaults to on. In "print" mode, expressions you enter on
the command line will have their values printed.

Expand Down Expand Up @@ -664,7 +665,7 @@ To read data files containing whitespace separated columns of
numbers (as would be read using the MATLAB I<load> command)
one uses the PDL I<rcols> in L<PDL::IO::Misc>. For a general
review of the IO functionality available in PDL, see the
documentation for L<PDL::IO>, e.g., C<help PDL::IO> in the I<pdl2>
documentation for L<PDL::IO>, e.g., C<help PDL::IO> in the I<perldl>
shell or C< pdldoc PDL::IO > from the shell command line.

=head2 Data structures
Expand Down
4 changes: 2 additions & 2 deletions Basic/lib/PDL/Modules.pod
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ For example:
yvals Fills an ndarray with Y index values. See the CAVEAT for xvals.
zvals Fills an ndarray with Z index values. See the CAVEAT for xvals.

To learn more about the PDL shell, see L<perldl> or L<pdl2>.
To learn more about the PDL shell, see L<perldl>.

=head1 FOUNDATION

=over 5

=item L<perldl> or L<pdl2>
=item L<perldl>

Learn about the PDL shell.

Expand Down
Loading

0 comments on commit e7f84c5

Please sign in to comment.