Forgot a help fix: Drag a dock's title bar, not divider, to reposition
[supercollider.git] / HelpSource / Classes / Float.schelp
blob117b2a605c79b43cf569e26023daadc52f77c755
1 Class:: Float
2 summary:: Floating point number
3 categories:: Math
5 description::
6 A 64 bit double precision floating point number. Float inherits most of its behaviour from its superclass.
8 ClassMethods::
10 method:: from32Bits
11 returns:: a new Float from a 32 bit word.
13 method:: from64Bits
14 returns:: a new Float from a 64 bit word.
16 InstanceMethods::
18 method:: do
19 iterates a link::Classes/Function:: from code::0:: to code::this-1::. See also: link::Classes/Integer#-do::, link::Classes/Collection#-do::
20 argument:: function
21 The function to iterate.
23 method:: reverseDo
24 iterates function from this-1 to 0
25 argument:: function
26 The function to iterate.
28 method:: coin
29 Perform a random test whose probability of success in a range from
30 zero to one is this and return the result.
31 returns:: a link::Classes/Boolean::
32 discussion::
33 code::
34 0.2.coin; // 20 % chance for true.
36 See also: link::Guides/Randomness::
38 method:: isFloat
39 returns:: code::true:: since this is a Float.
41 method:: asFloat
42 returns:: code::this:: since this is a Float.
44 method:: as32Bits
45 returns:: an Integer which is the bit pattern of this as a 32bit single precision float
47 method:: high32Bits
48 returns:: an Integer which is the bit pattern of high 32 bits of the 64 bit double precision floating point value
50 method:: low32Bits
51 returns:: an Integer which is the bit pattern of high 32 bits of the 64 bit double precision floating point value
53 method:: asStringPrec
54 Returns a string representation of the number, with the desired precision (i.e. number of significant figures).
55 discussion::
56 code::
57 // example:
59 pi.asStringPrec(3)
60 pi.asStringPrec(6)
61 (pi * 0.0001).asStringPrec(3)
62 7.4.asStringPrec(5)
63 7.4.asStringPrec(50)