From 317f0bbd0251c0cea082bcb00ccd3a188f258226 Mon Sep 17 00:00:00 2001 From: Jonathan Leto Date: Thu, 10 Jul 2008 01:45:32 -0700 Subject: [PATCH] POD cleanup and basic Histogram POD. --- BLAS.i | 2 +- CBLAS.i | 2 +- CDF.i | 2 +- Complex.i | 2 +- DFT.i | 2 +- DHT.i | 2 +- Eigen.i | 2 +- Histogram.i | 19 +++++++++++++++++++ Linalg.i | 2 +- Matrix.i | 2 +- Permutation.i | 2 +- Poly.i | 2 +- PowInt.i | 2 +- QRNG.i | 2 +- RNG.i | 2 +- Randist.i | 2 +- SF.i | 2 +- Sort.i | 2 +- Vector.i | 2 +- 19 files changed, 37 insertions(+), 18 deletions(-) diff --git a/BLAS.i b/BLAS.i index 06d4361..fdf0bbe 100644 --- a/BLAS.i +++ b/BLAS.i @@ -63,7 +63,7 @@ __END__ Math::GSL::BLAS - Basic Linear Algebra Subprograms -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::QRNG qw/:all/; diff --git a/CBLAS.i b/CBLAS.i index 75cbde5..a3be3cc 100644 --- a/CBLAS.i +++ b/CBLAS.i @@ -176,7 +176,7 @@ __END__ Math::GSL::CBLAS - Basic Linear Algebra Subprograms based on C functions -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::CBLAS qw/:all/; diff --git a/CDF.i b/CDF.i index 1997a31..58d23e7 100644 --- a/CDF.i +++ b/CDF.i @@ -46,7 +46,7 @@ __END__ Math::GSL::CDF - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the named distributions. -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::CDF qw /:all/; diff --git a/Complex.i b/Complex.i index 372e47f..dd84d2f 100644 --- a/Complex.i +++ b/Complex.i @@ -109,7 +109,7 @@ __END__ Math::GSL::Complex Functions concerning complex numbers. -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Complex qw/:all/; diff --git a/DFT.i b/DFT.i index aa37bc6..0f7388b 100644 --- a/DFT.i +++ b/DFT.i @@ -21,7 +21,7 @@ __END__ Math::GSL::DFT -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::DFT qw/:all/; diff --git a/DHT.i b/DHT.i index 4a9d465..8f30ca6 100644 --- a/DHT.i +++ b/DHT.i @@ -24,7 +24,7 @@ __END__ Math::GSL::DHT - Functions for performing Discrete Hankel Transforms -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::DHT qw/:all/; diff --git a/Eigen.i b/Eigen.i index 4bcaaeb..87ec122 100644 --- a/Eigen.i +++ b/Eigen.i @@ -38,7 +38,7 @@ __END__ Math::GSL::Eigen - Functions for computing eigenvalues and eigenvectors of matrices -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Eigen qw/:all/; diff --git a/Histogram.i b/Histogram.i index 390a8b6..3d78c61 100644 --- a/Histogram.i +++ b/Histogram.i @@ -53,4 +53,23 @@ gsl_histogram_pdf_sample /; %EXPORT_TAGS = ( all => [ @EXPORT_OK ] ); + + +=head1 SYNOPSIS + + use Math::GSL::Histogram qw/:all/; + + my $H = gsl_histogram_alloc(100); + gsl_histogram_set_ranges_uniform($H,0,101); + gsl_histogram_increment($H, -50 ); # ignored + gsl_histogram_increment($H, 70 ); + gsl_histogram_increment($H, 85.2 ); + + my $G = gsl_histogram_clone($H); + my $value = gsl_histogram_get($G, 70); + my ($max,$min) = (gsl_histogram_min_val($H), gsl_histogram_max_val($H) ); + my $sum = gsl_histogram_sum($H); + +=cut + %} diff --git a/Linalg.i b/Linalg.i index 52286ea..f43b647 100644 --- a/Linalg.i +++ b/Linalg.i @@ -126,7 +126,7 @@ __END__ Math::GSL::Linalg - Functions for solving linear systems -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Linalg qw/:all/; diff --git a/Matrix.i b/Matrix.i index 58d8cf7..9a4fe45 100644 --- a/Matrix.i +++ b/Matrix.i @@ -357,7 +357,7 @@ int => [ qw/ Math::GSL::Matrix - Mathematical functions concerning Matrices -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Matrix qw/:all/; my $matrix1 = Math::GSL::Matrix->new(5,5); # OO interface diff --git a/Permutation.i b/Permutation.i index 29cef8b..5f762db 100644 --- a/Permutation.i +++ b/Permutation.i @@ -86,7 +86,7 @@ __END__ Math::GSL::Permutation - functions for creating and manipulating permutations -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Permutation qw/:all/; diff --git a/Poly.i b/Poly.i index 73d085b..5e7c492 100644 --- a/Poly.i +++ b/Poly.i @@ -109,7 +109,7 @@ __END__ Math::GSL::Poly - Functions for evaluating and solving polynomials -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Poly qw/:all/; diff --git a/PowInt.i b/PowInt.i index 9fa1ebe..cb9861e 100644 --- a/PowInt.i +++ b/PowInt.i @@ -19,7 +19,7 @@ __END__ Math::GSL::PowInt - Integer Power functions -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::PowInt qw /gsl_pow_2 gsl_pow_4 gsl_pow_int/; print '2**4 = ' . gsl_pow_2(4) . "\n"; diff --git a/QRNG.i b/QRNG.i index 6fa1555..6c8e6ad 100644 --- a/QRNG.i +++ b/QRNG.i @@ -28,7 +28,7 @@ __END__ Math::GSL::QRNG - Quasi-random number generator -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::QRNG qw/:all/; diff --git a/RNG.i b/RNG.i index f19d571..ab54eaf 100644 --- a/RNG.i +++ b/RNG.i @@ -72,7 +72,7 @@ __END__ Math::GSL::RNG - Random Number Generators -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::RNG qw/:all/; diff --git a/Randist.i b/Randist.i index 1e9762a..bb18573 100644 --- a/Randist.i +++ b/Randist.i @@ -127,7 +127,7 @@ __END__ Math::GSL::Randist - Probability Distributions -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Randist qw/:all/; diff --git a/SF.i b/SF.i index cb26103..eab0d67 100644 --- a/SF.i +++ b/SF.i @@ -666,7 +666,7 @@ __END__ Math::GSL::SF - Special Functions -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::SF qw /:all/; diff --git a/Sort.i b/Sort.i index 522fde1..3c34e9a 100644 --- a/Sort.i +++ b/Sort.i @@ -82,7 +82,7 @@ __END__ Math::GSL::Sort - Functions for sorting data -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Sort qw/:all/; diff --git a/Vector.i b/Vector.i index ad572ff..3fbfdf6 100644 --- a/Vector.i +++ b/Vector.i @@ -97,7 +97,7 @@ use overload Math::GSL::Vector - Functions concerning vectors -=head1 SYPNOPSIS +=head1 SYNOPSIS use Math::GSL::Vector qw/:all/; my $vec1 = Math::GSL::Vector->new([1, 7, 94, 15 ]); -- 2.11.4.GIT