.\" 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 "Pedigree::Area 3"
.TH Pedigree::Area 3 "2021-10-02" "perl v5.18.4" "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"
Pedigree::Area \- Calculate the area taken by a tree or a clump
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use Pedigree::Area;
.PP
\&\f(CW$area\fR = new Pedigree::Area($node);
.PP
\&\f(CW$Ymin\fR=$area\->\fBGetYmin()\fR;
.PP
\&\f(CW$area\fR\->SetYmin($Ymin);
.PP
\&\f(CW$Ymax\fR=$area\->\fBGetYmax()\fR;
.PP
\&\f(CW$area\fR\->SetYmax($Ymax);
.PP
\&\f(CW$Xmin\fR=$area\->GetXmin($y);
.PP
\&\f(CW$area\fR\->SetXmin($y,$x);
.PP
\&\f(CW$Xmax\fR=$area\->GetXmax($y);
.PP
\&\f(CW$area\fR\->SetXmax($y,$x);
.PP
\&\f(CW$area\fR\->AddRight($otherarea);
.PP
\&\f(CW$area\fR\->AddLeft($otherarea);
.PP
\&\f(CW$rootnode\fR=$area\->\fBGetRootNode()\fR;
.PP
\&\f(CW$area\fR\->MoveLowerLayers($x);
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The algorithm of \fBpedigree\fR\|(1) uses the notion of area: a part of
a picture taken by a tree or a clump. This package implements this
notion.
.PP
Each Area has \fBrootnode\fR \- the reference node for all calculations.
All distances are calculated as relative to the coordinates of the
\&\fBrootnode\fR.
.PP
The units are distances between the nodes in X and Y direction. The
Y axis is \fIdownward\fR: the earlier generations have smaller Y
coordinates.
.IP "\fBnew\fR(\fI\f(CI$rootnode\fI\fR);" 4
.IX Item "new($rootnode);"
Construct a new area around the given rootnode
.IP "\fBGetYmin\fR();" 4
.IX Item "GetYmin();"
Get the lower bound of the area.
.IP "\fBSetYmin\fR(\fI\f(CI$y\fI\fR);" 4
.IX Item "SetYmin($y);"
Set the lower bound of the area.
.IP "\fBGetYmax\fR();" 4
.IX Item "GetYmax();"
Get the upper bound of the area.
.IP "\fBSetYmax\fR(\fI\f(CI$y\fI\fR);" 4
.IX Item "SetYmax($y);"
Set the upper bound of the area.
.IP "\fBGetXmin\fR(\fI\f(CI$y\fI\fR);" 4
.IX Item "GetXmin($y);"
Get the minimal X coordinate of the area on the level Y.
.IP "\fBSetXmin\fR(\fI\f(CI$y\fI, \f(CI$x\fI\fR);" 4
.IX Item "SetXmin($y, $x);"
Set the minimal X coordinate of the area on the level Y.
.IP "\fBGetXmax\fR(\fI\f(CI$y\fI\fR);" 4
.IX Item "GetXmax($y);"
Get the maximal X coordinate of the area the the level Y.
.IP "\fBSetXmax\fR(\fI\f(CI$y\fI, \f(CI$x\fI\fR);" 4
.IX Item "SetXmax($y, $x);"
Set the maximal X coordinate of the area the the level Y.
.IP "\fBAddRight\fR(\fI\f(CI$otherarea\fI\fR);" 4
.IX Item "AddRight($otherarea);"
Add the new area \fI\f(CI$otherarea\fI\fR to the given area at the right. The
\&\*(L"other area\*(R" should have a root node that is relative to our root
node. The relative Y of the other root node is used, the relative
X is set.
.IP "\fBAddLeft\fR(\fI\f(CI$otherarea\fI\fR);" 4
.IX Item "AddLeft($otherarea);"
Add the new area \fI\f(CI$otherarea\fI\fR to the given area at the left. The
\&\*(L"other area\*(R" should have a root node that is relative to our root
node. The relative Y of the other root node is used, the relative
X is set.
.IP "\fBGetRootNode\fR();" 4
.IX Item "GetRootNode();"
Return the root node of the area.
.IP "\fBMoveLowerLayers\fR(\fI\f(CI$x\fI\fR);" 4
.IX Item "MoveLowerLayers($x);"
Shift the lower layers (>0) of the area in the X direction by \fI\f(CI$x\fI\fR
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
The calling program should define \fB\f(CB$main::DEBUG\fB\fR and set it to 0
or 1.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpedigree\fR\|(1), \fBPedigree\fR\|(3)
.SH "AUTHOR"
.IX Header "AUTHOR"
Boris Veytsman, Leila Akhmadeeva, 2006, 2007
Generated by dwww version 1.15 on Thu May 23 06:46:42 CEST 2024.