File: //usr/local/ssl/local/share/man/man3/Math::Fibonacci::Phi.3
.\" 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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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 "Phi 3"
.TH Phi 3 "2005-08-26" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Math::Fibonacci::Phi \- Perl extension for calculating Phi and phi for Fibonacci numbers.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use Math::Fibonacci::Phi;
\& use Math::Fibonacci::Phi qw(Phi phi);
\& use Math::Fibonacci::Phi ':all'
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Sh "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default. Everything in the function section below can be imported and ':all' will do all functions.
.SH "Functions"
.IX Header "Functions"
.Sh "Phi($fn)"
.IX Subsection "Phi($fn)"
Calculates and returns Phi (The Golden Number) for the given Fibonacci Number. It returns undef if the argument is not part of the Fibonacci sequence.
.Sh "phi($fn)"
.IX Subsection "phi($fn)"
Calculates and returns phi (opposite of Phi, antiPhi) for the given Fibonacci Number. It returns undef if the argument is not part of the Fibonacci sequence.
.Sh "series_Phi($n)"
.IX Subsection "series_Phi($n)"
Returns a hashref of the first \f(CW$n\fR Fibonacci Numbers where each key is the Fibonacci and the value is its Phi.
.Sh "series_phi($n)"
.IX Subsection "series_phi($n)"
Returns a hashref of the first \f(CW$n\fR Fibonacci Numbers where each key is the Fibonacci and the value is its phi.
.Sh "term_Phi($nth)"
.IX Subsection "term_Phi($nth)"
Returns Phi for the \f(CW$nth\fR Fibonacci number.
.Sh "term_phi($nth)"
.IX Subsection "term_phi($nth)"
Returns phi for the \f(CW$nth\fR Fibonacci number.
.Sh "super_series($n)"
.IX Subsection "super_series($n)"
Returns a hashref of the first \f(CW$n\fR Fibonacci Numbers where each key is the Fibonacci and the value is a hashref that has these 3 keys:
.PP
.Vb 1
\& 'Phi', 'phi', and 'position'
.Ve
.PP
\&'position' is its location in the sequence (\s-1IE\s0 same number as the argument you'd give to \fIterm_Phi()\fR or \fIterm_phi()\fR )
.SH "Format Options"
.IX Header "Format Options"
.Sh "$Math::Fibonacci::Phi::Precision"
.IX Subsection "$Math::Fibonacci::Phi::Precision"
This can be a number from 1 \- 14 to specify the decimal precision you'd like.
.PP
.Vb 4
\& use Math::Fibonacci::Phi 'Phi';
\& print Phi(5), "\en";
\& $Math::Fibonacci::Phi::Precision = 7;
\& print Phi(5), "\en";
.Ve
.PP
result is:
.PP
.Vb 2
\& 1.66666666666667
\& 1.6666667
.Ve
.Sh "$Math::Fibonacci::Phi::TrailingZeros"
.IX Subsection "$Math::Fibonacci::Phi::TrailingZeros"
If \f(CW$Math::Fibonacci::Phi::Precision\fR is set then you can set this to true to keep the trailing zeros.
.PP
.Vb 5
\& use Math::Fibonacci::Phi 'Phi';
\& $Math::Fibonacci::Phi::Precision = 5;
\& print Phi(3), "\en";
\& $Math::Fibonacci::Phi::TrailingZeros=1
\& print Phi(3), "\en";
.Ve
.PP
result is:
.PP
.Vb 2
\& 1.5
\& 1.50000
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Math::Fibonacci
.SH "AUTHOR"
.IX Header "AUTHOR"
Daniel Muey, <http://drmuey.com/cpan_contact.pl>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2005 by Daniel Muey
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.