Skip to content

Commit

Permalink
purge split-out modules from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mohawk2
mohawk2 committed Jan 13, 2025
1 parent d4feb3a commit a731ee1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 453 deletions.
62 changes: 16 additions & 46 deletions lib/PDL/Course.pod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@ way to slice and dice your ndarrays. Read the Synopsis, then
scroll down to The New Slicing Syntax. After you've read to
the bottom, return to and read the stuff at the top.

=item * L<PDL::Ops>

Defines the standard Perl-overloadable operators, like + and .=, for
example. Since pretty much all of these operators and functions are
discussed elsewhere, there's usually no need to read this documentation
or use this module.

=item * L<PDL::Primitive>

Defines a whole slew of useful built-in functions. These
Expand Down Expand Up @@ -106,7 +113,9 @@ Shell, with instant feedback!
=item * L<PDL>

The main workhorse module. You'll include this in nearly every PDL
program you write.
program you write. But if you don't use mathematical or I/O functions or
matrix operations, you might get quicker startup with L<PDL::LiteF>,
or that plus no namespace pollution with L<PDL::Lite>.

=back

Expand All @@ -130,6 +139,10 @@ C<reorder>. This also thoroughly documents the C<range> function, which
can be very powerful, and covers a number of internal functions, which
can probably be skipped.

=item * L<PDL::Dataflow>

Covers data flow, which is a somewhat unique feature of PDL.

=item * L<PDL::Indexing>

This covers a lot of the deeper conceptual ground that you'll
Expand Down Expand Up @@ -183,13 +196,6 @@ PDL's own Fast Fourier Transform. If you have FFTW, then you
should probably make use of it; this is PDL's internal
implementation and should always be available.

=item * GSL

PDL does not have bindings for every sub-library in the GNU Scientific
Library, but it has quite a few. If you have GSL installed on your
machine then chances are decent that your PDL has the GSL bindings.
For a full list of the GSL bindings, check L<PDL::Index>.

=item * L<PDL::Func>

A somewhat uniform interface to the different interpolation modules in PDL.
Expand Down Expand Up @@ -244,12 +250,6 @@ them to Spherical-Polar coordinates (although many such standard
coordinate transformations are predefined for you, in this case it's
called C<t_spherical>).

=item * L<PDL::Opt::Simplex>

This package states that it "implements the commonly used simplex
optimization algorithm." I'm going to assume that if you need this
algorithm then you already know what it is.

=item * L<PDL::Math>

A collection of fairly standard math functions, like the inverse
Expand Down Expand Up @@ -342,13 +342,13 @@ makefiles (but see L<PDL::pptemplate> for help on that).

=item * L<PDL::PP>

The PDL Pre-Processor, which vastly simplifies making you
The PDL Pre-Processor, which vastly simplifies making your
C or Fortran code play with Perl and ndarrays. Most of PDL's
basic functionality is written using PDL::PP, so if you're
thinking about how you might integrate some numerical
library written in C, look no further.

=item * L<PDL::pptemplate>
=item * L<pptemplate>

A script that automates the creation of modules that use L<PDL::PP>,
which should make your life as a module author a bit simpler.
Expand Down Expand Up @@ -400,36 +400,6 @@ to read this.

=back

=begin questionable

=head1 Other Documents

These documents are part of the PDL distribution but don't
seem to fit anywhere above.

=over

=item * L<PDL::Dataflow>

Covers data flow, a cool feature to be sure, but from what I can tell
it is not currently supported.

=item * L<PDL::Ops>

Defines the standard Perl-overloadable operators, like + and .=, for
example. Since pretty much all of these operators and functions are
discussed elsewhere, there's usually no need to read this documentation
or use this module.

=item * L<PDL::Gaussian>

An apparently broken module to help generate and work with Gaussian
distributions.

=back

=end questionable


=head1 COPYRIGHT

Expand Down
248 changes: 0 additions & 248 deletions lib/PDL/Index.pod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,230 +196,10 @@ L<PDL::FFT> - FFTs for PDL

=item *

L<PDL::Filter::LinPred> - Linear predictive filtering

=item *

L<PDL::Filter::Linear> - linear filtering for PDL

=item *

L<PDL::Fit::Gaussian> - routines for fitting gaussians

=item *

L<PDL::Fit::LM> - Levenberg-Marquardt fitting routine for PDL

=item *

L<PDL::Fit::Linfit> - routines for fitting data with linear combinations of functions.

=item *

L<PDL::Fit::Polynomial> - routines for fitting with polynomials

=item *

L<PDL::Func> - interpolation, integration, & gradient estimation (differentiation) of functions

=item *

L<PDL::GSL::CDF> - PDL interface to GSL Cumulative Distribution Functions

=item *

L<PDL::GSL::DIFF> - PDL interface to numerical differentiation routines in GSL

=item *

L<PDL::GSL::INTEG> - PDL interface to numerical integration routines in GSL

=item *

L<PDL::GSL::INTERP> - PDL interface to Interpolation routines in GSL

=item *

L<PDL::GSL::LINALG> - PDL interface to linear algebra routines in GSL

=item *

L<PDL::GSL::MROOT> - PDL interface to multidimensional root-finding routines in GSL

=item *

L<PDL::GSL::RNG> - PDL interface to RNG and randist routines in GSL

=item *

L<PDL::GSLSF::AIRY> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::BESSEL> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::CLAUSEN> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::COULOMB> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::COUPLING> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::DAWSON> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::DEBYE> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::DILOG> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::ELEMENTARY> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::ELLINT> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::ELLJAC> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::ERF> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::EXP> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::EXPINT> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::FERMI_DIRAC> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::GAMMA> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::GEGENBAUER> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::HYPERG> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::LAGUERRE> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::LEGENDRE> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::LOG> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::POLY> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::POW_INT> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::PSI> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::SYNCHROTRON> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::TRANSPORT> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::TRIG> - PDL interface to GSL Special Functions

=item *

L<PDL::GSLSF::ZETA> - PDL interface to GSL Special Functions

=item *

L<PDL::Gaussian> - Gaussian distributions.

=item *

L<PDL::Graphics::OpenGL::Perl::OpenGL> - PDL TriD OpenGL interface using POGL

=item *

L<PDL::Graphics::OpenGLQ> - quick routines to plot lots of stuff from ndarrays.

=item *

L<PDL::Graphics::TriD> - PDL 3D interface

=item *

L<PDL::Graphics::TriD::ButtonControl> - default event handler subroutines

=item *

L<PDL::Graphics::TriD::Contours> - 3D Surface contours for TriD

=item *

L<PDL::Graphics::TriD::Graph> - PDL 3D graph object with axes

=item *

L<PDL::Graphics::TriD::Labels> - Text tools

=item *

L<PDL::Graphics::TriD::MathGraph> - Mathematical Graph objects for PDL

=item *

L<PDL::Graphics::TriD::Objects> - Simple Graph Objects for TriD

=item *

L<PDL::Graphics::TriD::Rout> - Helper routines for Three-dimensional graphics

=item *

L<PDL::Graphics::TriD::Tk> - A Tk widget interface to the PDL::Graphics::TriD.

=item *

L<PDL::Graphics::TriD::VRML> - TriD VRML backend

=item *

L<PDL::IO::Dicom> - a module for reading DICOM images.

=item *

L<PDL::IO::Dumper> - data dumping for structs with PDLs

=item *
Expand All @@ -436,26 +216,6 @@ L<PDL::IO::FlexRaw> - A flexible binary I/O format for PerlDL

=item *

L<PDL::IO::GD> - Interface to the GD image library.

=item *

L<PDL::IO::HDF> - A PDL interface to the HDF4 library.

=item *

L<PDL::IO::HDF::SD> - PDL interface to the HDF4 SD library.

=item *

L<PDL::IO::HDF::VS> - An interface library for HDF4 files.

=item *

L<PDL::IO::IDL> - I/O of IDL Save Files

=item *

L<PDL::IO::Misc> - misc IO routines for PDL

=item *
Expand Down Expand Up @@ -520,10 +280,6 @@ L<PDL::Ops> - Fundamental mathematical operators

=item *

L<PDL::Opt::Simplex> - Simplex optimization routines

=item *

L<PDL::Options> - simplifies option passing by hash in PerlDL

=item *
Expand All @@ -548,10 +304,6 @@ L<PDL::Transform::Cartography> - Useful cartographic projections

=item *

L<PDL::Transform::Proj4> - PDL::Transform interface to the Proj4 projection library

=item *

L<PDL::Types> - define fundamental PDL Datatypes

=item *
Expand Down
Loading

0 comments on commit a731ee1

Please sign in to comment.