.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Math::GSL::Rstat 3pm"
.TH Math::GSL::Rstat 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Math::GSL::Rstat \- Running Statistical functions
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 10
\& use Math::GSL::Rstat qw /:all/;
\& my @data = (17.2, 18.1, 16.5, 18.3, 12.6);
\& map { gsl_rstat_add( $_, $rstat) } @data;
\& my $rstat = gsl_rstat_alloc();
\& my $mean = gsl_rstat_mean($rstat);
\& my $variance = gsl_rstat_variance($rstat);
\& my $largest = gsl_rstat_max($rstat);
\& my $smallest = gsl_rstat_min($rstat);
\& my $sd = gsl_rstat_sd($rstat);
\& my $rms = gsl_rstat_rms($rstat);
\& my $sd_mean = gsl_rstat_sd_mean($rstat);
\& my $median = gsl_rstat_median($rstat);
\& my $skew = gsl_rstat_skew($rstat);
\& my $kurtosis = gsl_rstat_kurtosis($rstat);
\& my $n = gsl_rstat_n($rstat);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
NOTE: This module requires GSL 2.0 or higher.
.PP
For more information on the functions, we refer you to the GSL official
documentation:
.SH AUTHORS
.IX Header "AUTHORS"
Jonathan "Duke" Leto
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008\-2023 Jonathan "Duke" Leto
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.