Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pdl::doc::perldl(3) [redhat man page]

Doc::Perldl(3)						User Contributed Perl Documentation					    Doc::Perldl(3)

NAME

       PDL::Doc::Perldl - commands for accessing PDL doc database from 'perldl' shell

DESCRIPTION

       This module provides a simple set of functions to access the PDL documentation of database, for use from the perldl shell and the pdldoc
       command-line program.

       Currently, multiple matches are not handled very well.

SYNOPSIS

	use PDL::Doc::Perldl; # Load all documenation functions

FUNCTIONS

       apropos

       Regex search PDL documentation database

	apropos 'text'

	perldl> apropos 'pic'
	rpic		Read images in many formats with automatic format detection.
	rpiccan 	Test which image formats can be read/written
	wmpeg		Write an image sequence ((x,y,n) piddle) as an MPEG animation.
	wpic		Write images in many formats with automatic format selection.
	wpiccan 	Test which image formats can be read/written

       To find all the manuals that come with PDL, try

	 apropos 'manual:'

       and to get quick info about PDL modules say

	 apropos 'module:'

       You get more detailed info about a PDL function/module/manual with the "help" function

       usage

       Prints usage information for a PDL function

	Usage: usage 'func'

	  perldl> usage 'inner'

	  inner 	  inner prodcuct over one dimension
			  (Module PDL::Primitive)

	  Signature: inner(a(n); b(n); [o]c(); )

       sig

       prints signature of PDL function

	sig 'func'

       The signature is the normal dimensionality of the functions arguments. Calling with different dimensions causes 'threading' - see "PDL::PP"
       for more details.

	 perldl> sig 'outer'
	   Signature: outer(a(n); b(m); [o]c(n,m); )

       help

       print documentation about a PDL function or module or show a PDL manual

       In the case of multiple matches, the first command found is printed out, and the remaining commands listed, along with the names of their
       modules.

	Usage: help 'func'

	perldl> help 'PDL::Slices'   # show the docs in the PDL::Slices module
	perldl> help 'PDL::Intro'    # show the PDL::Intro manual
	perldl> help 'slice'	     # show docs on the 'slice' function

       badinfo

       provides information on the bad-value support of a function

       And has a horrible name.

	badinfo 'func'

perl v5.8.0							    2000-11-03							    Doc::Perldl(3)

Check Out this Related Man Page

PDL(3)							User Contributed Perl Documentation						    PDL(3)

NAME

       PDL - the Perl Data Language

DESCRIPTION

       (For the exported PDL constructor, pdl(), see PDL::Core or pdl[2])

       PDL is the Perl Data Language, a perl extension that is designed for scientific and bulk numeric data processing and display.  It extends
       perl's syntax and includes fully vectorized, multidimensional array handling, plus several paths for device-independent graphics output.

       For basic information on the PDL language, see the pdl(1) (lowercase) man page.

       You can run PDL programs directly as perl scripts that include the PDL module (with "use PDL;"), or via an interactive shell (see the
       perldl(1) man page).

       The PDL language extension includes about a dozen perl modules that form the core of the language, plus additional modules that add further
       functionality.  The perl module "PDL" loads all of the core modules automatically, making their functions available in the current perl
       namespace.  See also PDL::Lite or PDL::LiteF if start-up time becomes an issue.

       EXPORTS:
	  "use PDL;" exports a large number of routines into the calling namespace.  If you want to avoid namespace pollution, you must instead
	  "use PDL::Lite", and include any additional modules explicitly.

       NICESLICE:
	  Note that the PDL::NiceSlice syntax is NOT automatically loaded by "use PDL;".  If you want to use the extended slicing syntax in a
	  standalone script, you must also say "use PDL::NiceSlice;".

       PDL::Math:
	  The PDL::Math module has been added to the list of modules for versions later than 2.3.1. Note that PDL::Math is still not included in
	  the Lite and LiteF start-up modules.

SYNOPSIS

	use PDL; # Is equivalent to the following:

	  use PDL::Core;
	  use PDL::Ops;
	  use PDL::Primitive;
	  use PDL::Ufunc;
	  use PDL::Basic;
	  use PDL::Slices;
	  use PDL::Bad;
	  use PDL::MatrixOps;
	  use PDL::Math;
	  use PDL::Version;
	  use PDL::IO::Misc;
	  use PDL::IO::FITS;
	  use PDL::IO::Pic;
	  use PDL::Lvalue;

perl v5.12.1							    2010-01-01								    PDL(3)
Man Page