Sieve | SuperCollider 3.13.0 Help

Description

Container for a list of ascending integers as 'points' or 'intervals'. For an introduction and more examples see Sieves and Psieve patterns.

Class Methods

Sieve.new(gen, limit)

Creates a new Sieve object in mode 'points'.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples.
limit	An integer limit, which is included when reached. If no limit is passed, returned integers might go up to default limit 65536.

Sieve.new_i(gen, limit)

Creates a new Sieve object in mode 'intervals'.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals.
limit	If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.new_o(gen, offset, limit)

Creates a new Sieve object in mode 'points' with offset.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples.
offset	An Integer.
limit	An integer limit, which is included when reached. If no limit is passed, returned integers might go up to default limit 65536.

Sieve.new_oi(gen, offset, limit)

Creates a new Sieve object in mode 'intervals' with offset.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals.
offset	An Integer.
limit	If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.union( ... data)

Creates a new Sieve object in mode 'points', generated by the union of sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. If no limit is passed, returned integers might go up to default limit 65536.

Sieve.union_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the union of sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.union_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the union of sets of integers.

Arguments:

... data

Alternating generators and integer offsets plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. If no limit is passed, returned integers might go up to default limit 65536.

Sieve.union_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the union of sets of integers.

Arguments:

... data

Alternating generators and integer offsets plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.sect( ... data)

Creates a new Sieve object in mode 'points', generated by the intersection of sets of integers.

Arguments:

... data

Sieve.sect_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the intersection of sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.sect_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the intersection of sets of integers.

Arguments:

... data

Sieve.sect_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the intersection of sets of integers.

Arguments:

... data

Alternating generators and integer offsets plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.symdif( ... data)

Creates a new Sieve object in mode 'points', generated by the symmetrical difference of sets of integers.

Arguments:

... data

Sieve.symdif_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the symmetrical difference of sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.symdif_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the symmetrical difference of sets integers.

Arguments:

... data

Sieve.symdif_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the symmetrical difference of sets of integers.

Arguments:

... data

Alternating generators and integer offsets plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.dif( ... data)

Creates a new Sieve object in mode 'points', generated by the difference of sets of integers.

Arguments:

... data

Sieve.dif_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the difference of sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.dif_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the difference of sets of integers.

Arguments:

... data

Sieve.dif_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the difference of sets of integers.

Arguments:

... data

Alternating generators and integer offsets plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

Sieve.limit

Sieve.limit = value

Get the global limit of Class Sieve. Set the global limit of Class Sieve to an integer value.

Inherited class methods

Instance Methods

.union( ... data)

Creates a new Sieve object in mode 'points', generated by the union of the receiver and sets of integers.

Arguments:

... data

|(gen)

Binary operator for instance method union. Creates a new Sieve object in mode 'points', generated by the union of the receiver and a generator.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. Returned integers might go up to default limit 65536.

.union_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the union of the receiver and sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

|*(gen)

Binary operator for instance method union_i. Creates a new Sieve object in mode 'intervals', generated by the union of the receiver and a generator.

Arguments:

gen

A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. Integer intervals might be collected up to default summation limit of 65536.

.union_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the union of the receiver and sets of integers.

Arguments:

... data

Alternating integer offsets and generators plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. If no limit is passed, returned integers might go up to default limit 65536.

.union_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the union of the receiver and sets of integers.

Arguments:

... data

Alternating integer offsets and generators plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

.sect( ... data)

Creates a new Sieve object in mode 'points', generated by the intersection of the receiver and sets of integers.

Arguments:

... data

&(gen)

Binary operator for instance method sect. Creates a new Sieve object in mode 'points', generated by the intersection of the receiver and a generator.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. Returned integers might go up to default limit 65536.

.sect_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the intersection of the receiver and sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

&*(gen)

Binary operator for instance method sect_i. Creates a new Sieve object in mode 'intervals', generated by the intersection of the receiver and a generator.

Arguments:

gen

.sect_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the intersection of the receiver and sets of integers.

Arguments:

... data

.sect_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the intersection of the receiver and sets of integers.

Arguments:

... data

Alternating integer offsets and generators plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

.symdif( ... data)

Creates a new Sieve object in mode 'points', generated by the symmetrical difference of the receiver and sets of integers.

Arguments:

... data

--(gen)

Binary operator for instance method symdif. Creates a new Sieve object in mode 'points', generated by the symmetric difference of the receiver and a generator.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. Returned integers might go up to default limit 65536.

.symdif_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the symmetrical difference of the receiver and sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

--*(gen)

Binary operator for instance method symdif_i. Creates a new Sieve object in mode 'intervals', generated by the symmetric difference of the receiver and a generator.

Arguments:

gen

.symdif_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the symmetrical difference of the receiver and sets of integers.

Arguments:

... data

Alternating integer offsets and generators plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, returned integers might go up to default limit 65536.

.symdif_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the symmetrical difference of the receiver and sets of integers.

Arguments:

... data

Alternating integer offsets and generators plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals are collected up to default summation limit of 65536.

.dif( ... data)

Creates a new Sieve object in mode 'points', generated by the difference of the receiver and sets of integers.

Arguments:

... data

-(gen)

Binary operator for instance method dif. Creates a new Sieve object in mode 'points', generated by the difference of the receiver and a generator.

Arguments:

gen	A generator. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce zero and its positive multiples. Returned integers might go up to default limit 65536.

.dif_i( ... data)

Creates a new Sieve object in mode 'intervals', generated by the difference of the receiver and sets of integers.

Arguments:

... data

Generators and an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

-*(gen)

Binary operator for instance method dif_i. Creates a new Sieve object in mode 'intervals', generated by the difference of the receiver and a generator.

Arguments:

gen

.dif_o( ... data)

Creates a new Sieve object in mode 'points' with offsets, generated by the difference of the receiver and sets of integers.

Arguments:

... data

.dif_oi( ... data)

Creates a new Sieve object in mode 'intervals' with offsets, generated by the difference of the receiver and sets of integers.

Arguments:

... data

Alternating integer offsets and generators plus an optional integer limit, wrapped into a Ref, which is included when reached. Allowed generators: Integers, Streams or Patterns producing intervals or Sieves itself. Integers and Stream/Pattern output must be strictly positive. Integers as generators produce constant intervals. If no limit is passed, integer intervals might be collected up to default summation limit of 65536.

.plot

Plot the Sieve's list.

.size

The Sieve's list size.

.toPoints

Convert the Sieve to mode 'points' and set first point to offset.

.toIntervals

Convert the Sieve to mode 'intervals' and set offset to first point.

.shift(addOffset)

Shift the Sieve's list by addOffset.

Arguments:

addOffset

An Integer.

>>(addOffset)

Binary operator for instance method shift. Shift the Sieve's list by addOffset.

Arguments:

addOffset

An Integer.

.shiftTo(targetOffset)

Shift the Sieve's list to targetOffset.

Arguments:

targetOffset

An Integer.

>>!(targetOffset)

Binary operator for instance method shiftTo. Shift the Sieve's list to targetOffset.

Arguments:

targetOffset

An Integer.

.shiftToZero

Shift the Sieve's list to offset zero.

.weakCopy

Returns a new Sieve with same list object.

.copy

Returns a new Sieve with copied list object.

.copyWith(seqCollection, withCheck: true)

Takes over mode and offset from receiver and passes an appropriate SequenceableCollection.

Arguments:

seqCollection	SequenceableCollection.
withCheck	Boolean. Determines if seqCollection is checked according to mode. Defaults to true.

.copyApplyTo(operator, withCheck: true)

Apply operator (Symbol of method or Function) to the Sieve's list and pass the result to a new Sieve with copied mode and offset.

Arguments:

operator	Symbol of method or Function.
withCheck	Boolean. Determines if result of the operation is checked according to mode. Defaults to true.

==(that)

Equality check. Sieves of different mode are equal iff the lists resulting from conversion are equal.

Arguments:

that	Object to compare.

.segmentGreaterEqual(lo)

Returns a new Sieve of mode 'points' with Integers greater than or equal lo.

Arguments:

Integer.

>=!(lo)

Binary operator for segmentGreaterEqual.

Arguments:

Integer.

.segmentGreater(lo)

Returns a new Sieve of mode 'points' with Integers greater than lo.

Arguments:

Integer.

>!(lo)

Binary operator for segmentGreater.

Arguments:

Integer.

.segmentLessEqual(hi)

Returns a new Sieve of mode 'points' with Integers less than or equal hi.

Arguments:

Integer.

<=!(hi)

Binary operator for segmentLessEqual.

Arguments:

Integer.

.segmentLess(hi)

Returns a new Sieve of mode 'points' with Integers less than hi.

Arguments:

Integer.

<!(hi)

Binary operator for segmentLess.

Arguments:

Integer.

.segmentBetweenEqual(lo, hi)

Returns a new Sieve of mode 'points' with Integers greater than or equal lo and less than or equal hi. This method is more efficient than applying segmentGreaterEqual plus segmentLessEqual.

Arguments:

lo	Integer.
hi	Integer.

<>=!(bounds)

Binary operator for segmentBetweenEqual.

Arguments:

bounds

Must be an array with integers lo and hi.

.segmentBetween(lo, hi)

Returns a new Sieve of mode 'points' with Integers greater than lo and less than hi. This method is more efficient than applying segmentGreater plus segmentLess.

Arguments:

lo	Integer.
hi	Integer.

<>!(bounds)

Binary operator for segmentBetween.

Arguments:

bounds

Must be an array with integers lo and hi.

.checkSymmetricPeriods

From extension in /home/stefan/.local/share/SuperCollider/downloaded-quarks/miSCellaneous_lib/Classes/Sieves/periods.sc

Checks the list of a Sieve for symmetric periods and returns an array [periods, symmetries, completions], where periods is the clumped list of periods, symmetries a corresponding array of Symbols and completions a corresponding array of Booleans, indicating if periods are complete. periods can contains Symbols 'sym', 'asym', 'quasisym' and 'identic'. See Sieves and Psieve patterns: 3b for a characterisation of these types. It is assumed that the receiver has a periodic list, changes between periodic and aperiodic segments are not detected, so also aperiodic prefixes of periodic lists.

.checkCharacteristicPeriod

From extension in /home/stefan/.local/share/SuperCollider/downloaded-quarks/miSCellaneous_lib/Classes/Sieves/periods.sc

Checks the first complete period based on the data returned by checkSymmetricPeriods. It returns an array [characteristicPeriod, offset, oddEven, symmetry], where characteristicPeriod denotes the first complete period, offset the index at which it starts in the receiver's list, oddEven one of the Symbols 'odd' and 'even' and symmetry the symmetry type as in checkSymmetricPeriods.

.plotCharacteristicPeriod

From extension in /home/stefan/.local/share/SuperCollider/downloaded-quarks/miSCellaneous_lib/Classes/Sieves/periods.sc

Plots the characteristic period returned by checkCharacteristicPeriod.

.list

Get the Sieve's list.

.offset

Get the Sieve's offset.

.mode

Get the Sieve's mode.

Inherited instance methods

Examples

// instantiation with 'new'

Sieve.new(1000)

Sieve.new(4, 20)

Sieve.new_i(4, 20)

Sieve.new_o(4, 1, 20)

Sieve.new_oi(4, 1, 20)

// instantiation with union
// collecting multiples resp. shifted multiples
// limit must be wrapped into a Ref object

Sieve.union(4, 7, `20)

Sieve.union_i(4, 7, `20)

Sieve.union_o(4, 1, 7, -1, `20)

Sieve.union_oi(4, 1, 7, -1, `20)

// instantiation with intersection
// collecting least common multiples (lcms) resp. shifted lcms

Sieve.sect(4, 3, `30)

Sieve.sect_i(4, 3, `30)

Sieve.sect_o(4, -1, 3, 0, `30)

Sieve.sect_oi(4, -1, 3, 0, `30)

// instantiation with symmetrical difference
// equals union without intersection, thus multiples without lcms

Sieve.symdif(4, 3, `30)

Sieve.symdif_i(4, 3, `30)

Sieve.symdif_o(4, -1, 3, 0, `30)

Sieve.symdif_oi(4, -1, 3, 0, `30)

// all take more arguments

Sieve.union(4, 5, 7, `30)

Sieve.symdif(4, 5, 7, `30)

// difference is not symmetrical, but subtrahends can be swapped

Sieve.dif(4, 3, 7, `30)

Sieve.dif(3, 4, 7, `30)

Sieve.dif(3, 7, 4, `30)

// corresponding instance methods and its binary operators

a = Sieve(4, 30);

b = Sieve(3, 30);

a.union(b)

a|b

a.union_i(b)

a|*b

// here first arg is offset of receiver

a.union_o(0, b, 100)

a.union_oi(0, b, 100)

a.sect(8)

a & 8

a.sect_i(8)

a &* 8

a.sect_o(1, b, 5)

a.sect_oi(1, b, 5)

a.symdif(b)

a -- b

a.symdif_i(b)

a --* b

a.dif(b)

a - b

a.dif_i(b)

a -* b

For conversion, segmentation and transformation examples see Sieves and Psieve patterns.

helpfile source: /home/stefan/.local/share/SuperCollider/downloaded-quarks/miSCellaneous_lib/HelpSource/Classes/Sieve.schelp
link::Classes/Sieve::

Sieve : Object Extension

Description

Class Methods

Sieve.newEmpty

Sieve.new(gen, limit)

Arguments:

Sieve.new_i(gen, limit)

Arguments:

Sieve.new_o(gen, offset, limit)

Arguments:

Sieve.new_oi(gen, offset, limit)

Arguments:

Sieve.union( ... data)

Arguments:

Sieve.union_i( ... data)

Arguments:

Sieve.union_o( ... data)

Arguments:

Sieve.union_oi( ... data)

Arguments:

Sieve.sect( ... data)

Arguments:

Sieve.sect_i( ... data)

Arguments:

Sieve.sect_o( ... data)

Arguments:

Sieve.sect_oi( ... data)

Arguments:

Sieve.symdif( ... data)

Arguments:

Sieve.symdif_i( ... data)

Arguments:

Sieve.symdif_o( ... data)

Arguments:

Sieve.symdif_oi( ... data)

Arguments:

Sieve.dif( ... data)

Arguments:

Sieve.dif_i( ... data)

Arguments:

Sieve.dif_o( ... data)

Arguments:

Sieve.dif_oi( ... data)

Arguments:

Sieve.limit

Sieve.limit = value

Inherited class methods

Instance Methods

.union( ... data)

Arguments:

|(gen)

Arguments:

.union_i( ... data)

Arguments:

|*(gen)

Arguments:

.union_o( ... data)

Arguments:

.union_oi( ... data)

Arguments:

.sect( ... data)

Arguments:

&(gen)

Arguments:

.sect_i( ... data)

Arguments:

&*(gen)

Arguments:

.sect_o( ... data)

Arguments:

.sect_oi( ... data)

Arguments:

.symdif( ... data)

Arguments:

--(gen)

Arguments:

.symdif_i( ... data)

Arguments:

--*(gen)

Arguments:

Sieve : Object
Extension