PCSet and PSet instances have attributes which can be set via the methods listed below. ToneRow instances have some but not all of these methods and exceptions are noted after the method’s description.
Sets the modulus of the object to modulus. Without an argument, the current modulus is returned. The modulus must be greater than 0 and less than 32. Other values will raise an InvalidModulus exception.
Sets the default m that is used for Mm (and MI) for TTO’s and for determining the prime form if Mm is canonical (Refer to canon below for more). Without an argument, the current default_m is returned
If boolean is True, the object is now a multiset and will accept new pitches or pitch classes that are duplicates of existing set members. If boolean is False, the object is not a multiset and will not accept new pitches or pitch classes that are duplicates of existing members. Without an argument, the current multiset status is returned.
If boolean is True, the object will be considered an ordered set, and its __repr__ will show the pitches or pitch classes in the order they were added. Equivalence tests will consider the order of the set. If boolean is False, the object will be considered an unordered set, and its __repr__ will show the pitches or pitch classes in ascending numerical order regardless of the order in which they were added. Equivalence tests will not consider the order of the set, only its members. Unordered sets maintain order internally, so they do not loose the order of pitches/pitch classes when ordered is set to True.
canon(t, i, m) where t, i, and m are booleans.
Set the status of Tn, TnI, and TnM as canonical operators. These operators are used for determining set-class membership. The default is to use Tn/TnI, which would result from calling .canon(True, True, False). As an example, to use only Tn, as some theorists propose, use canon(True, False, False). To use Tn/TnI/TnM use .canon(True, True, True)
Returns a three tuple with the current status of canonical operators. If the canonical operators are Tn/TnM, the return would be (True, False, True)