Object

Read in an object from a text archive.( a = Array.fill(100, { 100.rand }); a.writeArchive(PathName.tmp ++ "myArray"); b = Object.readArchive(PathName.tmp ++ "myArray"); a == b; // true ) ///////// // closed Function ( f = { 1 + 2 }; f.writeArchive(PathName.tmp ++ "myFunc"); // succeeds ) // open Function ( var num; num = 2; f = { num + 2 }; f.writeArchive(PathName.tmp ++ "myFunc"); // fails )

Arguments:

Create a new instance. The creation of new instances of any Object actually happens in this method (or with newCopyArgs) when it is called by a child class. See Writing Classes.

Creates a new instance and copies the arguments to the instance variables in the order that the variables were defined. If the superclass's new method requires arguments, the first arguments passed to newCopyArgs will be passed on to that method, and the following arguments will be copied to this class's instance variables. Class variables are ignored.MyClass { var a, b, c; *new { arg arg1, arg2, arg3; // will copy arg1, arg2, arg3 to variables a, b, c ^super.newCopyArgs(arg1, arg2, arg3); } }

Answer the class of the receiver.5.class;

Answer a Boolean whether the receiver understands the message selector.5.respondsTo('+'); // true 5.respondsTo('indexOf'); // false

Arguments:

Answer a Boolean indicating whether the receiver is a direct or indirect instance of aClass. Use of this message in code must be questioned, because it often indicates a missed opportunity to exploit object polymorphism.5.isKindOf(Number); // true 5.isKindOf(String); // false

Answer a Boolean whether the receiver is a direct instance of aClass. Use of this message in code is almost always a design mistake.5.isMemberOf(Number); // false 5.isMemberOf(Integer); // true

Different classes respond to this message differently. Object always returns 0.

Make a copy of the receiver. The implementation of this message depends on the object's class. In class Object, copy calls shallowCopy.

Makes a copy of the object. The copy's named and indexed instance variables refer to the same objects as the receiver.

Recursively copies the object and all of the objects contained in the instance variables, and so on down the structure. This method works with cyclic graphs.

If object is immutable then return a shallow copy, else return receiver.

Returns a similar new Object of a different class.[1, 2, 3].as(Set); Pwhite(0.0, 1.0, 10).as(Set);

Returns an Array with the receiver, unless it is an Array already.[1, 2, 3].asArray; 5.asArray;

Returns a String that can be interpreted to reconstruct a copy of the receiver. For the complementary method, see String: -interpret.a = { 10.do { 10.postln } }; a.asCompileString.postcs; a.postcs;

Deprecated. Use asInteger instead.

Shorthand for -asCompileString.{ 10.do { 10.postln } }.cs; "Strings don't post with surrounding quotes.".cs;

Write an object to disk as a text archive.

Arguments:

Answer whether the receiver equals anotherObject. The definition of equality depends on the class of the receiver. The default implementation in Object is to answer if the two objects are identical.

Answer whether the receiver is the exact same object as anotherObject.5.0 === 5; // false "worth trying" === "worth trying"; // not identical 'worth trying' === 'worth trying'; // identical (symbols are unique)

Answer whether the receiver does not equal anotherObject. The default implementation in Object is to determine '==' for the two operands and negate this result. (see below).

Answer whether the receiver is not identical to anotherObject.

A lazy equality operator. For typical object types, |==| behaves the same as Object: -==. For AbstractFunction and its subclasses (including Pattern and UGen), it does not perform the equality check immediately, but rather composes an equality operation to be performed at the time of evaluating the resulting function or stream.1 |==| 1 // true Pseq([1], inf) == 1 // false (because "a Pseq" is not 1) Pseq([1], inf) |==| 1 // a Pbinop (Pseq([1], inf) |==| 1).asStream.next // Pbinop evaluates to true

A lazy inequality operator, defined as not(this |==| that). See Object: -|==|.

Returns the degree of equality between two objects with regard to a given precision. The compared objects must support .max, subtraction, and division.5.0.fuzzyEqual(5.0, 0.5); // 1.0 - full equality 5.25.fuzzyEqual(5.0, 0.5); // 0.5 - 50% equality 4.75.fuzzyEqual(5.0, 0.5); // 0.5 - 50% equality 5.9.fuzzyEqual(5.0, 0.5); // 0.0 - no equality

Resolve to a Boolean within your precision threshold by checking whether the returned degree of equality is above 0.0.( // Cartesian to Polar and back, accumulating precision error var x = 3.0, y = 5.0; var hypot = hypot(y, x); var angle = atan2(y, x); var polar = Polar(hypot, angle); var xFromPolar = polar.asPoint.x; var equalWithin = 1e-5; postf( "Exactly equal? %\n" "Fuzzily equal? %\n", x == xFromPolar, fuzzyEqual(x, xFromPolar, equalWithin) > 0 ); [x, xFromPolar] )

Returns:

Tests if two Objects (of the same class) are the same in a certain respect: It returns true if instVarNames are equal in both. If none are given, all instance variables are tested (see also: -instVarHash)a = Pseq([1, 2, 3], inf); b = Pseq([100, 200, 300], inf); a.compareObject(b, [\repeats]); // true a.compareObject(b, [\list]); // false

Answer a code used to index into a hash table. This is used by Dictionary and Set and their subclasses to implement fast object lookup. Objects which are equal == should have the same hash values. Whenever == is overridden in a class, hash should be overridden as well.a = "worth trying"; b = "worth trying"; a.hash; b.hash;

Answer a code used to index into a hash table. This method is implemented by a primitive and is not overridden. Objects which are identical === should have the same hash values.a = "worth trying"; b = "worth trying"; a.identityHash; b.identityHash;

Returns a combined hash value for the object's instance variables and the object's class. If none are given, all instance variables are tested (see also: -compareObject).a = Pseq([1, 2, 3], inf); b = Pseq([100, 200, 300], inf); a.instVarHash([\repeats]); // same b.instVarHash([\repeats]); a.instVarHash([\list]); // different b.instVarHash([\list]); a = Pseq([1, 2, 3], inf); b = Prand([1, 2, 3], inf); a.instVarHash([\list]); // different b.instVarHash([\list]);

Answer a Boolean indicating whether the receiver is nil.

Answer a Boolean indicating whether the receiver is not nil.

Answer a Boolean indicating whether the receiver is an instance of Number.

Answer a Boolean indicating whether the receiver is an instance of Integer.

Answer a Boolean indicating whether the receiver is an instance of Float.

If the receiver is nil then answer anObject, otherwise answer the receiver.

If the receiver is nil, evaluate the Function and return the result.

If the receiver is not nil, evaluate the Function passing in the receiver as argument and return the result, otherwise return nil.

Discussion:

This method allow building up chains of actions to be performed on an object (possibly across several methods) without having to check if the object is nil or not. After all the desired actions are performed, -?? can be used to check if result the result is nil and supply a default value in that case.

Examples:x !? ( _ * 3 ) ?? { "It was a nil, so I give a default value".postln; Point(1,1) }

With x = nil, this will result in:

It was a nil, so I give a default value
Point( 1, 1 )

But if x = Point(3,4), the result will be:

Point( 9, 12 )

Nested nil checks:( x = nil; y = Point(3,4); z = Point(5,6); x !? { |x| y !? { |y| z !? { |z| x.rho * y.rho * z.rho } } } )

Results in nil( x = Point(1,2); y = Point(3,4); z = Point(5,6); x !? { |x| y !? { |y| z !? { |z| x.rho * y.rho * z.rho } } } )

Results in 87.321245982865

Returns true if receiver has a direct reference to obj.a = 9; b = [1, a, 6, 8]; c = [1, b, 5]; c.pointsTo(b); // true c.pointsTo(a); // false

Returns true if receiver is mutable.a = #[1, 2, 3]; b = [1, 2, 3]; a.mutable; // false b.mutable; // true

Returns true if receiver is frozen.

Object implements a switch method which allows for conditional evaluation with multiple cases. These are implemented as pairs of test objects (tested using if this == test.value) and corresponding functions to be evaluated if true. In order for switch to be inlined (and thus be as efficient as nested if statements) the matching values must be literal Integers, Floats, Chars, Symbols and the functions must have no variables or arguments.

Discussion:

or:( var x, z; z = [0, 1, 1.1, 1.3, 1.5, 2]; x = switch (z.choose) {1} { \no } {1.1} { \wrong } {1.3} { \wrong } {1.5} { \wrong } {2} { \wrong } {0} { \true }; x.postln; )

The selector argument must be a Symbol. Sends the method named by the selector with the given arguments to the receiver.

If the first argument is an Array or List, this method behaves like performMsg. However, this usage is discouraged, and performMsg ought to be used instead.

The selector argument must be a Symbol. Sends the method named by the selector with the given arguments to the receiver. If the last argument is a List or an Array, then its elements are unpacked and passed as arguments.a = { |a, b, c| postf("% plus % plus % is %\n", a, b, c, a + b + c); "" }; a.performList(\value, [1, 2, 3]);

The argument must be a List or Array whose first element is a Symbol representing a method selector. The remaining elements are unpacked and passed as arguments to the method named by the selector.a = { |a, b, c| postf("% plus % plus % is %\n", a, b, c, a + b + c); "" }; a.performMsg([\value, 1, 2, 3]);

Arguments:

Discussion:

Arguments:

Discussion:

Like 'perform', but tryPerform passes the method to the receiver only if the receiver understands the method name. If the receiver doesn't implement that method, the result is nil. Note that this does not catch errors like 'try' does (see Exception). If the receiver does have a matching method but that method throws an error, execution will halt. But, 'tryPerform' is faster than 'try'.(a: 1, b: 2, c: 3).tryPerform(\keysValuesDo, { |key, value| [key, value].postln }); // Set does not understand keysValuesDo -- result is nil Set[1, 2, 3].tryPerform(\keysValuesDo, { |key, value| [key, value].postln }); // Error occurs within keysValuesDo -- error is thrown back to halt execution (a: 1, b: 2, c: 3).tryPerform(\keysValuesDo, { |key, value| [key, value].flippityblargh });

Like perform, superPerform calls a method, however it calls the method on the superclass. selector: A Symbol representing a method selector. args: Method arguments.

Like performList, superPerformList calls a method, however it calls the method on the superclass. selector: A Symbol representing a method selector. args: Method arguments. If the last argument is a List or an Array, then its elements are unpacked and passed as arguments.

Perform selector with multichannel expansion. See also: Multichannel Expansion.

Arguments:

Discussion:

Add a unique method.a = 5; a.addUniqueMethod(\sayHello, { |to| "hello " ++ to ++ ", I am 5" }); a.sayHello;

Remove a unique method.a.removeUniqueMethod(\sayHello); a.sayHello;

Remove all unique methods of an Object.

Add aDependant to the receiver's list of dependants.

Remove aDependant from the receiver's list of dependants.

Returns an IdentitySet of all dependants of the receiver.

Notify the receiver's dependants that the receiver has changed. The object making the change should be passed as theChanger.

An object upon which the receiver depends has changed. theChanged is the object that changed and theChanger is the object that made the change.

Remove all dependants of the receiver. Any object that has had dependants added must be released in order for it or its dependants to get garbage collected.

Throws the receiver as an Exception, which may or may not be caught and handled by any enclosing Function.

Throws a SubclassResponsibilityError. Use this to indicate that this method should be defined in all subclasses of the receiver.

Discussion:

Throws a ShouldNotImplementError. Use this to indicate that this inherited method should not be defined or used in the receiver.

Throws a DeprecatedError. Use this to indicate that the enclosing method has been replaced by a better one (possibly in another class), and that it will likely be removed in the future. Unlike other errors, DeprecatedError only halts execution if Error.debug == true. In all cases it posts a warning indicating that the method is deprecated and what is the recommended alternative.

Discussion:

Print a string representation of the receiver to the post window."hello".post; "hello".post; "";

Print a string representation of the receiver followed by a newline."hello".postln; "hello".postln; "";

Print a string representation of the receiver preceded by comments."hello".postc; "hello".postc; "";

Print a string representation of the receiver preceded by comments, followed by a newline."hello".postcln; "hello".postcln; "";

Print the compile string representation of the receiver, followed by a newline."hello".postcs; "hello".postcs; "";

Print a detailed low level representation of the receiver to the post window.List[1, 2, 3].dump;

Posts garbage collector information in a table format.

Discussion:

• flips: the number of times the GC "flipped", i.e. when it finished incremental scanning of all reachable objects
• collects: the number of partial collections performed
• nalloc: total number of allocations
• alloc: total allocation in bytes
• grey: the number of "grey" objects, i.e. objects that point to reachable objects and are not determined to be (un)reachable yet

Then for each size class: numer of black, white and free objects, total number of objects and the total set size.flips 241 collects 689096 nalloc 40173511 alloc 322496998 grey 346541 0 bwf t sz: 882 0 368573 369455 2955640 1 bwf t sz: 6197 122 5702377 5708696 91339136 2 bwf t sz: 947 4 1500009 1500960 48030720 3 bwf t sz: 8056 65201 301800 375057 24003648 4 bwf t sz: 4047 145 3457 7649 979072 5 bwf t sz: 422 1 431 854 218624 6 bwf t sz: 124 2 72 198 101376 7 bwf t sz: 153504 1 0 153505 157189120 8 bwf t sz: 22 0 0 22 45056 9 bwf t sz: 5 0 0 5 20480 10 bwf t sz: 5 0 0 5 40960 12 bwf t sz: 2 0 0 2 65536 13 bwf t sz: 1 0 0 1 65536 19 bwf t sz: 1 0 3 4 16777216 tot bwf t sz: 174215 65476 7876722 8116413 341832120

You can also query the amount of free memory with Object.totalFree and dump the currently grey objects with Object.dumpGrey. More memory status methods are: largestFreeBlock, gcDumpSet, and gcSanity.

Object evaluates the function with itself as an argument, returning the result. Different classes respond to this message differently.

Discussion:

Object iterates by the message do, sent to the receiver. This method is used internally by list comprehensions.

Duplicates the receiver n times, returning an array of n copies. Different classes respond to this message differently. The shortcut "!" can be used in place.

Discussion:

This method is called by a Clock on which the object was scheduled when its scheduling time is up. It calls -next, passing on the scheduling time in beats as an argument.

Arguments:

Does nothing; simply returns the object itself.

Does nothing; simply returns the object itself.

Must be called from inside a Routine. Yields control to the calling thread. The receiver is the result passed to the calling thread's method. The result of yield will be the value passed to the Routine's next method the next time it is called.

Must be called from inside a Routine. Yields control to the calling thread. The receiver is the result passed to the calling thread's method. The Routine is reset so that the next time it is called, it will start from the beginning. yieldAndReset never returns within the Routine.

Must be called from inside a Routine. Yields control to the calling thread. The receiver is the result passed to the calling thread's method. The Routine, when called subsequently will always yield the receiver until it is reset. alwaysYield never returns within the Routine.

Yields the receiver

within a routine, return values (the receiver) until this time is over. (see also Routine: -play) Time is measured relative to the thread's clock.a = Routine { 1.yield; 0.idle(3); 400.yield }; fork { loop { a.next.postln; 0.5.wait } };

Returns a OneShotStream with the receiver as return value.a = 9.iter; a.nextN(4);

Embeds the receiver in the stream n times (default: inf), each time resetting it.a = 9.cyc(2); a.nextN(4);

Calls next with the receiver n times only (default: 1), yielding the result.a = (10..0).iter.fin(2); a.nextN(4);

Repeatedly embeds the receiver in the stream using a Pn (may thus be used for patterns and other objects alike)a = (0..3).iter.repeat(2); a.nextN(9)

Indefinitely embeds the receiver in the streama = (0..3).iter.loop; a.nextN(9)

Returns an array with the results of calling -next a given number of times

Arguments:

Dependent on whether an object that is passed to a stream the object will behave differently: it may be embedded in the stream or used as stream directly.

This method allows to switch between the two behaviors. For efficiency, the subclasses Pattern and Stream implement this method simply as "asStream".

Arguments:

The messages Function: -addFunc Function: -addFuncTo, Function: -removeFunc, Function: -removeFuncFrom are supported by Object.

The messages SequenceableCollection: -instill and SequenceableCollection: -obtain, are supported by Object.

Lineraly interpolate between this and argumentblend(10, 100, 0.3); blend([1, 2, 3], [1, 3, 4], 0.5); blend((a: 6, b: 7), (a: 0, b: [1, 2], c: 9), 0.5);