fr.ign.cogit.cartagen.util

Class Interval<T extends Number>

Object

Interval<T>

Type Parameters:

T -

All Implemented Interfaces:

Cloneable, Comparable<Interval<T>>

public class Interval<T extends Number>
extends Object
implements Cloneable, Comparable<Interval<T>>

Class to model number intervals, useful to define scale ranges.

Author:

GTouya

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Interval.Rule Bound rules values.

Constructor Summary

Constructors

Constructor and Description
Interval(T minimum, T maximum) Creates a new instance.
Interval(T minimum, T maximum, Interval.Rule minimumRule, Interval.Rule maximumRule) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Interval<T>	clone() Creates a copy of this interval.
int	compareTo(Interval<T> o)
boolean	contains(Interval<?> interval) Indicates whether the provided interval belongs to this interval.
boolean	contains(Number number) Indicates whether the provided value belongs to this interval.
boolean	equals(Interval<?> interval)
boolean	equals(Object obj)
T	getMaximum() Gets the maximum value.
Interval.Rule	getMaximumRule() Gets the rule of the maximum bound.
T	getMinimum() Gets the minimum value.
Interval.Rule	getMinimumRule() Gets the rule of the minimum bound.
int	hashCode()
boolean	intersects(Interval<?> interval) Indicates whether the provided interval intersects to this interval.
double	maximum() Gets the maximum value in double precision.
double	minimum() Gets the minimum value in double precision.
static double	project(double value, double inMin, double inMax, double outMin, double outMax) Project interval [inMin, inMax] on interval [outMin, outMax] and return the image of the given value.
static double	project(Number number, Interval<? extends Number> source, Interval<? extends Number> destination) Project interval [source] on interval [destination] ands return the image of the given value.
double	range() Gets the maximum - minimum value in double precision.
static double	rescale(double value, double minimum, double maximum) Rescale the provided number to fit into the [minimum, maximum] interval.
double	rescale(Number number) Rescale the provided number to fit into this interval.
static double	rescale(Number number, Interval<? extends Number> interval) Rescale the provided number to fit into the provided interval.
String	toString()

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Interval

public Interval(T minimum,
                T maximum)
         throws IllegalArgumentException

Creates a new instance.

Parameters:

minimum - The minimum value.

maximum - The maximum value.

Throws:

IllegalArgumentException - If either minimum or maximum is null.

Interval

public Interval(T minimum,
                T maximum,
                Interval.Rule minimumRule,
                Interval.Rule maximumRule)
         throws IllegalArgumentException

Creates a new instance.

Parameters:

minimum - The minimum value.

maximum - The maximum value.

minimumRule - The rule for the minimum bound; can be null .
If null will be set to Rule.INCLUSIVE.

maximumRule - The rule for the maximum bound; can be null .
If null will be set to Rule.INCLUSIVE.

Throws:

IllegalArgumentException - If either minimum or maximum is null or if the specified interval is invalid.
Typically, an invalid interval may be ]x, x[, [x, x[ or ]x, x].

Since:

1.1

Method Detail

clone

public Interval<T> clone()

Creates a copy of this interval.

Overrides:

clone in class Object

Returns:

A copy of this interval.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public boolean equals(Interval<?> interval)

Parameters:

interval - The interval to be tested.

Returns:

True if the test is verified; false otherwise.

toString

public String toString()

Overrides:

toString in class Object

getMinimum

public T getMinimum()

Gets the minimum value.

Returns:

A T instance.

getMaximum

public T getMaximum()

Gets the maximum value.

Returns:

A T instance.

minimum

public double minimum()

Gets the minimum value in double precision.

Returns:

A double.

maximum

public double maximum()

Gets the maximum value in double precision.

Returns:

A double.

range

public double range()

Gets the maximum - minimum value in double precision.

Returns:

A double.

getMinimumRule

public Interval.Rule getMinimumRule()

Gets the rule of the minimum bound.

Returns:

A Rule instance; never null.

Since:

1.1

getMaximumRule

public Interval.Rule getMaximumRule()

Gets the rule of the maximum bound.

Returns:

A Rule instance; never null.

Since:

1.1

contains

public boolean contains(Number number)
                 throws IllegalArgumentException

Indicates whether the provided value belongs to this interval.

Parameters:

number - The value to be tested.

Returns:

True if the test is verified; false otherwise.

Throws:

IllegalArgumentException - If number is null or this interval is invalid.

contains

public boolean contains(Interval<?> interval)
                 throws IllegalArgumentException

Indicates whether the provided interval belongs to this interval.

Parameters:

interval - The interval to be tested.

Returns:

True if the test is verified; false otherwise.

Throws:

IllegalArgumentException - If interval is null.

intersects

public boolean intersects(Interval<?> interval)
                   throws IllegalArgumentException

Indicates whether the provided interval intersects to this interval.

Parameters:

interval - The interval to be tested.

Returns:

True if the test is verified; false otherwise.

Throws:

IllegalArgumentException - If interval is null.

Since:

1.1

rescale

public double rescale(Number number)
               throws IllegalArgumentException

Rescale the provided number to fit into this interval.

Parameters:

number - The number to rescale.

Returns:

A double.

Throws:

IllegalArgumentException - If number is null.

rescale

public static double rescale(Number number,
                             Interval<? extends Number> interval)
                      throws IllegalArgumentException

Rescale the provided number to fit into the provided interval.

Parameters:

number - The number to rescale.

interval - The source interval.

Returns:

A double.

Throws:

IllegalArgumentException - If number or intervall. is null.

Since:

1.1

rescale

public static double rescale(double value,
                             double minimum,
                             double maximum)

Rescale the provided number to fit into the [minimum, maximum] interval.

Parameters:

value - The value to rescale.

minimum - The minimum value.

maximum - The maximum value.

Returns:

A double.

project

public static double project(Number number,
                             Interval<? extends Number> source,
                             Interval<? extends Number> destination)
                      throws IllegalArgumentException

Project interval [source] on interval [destination] ands return the image of the given value.

Parameters:

number - The value to be projected.

source - The source interval (value must be contained within the interval).

destination - The destination interval.

Returns:

The image of the given value after the projection.

Throws:

IllegalArgumentException - If value, source or destination is null or if source has a range of 0.

project

public static double project(double value,
                             double inMin,
                             double inMax,
                             double outMin,
                             double outMax)
                      throws IllegalArgumentException

Project interval [inMin, inMax] on interval [outMin, outMax] and return the image of the given value.
This method does not create new Interval objects.

Parameters:

value - The value to be projected.

inMin - The source minimum.

inMax - The source maximum.

outMin - The destination minimum.

outMax - the destination maximum.

Returns:

The image of the given value after the projection.

Throws:

IllegalArgumentException - If the source interval has a range of 0.

compareTo

public int compareTo(Interval<T> o)

Specified by:

compareTo in interface Comparable<Interval<T extends Number>>