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) [suse 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.

       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'

	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

   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'

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

	 perldl> 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'

	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.12.1							    2009-10-24							    Doc::Perldl(3)

Check Out this Related Man Page

Dbg(3)							User Contributed Perl Documentation						    Dbg(3)

NAME

       PDL::Dbg - functions to support debugging of PDL scripts

SYNOPSIS

	      use PDL;
	      use PDL::Dbg;

	      $c = $a->slice("5:10,2:30")->px->diagonal(3,4);
	      PDL->px;

DESCRIPTION

       This 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 shell.

FUNCTIONS

       px

       Print info about a piddle (or all known piddles)

	   perldl> PDL->px
	   perldl> $b += $a->clump(2)->px('clumptest')->sumover
	   perldl> $a->px('%C (%A) Type: %T')

       This function prints some information about piddles. It can be invoked as a class method (e.g. "PDL->px" ) or as an instance method (e.g.
       "$pdl->px($arg)"). If

       invoked as a class method
	 it prints info about all piddles found in the current package (excluding "my" variables). This comes in quite handy when you are not
	 quite sure which pdls you have already defined, what data they hold , etc. "px" is supposed to support inheritance and prints info about
	 all symbols for which an "isa($class)" is true. An optional string argument is interpreted as the package name for which to print sym-
	 bols:

	   perldl> PDL->px('PDL::Mypack')

	 The default package is that of the caller.

       invoked as an instance method
	 it prints info about that particular piddle if $PDL::debug is true and returns the pdl object upon completion. It accepts an optional
	 string argument that is simply prepended to the default info if it doesn't contain a "%" character. If, however, the argument contains a
	 "%" then the string is passed to the "info" method to control the format of the printed information. This can be used to achieve custom-
	 ized output from "px". See the documentation of "PDL::info" for further details.

       The output of px will be determined by the default formatting string that is passed to the "info" method (unless you pass a string contain-
       ing "%" to px when invoking as an instance method, see above). This default string is stored in $PDL::Dbg::Infostr and the default output
       format can be accordingly changed by setting this variable.  If you do this you should also change the default title string that the class
       method branch prints at the top of the listing to match your new format string. The default title is stored in the variable
       $PDL::Dbg::Title.

       For historical reasons "vars" is an alias for "px".

       vars

       Alias for "px"

BUGS

       There are probably some. Please report if you find any. Bug reports should be sent to the PDL mailing list perldl@jachw.hawaii.edu.

AUTHOR

       Copyright(C) 1997 Christian Soeller (c.soeller@auckland.ac.nz).	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 sepa-
       rated from the PDL distribution, the copyright notice should be included in the file.

perl v5.8.0							    2000-04-17								    Dbg(3)
Man Page