.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Rangegroup 3pm"
.TH Rangegroup 3pm "2020-07-07" "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::Group \- Base class for implementation of the rangegroup aggregator
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::Rangegroup;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is the base class for implementation of the rangegroup
aggregator. This aggregator will split the \s-1DLF\s0 records based on a
numerical field. The so-called range groups creates numerical classes
(e.g. 1\-10, 11\-20, etc.) and the \s-1DLF\s0 record will be grouped with other
records which are in the same class.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .SS "new( %params )"
.el .SS "new( \f(CW%params\fP )"
.IX Subsection "new( %params )"
Creates a new instance of a group aggregator. In addition to the
normal report operator parameters, the rangegroup aggregator can take
several parameters:
.IP "field" 4
.IX Item "field"
This parameter is mandatory. It should be the name of the \s-1DLF\s0 field
which will be used as key for this aggregator.
.IP "range-size" 4
.IX Item "range-size"
This parameter is mandatory. This will be used as the size of each
range group.
.IP "range-start" 4
.IX Item "range-start"
The number at which the first range group starts. Defauls to 0.
.IP "min-value" 4
.IX Item "min-value"
Value lower than this number will be sorted in the first range group.
.IP "max-value" 4
.IX Item "max-value"
Value higher than this number will be sorted in the last range group.
.IP "size-scale" 4
.IX Item "size-scale"
This parameter can be used to create a logarithmic scale. In this
case, each new range group will be size-scale bigger than the one that
comes before it. For example, setting range\-size=5 and size\-scale=2
will create ranges like [0\-5>, [5\-15>, [15\-35>, ...
.SH "METHODS"
.IX Header "METHODS"
.SS "field( [$new_field] )"
.IX Subsection "field( [$new_field] )"
Returns the name of the \s-1DLF\s0 field which is used as grouping key.
.PP
If the \f(CW$new_field\fR parameter is set, it changes the grouping field.
This must be the name of a quantity type field in the report
specifications \s-1DLF\s0 schema.
.SS "range_start( [$new_start] )"
.IX Subsection "range_start( [$new_start] )"
Returns the number which is the starting bound of the first range group.
.PP
If the \f(CW$new_start\fR parameter is set, it changes the starting bound of the
first range group. This should either be a positive integer or the
name of one of the report specification's parameter.
.SS "range_size( [$new_size] )"
.IX Subsection "range_size( [$new_size] )"
Returns the width of each range group.
.PP
If the \f(CW$new_size\fR parameter is set, it changes the width of each range
group. This should either be a positive integer or the name of one of
the report specification's parameter.
.SS "min_value( [$new_min] )"
.IX Subsection "min_value( [$new_min] )"
Returns the number below which no new range groups will be created.
.PP
If the \f(CW$new_min\fR is set, it changes the lower bound below which no new
groups will be created. This should either be a number or the name of
one of the report specification's parameter.
.SS "max_value( [$new_max] )"
.IX Subsection "max_value( [$new_max] )"
Returns the number above which no new range groups will be created.
.PP
If the \f(CW$new_max\fR is set, it changes the upper bound above which no new
groups will be created. This should either be a number or the name of
one of the report specification's parameter.
.SS "size_scale( [$new_size_scale] )"
.IX Subsection "size_scale( [$new_size_scale] )"
Returns the multiplier that will be apply to each of the range group's
width after the first one.
.PP
When this attribute is greater than 1, it creates a logarithmic scale
where each new ranges is \f(CW$size_scale\fR wider than the precedent one.
.PP
If the \f(CW$new_size_scale\fR parameter is used, it changes the attribute to
this new value. It should be a positive interger or can also be a
parameter reference.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\& Lire::ReportSpec(3pm), Lire::Group(3pm), Lire::ReportOperator(3pm),
\& Lire::Aggregator(3pm)
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wsourdeau@logreport.org>
.Ve
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR Rangegroup.pm,v 1.25 2006/07/30 10:50:17 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 \s-1GNU\s0 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 \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.