[qu2cu] Document what costs parameter is

This commit is contained in:
Behdad Esfahbod 2023-02-20 08:22:35 -07:00
parent b3be1883c8
commit 837448d428

View File

@ -219,6 +219,15 @@ class Solution(NamedTuple):
def spline_to_curves(q, costs, tolerance=0.5, all_cubic=False):
"""
q: quadratic spline with alternating on-curve / off-curve points.
costs: cumulative list of encoding cost of q in terms of number of
points that need to be encoded. Implied on-curve points do not
contribute to the cost. If all points need to be encoded, then
costs will be range(len(q)+1).
"""
assert len(q) >= 3, "quadratic spline requires at least 3 points"
# Elevate quadratic segments to cubic