org.extex.typesetter.tex.paragraph
Class Fitness

java.lang.Object
  org.extex.typesetter.tex.paragraph.Fitness

public final class Fitness
extends java.lang.Object

This class provides a finite enumeration for fitness values. 817. When looking for optimal line breaks, TeX creates a "break node" for each break that is feasible, in the sense that there is a way to end a line at the given place without requiring any line to stretch more than a given tolerance. A break node is characterized by three things: the position of the break (which is a pointer to a glue_node, math_node, penalty_node, or disc_node); the ordinal number of the line that will follow this breakpoint; and the fitness classification of the line that has just ended, i.e., tight_fit, decent_fit, loose_fit, or very_loose _fit. define tight_fit=3 {fitness classification for lines shrinking 0.5 to 1.0 of their shrinkability} define loose_fit=1 {fitness classification for lines stretching 0.5 to 1.0 of their stretchability} define very_loose_fit=0 {fitness classification for lines stretching more than their stretchability} define decent_fit=2 {fitness classification for all other lines}

Version:

$Revision$

Author:

Gerd Neugebauer

See Also:

"TTP [817]"

Field Summary

static Fitness	DECENT The field DESCENT contains the fitness of class 2.
static Fitness	LOOSE The field LOOSE contains the fitness of class 1.
static Fitness	TIGHT The field TIGHT contains the fitness of class 3.
static Fitness	VERY_LOOSE The field VERY_LOOSE contains the fitness of class 0.

Method Summary

boolean	adjacent(Fitness fitness) Determine whether the given fitness has the same order or a class which is one less or one more than the own order.
int	getOrder() Getter for the order.

Methods inherited from class java.lang.Object

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

Field Detail

TIGHT

public static final Fitness TIGHT

The field TIGHT contains the fitness of class 3.

LOOSE

public static final Fitness LOOSE

The field LOOSE contains the fitness of class 1.

VERY_LOOSE

public static final Fitness VERY_LOOSE

The field VERY_LOOSE contains the fitness of class 0.

DECENT

public static final Fitness DECENT

The field DESCENT contains the fitness of class 2.

Method Detail

adjacent

public boolean adjacent(Fitness fitness)

Determine whether the given fitness has the same order or a class which is one less or one more than the own order.

Parameters:

fitness - the fitness to compare to

Returns:

true iff the order of the given fitness is equal or adjacent to the given one.

getOrder

public int getOrder()

Getter for the order.

Returns:

the order