pdl::doc::perldl(3pm) [debian man page]

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

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 or pdl2 shells as well
       as the pdldoc command-line program.

       Autoload files are also matched, via a search of the PDLLIB autoloader tree.  That behavior can be switched off with the variable
       $PERLDL::STRICT_DOCS (true: don't search autoload tree; false: search the autoload tree.)

       Currently, multiple matches are not handled very well.

SYNOPSIS

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

BUGS

       The description contains the misleading word "simple".

FUNCTIONS

   apropos
       Regex search PDL documentation database

	apropos 'text'

	pdl> 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

   PDL::Doc::Perldl::search_docs
       Internal routine to search docs database and autoload files

   PDL::Doc::Perldl::finddoc
       Internal interface to the PDL documentation searcher

   find_autodoc
       Internal helper routine that finds and returns documentation in the autoloader path, if it exists.  You feed in a topic and it searches for
       the file "${topic}.pdl".  If that exists, then the filename gets returned in a match structure appropriate for the rest of finddoc.

   usage
       Prints usage information for a PDL function

	Usage: usage 'func'

	  pdl> 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 function's arguments.	Calling with different dimensions doesn't break -- it causes
       threading.  See PDL::PP for details.

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

   whatis
       Describe a perl and/or PDL variable or expression.  Useful for determining the type of an expression, identifying the keys in a hash or a
       data structure, or examining WTF an unknown object is.

	Usage: whatis $var
	       whatis <expression>

   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'

	pdl> help 'PDL::Tutorials' # show the guide to PDL tutorials
	pdl> help 'PDL::Slices'    # show the docs in the PDL::Slices module
	pdl> 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.14.2							    2012-01-02							  Doc::Perldl(3pm)

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

NAME

       PDL::AutoLoader - MatLab style AutoLoader for PDL

SYNOPSIS

	use PDL::AutoLoader;
	$a = func1(...);   # Load file func1.pdl
	$b = func2(...);   # Load file func2.pdl

	$PDL::AutoLoader::Rescan = 1; # Enable re-scanning

DESCRIPTION

       This module implements a MatLab style AutoLoader for PDL. If an unknown function "func()" is called, PDL looks for a file called
       "func.pdl".  If it finds one, it compiles the file and calls the function "func".

       The list of directories to search in is given by the shell environment variable "PDLLIB". This is a colon-separated list of directories. On
       MSWindows systems, is it a semicolon -separated list of directories.

       For example, in csh:

	 setenv PDLLIB "/home/joe/pdllib:/local/pdllib"

       Note: This variable is unrelated to Perl's "PERL5LIB".

       If you add a leading '+' on a directory name, PDL will search the entire directory tree below that point. Internally, PDL stores the
       dirctory list in the variable @PDLLIB, which can be modified at run time.

       For example, in csh:

	 setenv PDLLIB "+/home/joe/PDL"

       will search /home/joe/PDL and all its subdirectories for .pdl files.

   AUTO-SCANNING
       The variable $PDL::AutoLoader::Rescan controls whether files are automatically re-scanned for changes at the "perldl" or "pdl2" command
       line.

       If "$PDL::AutoLoader::Rescan == 1" and the file is changed then the new definition is reloaded auto-matically before executing the "perldl"
       or "pdl2" command line. Which means in practice you can edit files, save changes and have "perldl" or "pdl2" see the changes automatically.

       The default is '0' - i.e. to have this feature disabled.

       As this feature is only pertinent to the PDL shell it imposes no overhead on PDL scripts. Yes Bob you can have your cake and eat it too!

       Note: files are only re-evaled if they are determined to have been changed according to their date/time stamp.

       No doubt this interface could be improved upon some more. :-)

   Sample file:
	sub foo { # file 'foo.pdl' - define the 'foo' function
	  my $x=shift;
	  return sqrt($x**2 + $x**3 + 2);
	}
	1; # File returns true (i.e. loaded successfully)

AUTHOR

       Copyright(C) 1997 Karl Glazebrook (kgb@aaoepp.aao.gov.au); several extensions by Craig DeForest (deforest@boulder.swri.edu) 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.

BUGS

       No doubt this interface could be improved upon some more. :-)

       Will probably be quite slow if "$PDL::AutoLoader::Rescan == 1" and thousands of functions have been autoloaded.

       There could be a race condition in which the file changes while the internal autoloader code is being executed but it should be harmless.

       Probably has not been tested enough!

SEE ALSO

       For an alternative approach to managing a personal collaction of modules and functions, see local::lib.

   PDL::AutoLoader::expand_path
       Expand a compactified path into a dir list

       You supply a pathlist and leading '+' and '~' characters get expanded into full directories.  Normally you don't want to use this -- it's
       internal to the autoloader -- but some utilities, like the online documentation searcher, need to be able to use it.

perl v5.14.2							    2012-01-02							   AutoLoader(3pm)