Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / Boolean.schelp
blobedeaacf707d89c3f029e1df3e52e3b5c390724c4
1 class::Boolean
2 summary:: abstract class whose instances represent a logical value
3 categories::Core
4 related:: Reference/Control-Structures
6 description::
7 Boolean is the superclass of link::Classes/True:: and link::Classes/False:: which are the concrete realizations.
8 In code True and False are represented by the literal values code::true:: and code::false::.
10 instanceMethods::
12 private:: while
13 private:: storeOn
14 private:: trace
15 private:: printOn
16 private:: archiveAsCompileString
18 method::xor
20 returns:: the exclusive or of the receiver and another Boolean.
22 method::and
24 If the receiver is true then answer the evaluation of function.
25 If the receiver is false then function is not evaluated and the message answers false.
27 method::or
29 If the receiver is false then answer the evaluation of function.
30 If the receiver is true then function is not evaluated and the message answers true.
32 method::&&
34 returns:: true if the receiver is true and aBoolean is true.
36 method::||
38 returns:: true if either the receiver is true or aBoolean is true.
40 method::nand
42 returns:: true unless both the operands are true (Sheffer stroke)
44 method::not
46 returns:: true if the receiver is false, and false if the receiver is true.
48 method::if
50 If the receiver is true, answer the evaluation of the trueFunc. If the receiver is false, answer the evaluation of the falseFunc.
52 method::asInteger
53 method::binaryValue
55 returns:: 1 if the receiver is true, and 0 if the receiver is false.
57 method::asBoolean
58 method::booleanValue
59 Returns:: The receiver. The same message is understood by link::Classes/SimpleNumber:: and can be used to convert it to boolean.
61 method::keywordWarnings
63 turn on/off warnings if a keyword argument is not found