org.daisy.dotify.common.splitter.SplitPointCost Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dotify.common Show documentation

Dotify Common

The newest version!

package org.daisy.dotify.common.splitter;

/**
 * Provides a cost function for a split point.
 *  
 * @author Joel Håkansson
 * @param  the type of split point unit
 *
 */
@FunctionalInterface
public interface SplitPointCost {

	/**
	 * Returns the cost of breaking after the unit with the specified index
	 * @param units the units
	 * @param index the index of the breakpoint unit
	 * @param limit the maximum length to consider
	 * @return returns the cost
	 */
	public double getCost(SplitPointDataSource units, int index, int limit);
	
}