PitchCollection explanation of what PitchCollection is and/or does

Inherits from: Object

More detailed prose description of PitchCollection.

See also: Object [some other help files]

Some Important Issues Regarding PitchCollection (optional)

Explanation of the issues. For more information see Nil and [some other help files].

Creation / Class Methods

*new (pitchCollection, tonic, octaveSize)

Short prose description of method.

pitchCollection - Explanation of pitchCollection. Default value is nil. Other information.

tonic - Explanation of tonic. Default value is nil. Other information.

octaveSize - Explanation of octaveSize. Default value is 12. Other information.

// inline example

g = PitchCollection.new;

g.doSomething; // explanation

g.cleanUpMethod;

*major (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.major;

g.doSomething; // explanation

g.cleanUpMethod;

*minor (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.minor;

g.doSomething; // explanation

g.cleanUpMethod;

*natMinor (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.natMinor;

g.doSomething; // explanation

g.cleanUpMethod;

*harmMinor (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.harmMinor;

g.doSomething; // explanation

g.cleanUpMethod;

*ionian (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.ionian;

g.doSomething; // explanation

g.cleanUpMethod;

*dorian (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.dorian;

g.doSomething; // explanation

g.cleanUpMethod;

*phrygian (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.phrygian;

g.doSomething; // explanation

g.cleanUpMethod;

*lydian (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.lydian;

g.doSomething; // explanation

g.cleanUpMethod;

*mixolydian (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.mixolydian;

g.doSomething; // explanation

g.cleanUpMethod;

*aeolian (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.aeolian;

g.doSomething; // explanation

g.cleanUpMethod;

*locrian (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.locrian;

g.doSomething; // explanation

g.cleanUpMethod;

*chromatic (tonic)

Short prose description of method.

tonic - Explanation of tonic. Default value is nil. Other information.

// inline example

g = PitchCollection.chromatic;

g.doSomething; // explanation

g.cleanUpMethod;

Accessing Instance and Class Variables

sortedBase

Explanation including the type of sortedBase and a link to its help file.

Default value is nil.

octaveSize

Explanation including the type of octaveSize and a link to its help file.

Default value is nil.

pitchCollection

Explanation including the type of pitchCollection and a link to its help file.

Default value is nil.

pitchBase

Explanation including the type of pitchBase and a link to its help file.

Default value is nil.

tonic

Explanation including the type of tonic and a link to its help file.

Default value is nil.

Doing Some Task (optional)

A short bit of prose explaining something about the task.

init

Short prose description of method.

// inline example

g = PitchCollection.init;

g.doSomething; // explanation

g.cleanUpMethod;

filterKeynum (keynum)

Short prose description of method.

keynum - Explanation of keynum. Default value is nil. Other information.

// inline example

g = PitchCollection.filterKeynum;

g.doSomething; // explanation

g.cleanUpMethod;

choose

Short prose description of method.

// inline example

g = PitchCollection.choose;

g.doSomething; // explanation

g.cleanUpMethod;

wchoose (weights)

Short prose description of method.

weights - Explanation of weights. Default value is nil. Other information.

// inline example

g = PitchCollection.wchoose;

g.doSomething; // explanation

g.cleanUpMethod;

chunk (start, end)

Short prose description of method.

start - Explanation of start. Default value is 0. Other information.

end - Explanation of end. Default value is nil. Other information.

// inline example

g = PitchCollection.chunk;

g.doSomething; // explanation

g.cleanUpMethod;

add (aPitchClass)

Short prose description of method.

aPitchClass - Explanation of aPitchClass. Default value is nil. Other information.

// inline example

g = PitchCollection.add;

g.doSomething; // explanation

g.cleanUpMethod;

invert (aPitchClass)

Short prose description of method.

aPitchClass - Explanation of aPitchClass. Default value is nil. Other information.

// inline example

g = PitchCollection.invert;

g.doSomething; // explanation

g.cleanUpMethod;

insert (position, aPitchClass)

Short prose description of method.

position - Explanation of position. Default value is 0. Other information.

aPitchClass - Explanation of aPitchClass. Default value is nil. Other information.

// inline example

g = PitchCollection.insert;

g.doSomething; // explanation

g.cleanUpMethod;

transpose (aPitchInterval, direction)

Short prose description of method.

aPitchInterval - Explanation of aPitchInterval. Default value is nil. Other information.

direction - Explanation of direction. Default value is 'up'. Other information.

// inline example

g = PitchCollection.transpose;

g.doSomething; // explanation

g.cleanUpMethod;

Examples

// what this example does

e = PitchCollection.new;

e.instanceMethod(someObject);

e.cleanUp;

...