.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Average 3pm"
.TH Average 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire 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
Lire::Average \- Lire class that implements the avg operator
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Lire::Average
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Class that implements the avg operator. This operator will compute the
average value of a DLF field in a group of DLF records.
.PP
If the field used by average isn\*(Aqt a numeric fields, the number of
different values in that field will be used as the numerator.
.PP
It\*(Aqs possible to compute a weighted average by specifying a weighting field.
.PP
By default, the average is a by record average. It\*(Aqs possible to
compute a by different values average. The list of fields that\*(Aqs used
to determine the different values if speficied in the by\-fields
attribute.
.SH METHODS
.IX Header "METHODS"
.ie n .SS "new( %params )"
.el .SS "new( \f(CW%params\fP )"
.IX Subsection "new( %params )"
Creates a new Lire::Average object. In addition to the values
supported by its parents, the by\-fields and weight attributes will be
initialized to the values specified in the \f(CW%params\fR argument.
.SS "by_fields( [$new_by_fields] )"
.IX Subsection "by_fields( [$new_by_fields] )"
Returns the fields that are going to be used to count the different
values which will made up the by part of the average.
.PP
This a reference to an array of DLF field names.
.PP
If the \f(CW$new_by_fields\fR parameter is set, it will be used as the new
\&\f(CW$by_fields\fR value. It must be an array reference and should only
contains valid field names for the current report specification\*(Aqs
schema.
.SS "weigth( [$new_weight] )"
.IX Subsection "weigth( [$new_weight] )"
Returns the DLF field\*(Aqs name by which the values will be multiplied
before being summed.
.PP
You can change the weight field by specifying a new name as the
\&\f(CW$new_weight\fR parameter. Use undef to remove the use of a weighting
field.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\& Lire::ReportSpec(3pm), Lire::ReportOperator(3pm),
\& Lire::Aggregator(3pm), Lire::Aggregate(3pm).
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\& Francis J. Lacoste <flacoste@logreport.org>
\& Wolfgang Sourdeau <wsourdea@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Average.pm,v 1.17 2008/03/09 19:27:30 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001\-2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.