Skip to content

Commit ae1b508

Browse files
committed
Cool: start to document methods individually
1 parent 3dbfc41 commit ae1b508

File tree

1 file changed

+182
-1
lines changed

1 file changed

+182
-1
lines changed

lib/Type/Cool.pod

Lines changed: 182 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ what type they coerce to:
3434
abs Numeric
3535
conj Numeric
3636
sqrt Numeric
37-
sign Numeric
37+
sign Real
3838
rand Numeric
3939
sin Numeric
4040
asin Numeric
@@ -94,4 +94,185 @@ what type they coerce to:
9494
9595
=end table
9696
97+
=head1 Methods
98+
99+
=head2 method abs
100+
101+
method abs()
102+
103+
Coerces the invocant to L<Numeric|/type/Numeric> and returns the absolute
104+
value (that is, a non-negative number).
105+
106+
=head2 method conj
107+
108+
method conj()
109+
110+
Coerces the invocant to L<Numeric|/type/Numeric> and returns the
111+
L<complex|/type/Complex> conjugate (that is, the number with the sign of the
112+
imaginary part negated).
113+
114+
=head2 method sqrt
115+
116+
method sqrt()
117+
118+
Coerces the invocant to L<Numeric|/type/Numeric> and returns the square root,
119+
that is, a non-negative number that, when multiplied with itself, produces the
120+
original number.
121+
122+
=head2 method sign
123+
124+
method sign()
125+
126+
Coerces the invocant to L<Numeric|/type/Real> and returns its sign, that
127+
is, 0 if the number is 0, 1 for positive and -1 for negative values.
128+
129+
=head2 method rand
130+
131+
method rand()
132+
133+
Coerces the invocant to L<Num|/type/Num> and returns a pseudo-random value
134+
between zero and the number.
135+
136+
=head2 method sin
137+
138+
method sin()
139+
140+
Coerces the invocant to L<Numeric|/type/Numeric>, interprets it as radians,
141+
returns its L<sine|https://en.wikipedia.org/wiki/Sine>.
142+
143+
=head2 method asin
144+
145+
method asin()
146+
147+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
148+
L<arc-sine|https://en.wikipedia.org/wiki/Inverse_trigonometric_functions> in
149+
radians.
150+
151+
=head2 method cos
152+
153+
method cos()
154+
155+
Coerces the invocant to L<Numeric|/type/Numeric>, interprets it as radians,
156+
returns its L<sine|https://en.wikipedia.org/wiki/Cosine>.
157+
158+
=head2 method acos
159+
160+
method acos()
161+
162+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
163+
L<arc-cosine|https://en.wikipedia.org/wiki/Inverse_trigonometric_functions> in
164+
radians.
165+
166+
=head2 method tan
167+
168+
Coerces the invocant to L<Numeric|/type/Numeric>, interprets it as radians,
169+
returns its L<tangens|https://en.wikipedia.org/wiki/Tangent>.
170+
171+
=head2 method atan
172+
173+
method atan()
174+
175+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
176+
L<arc-tangens|https://en.wikipedia.org/wiki/Inverse_trigonometric_functions> in
177+
radians.
178+
179+
=head2 method atan2
180+
181+
method atan2($y = 1e0)
182+
183+
Coerces the invocant to L<Numeric|/type/Numeric>, and together with its
184+
argument, returns its two-argument
185+
L<arc-tangens|https://en.wikipedia.org/wiki/Inverse_trigonometric_functions> in
186+
radians.
187+
188+
=head2 method sec
189+
190+
method sec()
191+
192+
Coerces the invocant to L<Numeric|/type/Numeric>, interprets it as radians,
193+
returns its L<secans|https://en.wikipedia.org/wiki/Trigonometric_functions#Reciprocal_functions>,
194+
that is, the reciprocal of its cosine.
195+
196+
=head2 method asec
197+
198+
method asec()
199+
200+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
201+
L<arc-secans|https://en.wikipedia.org/wiki/Inverse_trigonometric_functions> in
202+
radians.
203+
204+
=head2 method cosec
205+
206+
method cosec()
207+
208+
Coerces the invocant to L<Numeric|/type/Numeric>, interprets it as radians,
209+
returns its L<cosecans|https://en.wikipedia.org/wiki/Trigonometric_functions#Reciprocal_functions>,
210+
that is, the reciprocal of its sine.
211+
212+
=head2 method acosec
213+
214+
method acosec()
215+
216+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
217+
L<arc-cosecans|https://en.wikipedia.org/wiki/Inverse_trigonometric_functions> in
218+
radians.
219+
220+
=head2 method cotan
221+
222+
method cotan()
223+
224+
Coerces the invocant to L<Numeric|/type/Numeric>, interprets it as radians,
225+
returns its L<cotangens|https://en.wikipedia.org/wiki/Trigonometric_functions#Reciprocal_functions>,
226+
that is, the reciprocal of its tangens.
227+
228+
=head2 method acotan
229+
230+
method acotan()
231+
232+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
233+
L<arc-cotangens|https://en.wikipedia.org/wiki/Inverse_trigonometric_functions> in
234+
radians.
235+
236+
=head2 method sinh
237+
238+
method sinh()
239+
240+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
241+
L<Sine hyperbolicus|https://en.wikipedia.org/wiki/Hyperbolic_function>.
242+
243+
=head2 method asinh
244+
245+
method asinh()
246+
247+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
248+
L<Inverse Sine hyperbolicus|https://en.wikipedia.org/wiki/Inverse_hyperbolic_function>.
249+
250+
=head2 method cosh
251+
252+
method cosh()
253+
254+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
255+
L<Cosine hyperbolicus|https://en.wikipedia.org/wiki/Hyperbolic_function>.
256+
257+
=head2 method acosh
258+
259+
method acosh()
260+
261+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
262+
L<Inverse Cosine hyperbolicus|https://en.wikipedia.org/wiki/Inverse_hyperbolic_function>.
263+
264+
=head2 method tanh
265+
266+
method tanh()
267+
268+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
269+
L<Tangens hyperbolicus|https://en.wikipedia.org/wiki/Hyperbolic_function>.
270+
271+
=head2 method atanh
272+
273+
method atanh()
274+
275+
Coerces the invocant to L<Numeric|/type/Numeric>, and returns its
276+
L<Inverse tangens hyperbolicus|https://en.wikipedia.org/wiki/Inverse_hyperbolic_function>.
277+
97278
=end pod

0 commit comments

Comments
 (0)