class library: SynthDef - lazy implementation of removeUGen
[supercollider.git] / HelpSource / Classes / Number.schelp
blob6d166b99c0b76f9412228099262369e0c70d9b3e
1 class:: Number
2 summary:: Mathematical quantity
3 categories:: Math
5 description::
6 Number represents a mathematical quantity.
8 instancemethods::
10 subsection:: Math
12 method:: +
13 Addition.
15 method:: -
16 Subtraction.
18 method:: *
19 Multiplication.
21 method:: /
22 Division.
24 method:: div
25 Integer division.
27 method:: %
28 Modulo.
30 method:: **
31 Exponentiation.
34 subsection:: Polar Coordinate Support
36 method:: rho
37 Answer the polar radius of the number.
39 method:: theta
40 Answer the polar angle of the number.
43 subsection:: Complex Number Support
45 method:: real
46 Answer the real part of the number.
48 method:: imag
49 Answer the imaginary part of the number.
52 subsection:: Conversion
54 method:: @
55 Create a new link::Classes/Point:: whose x coordinate is the receiver and whose y coordinate is aNumber.
57 method:: complex
58 Create a new link::Classes/Complex:: number whose real part is the receiver with the given imaginary part.
60 method:: polar
61 Create a new link::Classes/Polar:: number whose radius is the receiver with the given angle.
64 subsection:: Iteration
66 method:: for
67 Calls strong::function:: for numbers from this up to endval, inclusive, stepping each time by 1.
68 argument:: endval
69 a link::Classes/Number::.
70 argument:: function
71 a link::Classes/Function:: which is passed two arguments, the first which is an number from this to
72 argument:: endval, and the second which is a number from zero to the number of iterations minus one.
74 method:: forBy
75 Calls strong::function:: for numbers from this up to endval stepping each time by step.
76 argument:: endval
77 a link::Classes/Number::.
78 argument:: step
79 a link::Classes/Number::.
80 argument:: function
81 a link::Classes/Function:: which is passed two arguments, the first which is an number from this to
82 endval, and the second which is a number from zero to the number of iterations minus one.
84 method:: forSeries
85 Calls strong::function:: for numbers from this up to endval stepping each time by a step specified by second.
86 argument:: second
87 a link::Classes/Number::.
88 argument:: last
89 a link::Classes/Number::.
90 argument:: function
91 a link::Classes/Function:: which is passed two arguments, the first which is an number from this to
92 endval, and the second which is a number from zero to the number of iterations minus one.