diff options
author | Karl Berry <karl@freefriends.org> | 2012-04-13 23:09:10 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-04-13 23:09:10 +0000 |
commit | 2d9b64e84ae06eba8f2f5d0e958f4f2f335de076 (patch) | |
tree | e49120eb2857c9aa1a11ca26cda4d3ba5db6b8b6 /Master/texmf-dist/doc/support/pedigree-perl/Pedigree/Area.3 | |
parent | 1c08c44c738be3e43fc4411812e7484d2471de7e (diff) |
new pstricks+script pedigree-perl (16mar12)
git-svn-id: svn://tug.org/texlive/trunk@25962 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/pedigree-perl/Pedigree/Area.3')
-rw-r--r-- | Master/texmf-dist/doc/support/pedigree-perl/Pedigree/Area.3 | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/Area.3 b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/Area.3 new file mode 100644 index 00000000000..9e58f6b46c9 --- /dev/null +++ b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/Area.3 @@ -0,0 +1,233 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.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" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" 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 "2007-07-08" "perl v5.8.8" "User Contributed Perl Documentation" +.SH "NAME" +Pedigree::Area \- Calculate the area taken by a tree or a clump +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +use Pedigree::Area; +.PP +$area = new Pedigree::Area($node); +.PP +$Ymin=$area\->\fIGetYmin()\fR; +.PP +$area\->SetYmin($Ymin); +.PP +$Ymax=$area\->\fIGetYmax()\fR; +.PP +$area\->SetYmax($Ymax); +.PP +$Xmin=$area\->GetXmin($y); +.PP +$area\->SetXmin($y,$x); +.PP +$Xmax=$area\->GetXmax($y); +.PP +$area\->SetXmax($y,$x); +.PP +$area\->AddRight($otherarea); +.PP +$area\->AddLeft($otherarea); +.PP +$rootnode=$area\->\fIGetRootNode()\fR; +.PP +$area\->MoveLowerLayers($x); +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The algorithm of \fIpedigree\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$rootnode\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$y\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$y\fR);" 4 +.IX Item "SetYmax($y);" +Set the upper bound of the area. +.IP "\fBGetXmin\fR(\fI$y\fR);" 4 +.IX Item "GetXmin($y);" +Get the minimal X coordinate of the area on the level Y. +.ie n .IP "\fBSetXmin\fR(\fI$y, \fI$x\fI\fR);" 4 +.el .IP "\fBSetXmin\fR(\fI$y, \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$y\fR);" 4 +.IX Item "GetXmax($y);" +Get the maximal X coordinate of the area the the level Y. +.ie n .IP "\fBSetXmax\fR(\fI$y, \fI$x\fI\fR);" 4 +.el .IP "\fBSetXmax\fR(\fI$y, \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$otherarea\fR);" 4 +.IX Item "AddRight($otherarea);" +Add the new area \fI$otherarea\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$otherarea\fR);" 4 +.IX Item "AddLeft($otherarea);" +Add the new area \fI$otherarea\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$x\fR);" 4 +.IX Item "MoveLowerLayers($x);" +Shift the lower layers (>0) of the area in the X direction by \fI$x\fR +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +The calling program should define \fB$main::DEBUG\fR and set it to 0 +or 1. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIpedigree\fR\|(1), \fIPedigree\fR\|(3) +.SH "AUTHOR" +.IX Header "AUTHOR" +Boris Veytsman, Leila Akhmadeeva, 2006, 2007 |