pl.edu.agh.age.compute.ogr

Class RulerUtils

java.lang.Object

pl.edu.agh.age.compute.ogr.RulerUtils

public final class RulerUtils
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RulerUtils()

Method Summary

Modifier and Type	Method and Description
static int	calculateViolations(Ruler ruler) Calculates the ruler overall violation.
static java.util.List<java.lang.Integer>	getMeasurableDistances(Ruler ruler, boolean includeOneLengthDistance) Gets the measurable distances.
static boolean	isValid(Ruler ruler) Checks if a given ruler is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RulerUtils

private RulerUtils()

Method Detail

isValid

public static boolean isValid(Ruler ruler)

Checks if a given ruler is valid.

Parameters:

ruler - the ruler

Returns:

true, if ruler is valid (all measurable distances are distinct)

calculateViolations

public static int calculateViolations(Ruler ruler)

Calculates the ruler overall violation.
The violation v(d) of a distance d in a n-mark ruler is the number of times distance d appears between two marks in the ruler. (…) The overall violation v of a n-mark ruler is simply the sum of the violations of its distances. [source]

Parameters:

ruler - the ruler

Returns:

the overall violation of a ruler

getMeasurableDistances

public static java.util.List<java.lang.Integer> getMeasurableDistances(Ruler ruler,
                                                                       boolean includeOneLengthDistance)

Gets the measurable distances. Distances in the result list are ordered as they appear in the ruler.

Parameters:

ruler - the ruler

includeOneLengthDistance - the flag indicating whether or not to include a distance of one unit

Returns:

the measurable distances list