Commit | Line | Data |
3fea05b9 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 |
2 | .\" |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
6 | .br |
7 | .if t .Sp |
8 | .ne 5 |
9 | .PP |
10 | \fB\\$1\fR |
11 | .PP |
12 | .. |
13 | .de Sp \" Vertical space (when we can't use .PP) |
14 | .if t .sp .5v |
15 | .if n .sp |
16 | .. |
17 | .de Vb \" Begin verbatim text |
18 | .ft CW |
19 | .nf |
20 | .ne \\$1 |
21 | .. |
22 | .de Ve \" End verbatim text |
23 | .ft R |
24 | .fi |
25 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
35 | . ds -- \(*W- |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
39 | . ds L" "" |
40 | . ds R" "" |
41 | . ds C` "" |
42 | . ds C' "" |
43 | 'br\} |
44 | .el\{\ |
45 | . ds -- \|\(em\| |
46 | . ds PI \(*p |
47 | . ds L" `` |
48 | . ds R" '' |
49 | 'br\} |
50 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
56 | . de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
58 | .. |
59 | . nr % 0 |
60 | . rr F |
61 | .\} |
62 | .\" |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
64 | .\" way too many mistakes in technical documents. |
65 | .hy 0 |
66 | .if n .na |
67 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
72 | . ds #H 0 |
73 | . ds #V .8m |
74 | . ds #F .3m |
75 | . ds #[ \f1 |
76 | . ds #] \fP |
77 | .\} |
78 | .if t \{\ |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
80 | . ds #V .6m |
81 | . ds #F 0 |
82 | . ds #[ \& |
83 | . ds #] \& |
84 | .\} |
85 | . \" simple accents for nroff and troff |
86 | .if n \{\ |
87 | . ds ' \& |
88 | . ds ` \& |
89 | . ds ^ \& |
90 | . ds , \& |
91 | . ds ~ ~ |
92 | . ds / |
93 | .\} |
94 | .if t \{\ |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
101 | .\} |
102 | . \" troff and (daisy-wheel) nroff accents |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
110 | .ds ae a\h'-(\w'a'u*4/10)'e |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
112 | . \" corrections for vroff |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
115 | . \" for low resolution devices (crt and lpr) |
116 | .if \n(.H>23 .if \n(.V>19 \ |
117 | \{\ |
118 | . ds : e |
119 | . ds 8 ss |
120 | . ds o a |
121 | . ds d- d\h'-1'\(ga |
122 | . ds D- D\h'-1'\(hy |
123 | . ds th \o'bp' |
124 | . ds Th \o'LP' |
125 | . ds ae ae |
126 | . ds Ae AE |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
130 | .\" |
131 | .IX Title "Template::Plugin::Math 3" |
132 | .TH Template::Plugin::Math 3 "2008-11-13" "perl v5.8.7" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
134 | Template::Plugin::Math \- Plugin providing mathematical functions |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
138 | \& [% USE Math %] |
139 | .Ve |
140 | .PP |
141 | .Vb 1 |
142 | \& [% Math.sqrt(9) %] |
143 | .Ve |
144 | .SH "DESCRIPTION" |
145 | .IX Header "DESCRIPTION" |
146 | The Math plugin provides numerous mathematical functions for use |
147 | within templates. |
148 | .SH "METHODS" |
149 | .IX Header "METHODS" |
150 | \&\f(CW\*(C`Template::Plugin::Math\*(C'\fR makes available the following functions from |
151 | the Perl core: |
152 | .IP "abs" 4 |
153 | .IX Item "abs" |
154 | .PD 0 |
155 | .IP "atan2" 4 |
156 | .IX Item "atan2" |
157 | .IP "cos" 4 |
158 | .IX Item "cos" |
159 | .IP "exp" 4 |
160 | .IX Item "exp" |
161 | .IP "hex" 4 |
162 | .IX Item "hex" |
163 | .IP "int" 4 |
164 | .IX Item "int" |
165 | .IP "log" 4 |
166 | .IX Item "log" |
167 | .IP "oct" 4 |
168 | .IX Item "oct" |
169 | .IP "rand" 4 |
170 | .IX Item "rand" |
171 | .IP "sin" 4 |
172 | .IX Item "sin" |
173 | .IP "sqrt" 4 |
174 | .IX Item "sqrt" |
175 | .IP "srand" 4 |
176 | .IX Item "srand" |
177 | .PD |
178 | .PP |
179 | In addition, if the Math::Trig module can be loaded, the following |
180 | functions are also available: |
181 | .IP "pi" 4 |
182 | .IX Item "pi" |
183 | .PD 0 |
184 | .IP "tan" 4 |
185 | .IX Item "tan" |
186 | .IP "csc" 4 |
187 | .IX Item "csc" |
188 | .IP "cosec" 4 |
189 | .IX Item "cosec" |
190 | .IP "sec" 4 |
191 | .IX Item "sec" |
192 | .IP "cot" 4 |
193 | .IX Item "cot" |
194 | .IP "cotan" 4 |
195 | .IX Item "cotan" |
196 | .IP "asin" 4 |
197 | .IX Item "asin" |
198 | .IP "acos" 4 |
199 | .IX Item "acos" |
200 | .IP "atan" 4 |
201 | .IX Item "atan" |
202 | .IP "acsc" 4 |
203 | .IX Item "acsc" |
204 | .IP "acosec" 4 |
205 | .IX Item "acosec" |
206 | .IP "asec" 4 |
207 | .IX Item "asec" |
208 | .IP "acot" 4 |
209 | .IX Item "acot" |
210 | .IP "acotan" 4 |
211 | .IX Item "acotan" |
212 | .IP "sinh" 4 |
213 | .IX Item "sinh" |
214 | .IP "cosh" 4 |
215 | .IX Item "cosh" |
216 | .IP "tanh" 4 |
217 | .IX Item "tanh" |
218 | .IP "csch" 4 |
219 | .IX Item "csch" |
220 | .IP "cosech" 4 |
221 | .IX Item "cosech" |
222 | .IP "sech" 4 |
223 | .IX Item "sech" |
224 | .IP "coth" 4 |
225 | .IX Item "coth" |
226 | .IP "cotanh" 4 |
227 | .IX Item "cotanh" |
228 | .IP "asinh" 4 |
229 | .IX Item "asinh" |
230 | .IP "acosh" 4 |
231 | .IX Item "acosh" |
232 | .IP "atanh" 4 |
233 | .IX Item "atanh" |
234 | .IP "acsch" 4 |
235 | .IX Item "acsch" |
236 | .IP "acosech" 4 |
237 | .IX Item "acosech" |
238 | .IP "asech" 4 |
239 | .IX Item "asech" |
240 | .IP "acoth" 4 |
241 | .IX Item "acoth" |
242 | .IP "acotanh" 4 |
243 | .IX Item "acotanh" |
244 | .IP "rad2deg" 4 |
245 | .IX Item "rad2deg" |
246 | .IP "rad2grad" 4 |
247 | .IX Item "rad2grad" |
248 | .IP "deg2rad" 4 |
249 | .IX Item "deg2rad" |
250 | .IP "deg2grad" 4 |
251 | .IX Item "deg2grad" |
252 | .IP "grad2rad" 4 |
253 | .IX Item "grad2rad" |
254 | .IP "grad2deg" 4 |
255 | .IX Item "grad2deg" |
256 | .PD |
257 | .PP |
258 | If the Math::TrulyRandom module is available, and you've got the time |
259 | to wait, the \f(CW\*(C`truly_random_number\*(C'\fR method is available: |
260 | .PP |
261 | .Vb 1 |
262 | \& [% Math.truly_random_number %] |
263 | .Ve |
264 | .SH "AUTHOR" |
265 | .IX Header "AUTHOR" |
266 | Andy Wardley <abw@wardley.org> <http://wardley.org/> |
267 | .SH "COPYRIGHT" |
268 | .IX Header "COPYRIGHT" |
269 | Copyright (C) 1996\-2007 Andy Wardley. All Rights Reserved. |
270 | .PP |
271 | This module is free software; you can redistribute it and/or |
272 | modify it under the same terms as Perl itself. |
273 | .SH "SEE ALSO" |
274 | .IX Header "SEE ALSO" |
275 | Template::Plugin |