pctheory.contour

com(a: int, b: int)

The COM function for two contour pitches. Returns 1 if a < b, 0 if a == b, -1 if a > b

Parameters:
  • a (int) – A contour pitch

  • b (int) – A contour pitch

Returns:

The comparison result

Return type:

int

com_mx(cseg1: list, cseg2: list)

Generates a COM matrix for two contour segments (ordered contour pitch successions).

Parameters:
  • cseg1 (list) – A contour segment

  • cseg2 (list) – A contour segment

Returns:

The COM matrix

Return type:

list

invert(cseg: list)

Inverts a contour segment

Parameters:

cseg (list) – The contour segment

Returns:

The inverted contour segment

Return type:

list

retrograde(cseg: list)

Retrogrades a contour segment

Parameters:

cseg (list) – The contour segment

Returns:

The retrograded contour segment

Return type:

list

rotate(cseg: list, n: int)

Rotates a contour segment

Parameters:
  • cseg (list) – The contour segment

  • n (int) – The index of rotation

Returns:

The rotated contour segment

Return type:

list

simplify(cseg: list)

Simplifies a contour segment

Parameters:

cseg (list) – A contour segment

Returns:

A simplified form of the contour segment

Return type:

list