aima.core.util.math

Class Interval<C>

java.lang.Object

aima.core.util.math.Interval<C>

public class Interval<C>
extends java.lang.Object

Basic supports for Intervals.

Author:

Ciaran O'Reilly, Mike Stampone

See Also:

Interval

Constructor Summary

Constructors

Constructor and Description
Interval()
Interval(java.lang.Comparable<C> lower, boolean lowerInclusive, java.lang.Comparable<C> upper, boolean upperInclusive) Constructs an interval from the two specified end points.
Interval(java.lang.Comparable<C> lower, java.lang.Comparable<C> upper) Constructs a closed interval from the two specified end points.

Method Summary

Modifier and Type	Method and Description
java.lang.Comparable<C>	getLower() Returns the lower end point of the interval.
java.lang.Comparable<C>	getUpper() Returns the upper end point of the interval.
boolean	isInInterval(C o) Returns true if the specified object is between the end points of this interval.
boolean	isLowerExclusive() Returns true if this interval is not lower inclusive.
boolean	isLowerInclusive() Returns true if this interval is lower inclusive.
boolean	isUpperExclusive() Returns true if this interval is upper exclusive.
boolean	isUpperInclusive() Returns true if this interval is upper inclusive.
void	setLower(java.lang.Comparable<C> lower) Sets the lower end point of the interval.
void	setLowerExclusive(boolean exclusive) Sets the interval to lower exclusive or lower inclusive.
void	setLowerInclusive(boolean inclusive) Sets the interval to lower inclusive or lower exclusive.
void	setUpper(java.lang.Comparable<C> upper) Sets the upper end point of the interval.
void	setUpperExclusive(boolean exclusive) Sets the interval to upper exclusive or upper inclusive.
void	setUpperInclusive(boolean inclusive) Sets the interval to upper inclusive or upper exclusive.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Interval

public Interval()

Interval

public Interval(java.lang.Comparable<C> lower,
                java.lang.Comparable<C> upper)

Constructs a closed interval from the two specified end points.

Parameters:

lower - the lower end point of the interval

upper - the upper end point of the interval

Interval

public Interval(java.lang.Comparable<C> lower,
                boolean lowerInclusive,
                java.lang.Comparable<C> upper,
                boolean upperInclusive)

Constructs an interval from the two specified end points.

Parameters:

lower - the lower end point of the interval

lowerInclusive - wether or not the lower end of the interval is inclusive of its value.

upper - the upper end point of the interval

upperInclusive - whether or not the upper end of the interval is inclusive of its value.

Method Detail

isInInterval

public boolean isInInterval(C o)

Returns true if the specified object is between the end points of this interval.

Returns:

true if the specified value is between the end points of this interval.

isLowerInclusive

public boolean isLowerInclusive()

Returns true if this interval is lower inclusive.

Returns:

true if this interval is lower inclusive.

isLowerExclusive

public boolean isLowerExclusive()

Returns true if this interval is not lower inclusive.

Returns:

true if this interval is not lower inclusive.

setLowerInclusive

public void setLowerInclusive(boolean inclusive)

Sets the interval to lower inclusive or lower exclusive.

Parameters:

inclusive - true represents lower inclusive and false represents lower exclusive.

setLowerExclusive

public void setLowerExclusive(boolean exclusive)

Sets the interval to lower exclusive or lower inclusive.

Parameters:

exclusive - true represents lower exclusive and false represents lower inclusive.

getLower

public java.lang.Comparable<C> getLower()

Returns the lower end point of the interval.

Returns:

the lower end point of the interval.

setLower

public void setLower(java.lang.Comparable<C> lower)

Sets the lower end point of the interval.

Parameters:

lower - the lower end point of the interval

isUpperInclusive

public boolean isUpperInclusive()

Returns true if this interval is upper inclusive.

Returns:

true if this interval is upper inclusive.

isUpperExclusive

public boolean isUpperExclusive()

Returns true if this interval is upper exclusive.

Returns:

true if this interval is upper exclusive.

setUpperInclusive

public void setUpperInclusive(boolean inclusive)

Sets the interval to upper inclusive or upper exclusive.

Parameters:

inclusive - true represents upper inclusive and false represents upper exclusive.

setUpperExclusive

public void setUpperExclusive(boolean exclusive)

Sets the interval to upper exclusive or upper inclusive.

Parameters:

exclusive - true represents upper exclusive and false represents upper inclusive.

getUpper

public java.lang.Comparable<C> getUpper()

Returns the upper end point of the interval.

Returns:

the upper end point of the interval.

setUpper

public void setUpper(java.lang.Comparable<C> upper)

Sets the upper end point of the interval.

Parameters:

upper - the upper end point of the interval.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object