Package pulse.math

Class Segment

java.lang.Object

pulse.math.Segment

All Implemented Interfaces:

Serializable

public class Segment
extends Object
implements Serializable

A Segment is simply a pair of values a and b such that a < b.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Segment	UNBOUNDED

Constructor Summary

Constructors

Constructor	Description
Segment(double a, double b)	Creates a Segment bounded by a and b.
Segment(Segment segment)	Copies segment

Method Summary

Modifier and Type	Method	Description
static Segment	boundsFrom(NumericPropertyKeyword p)	Creates a segment representing the bounds of p, i.e.
boolean	contains(double x)	Checks whether x is contained inside this Segment.
double	getMaximum()	Gets the b value for this Segment
double	getMinimum()	Gets the a value for this Segment
double	length()	Calculates the length (b - a)
double	lengthSq()	Calculates the squared length
double	mean()	Calculates the middle point of this Segment.
double	randomValue()	Calculates a random value confined in the interval between the two ends of this Segment.
void	setMaximum(double b)	Sets the maximum value to b.
void	setMinimum(double a)	Sets the minimum value to a.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNBOUNDED

public static final Segment UNBOUNDED

Constructor Detail

Segment

public Segment(double a,
               double b)

Creates a Segment bounded by a and b.

Parameters:

a - any value

b - either b > a or b < a

Segment

public Segment(Segment segment)

Copies segment

Parameters:

segment - a Segment

Method Detail

boundsFrom

public static Segment boundsFrom(NumericPropertyKeyword p)

Creates a segment representing the bounds of p, i.e. the range in which the property value is allowed to change

Parameters:

p - a property keyword to extract default bounds

Returns:

a Segment with the bounds

getMinimum

public double getMinimum()

Gets the a value for this Segment

Returns:

the lower end of this Segment

getMaximum

public double getMaximum()

Gets the b value for this Segment

Returns:

the upper end of this Segment

length

public double length()

Calculates the length (b - a)

Returns:

the length value

lengthSq

public double lengthSq()

Calculates the squared length

Returns:

the squared length value

See Also:

length()

setMinimum

public void setMinimum(double a)

Sets the minimum value to a. Note it does not prevent against: a >= max.

Parameters:

a - a value, which should satisfy a < max

setMaximum

public void setMaximum(double b)

Sets the maximum value to b. Note it does not prevent against: b <= min.

Parameters:

b - a value, which should satisfy b > min

mean

public double mean()

Calculates the middle point of this Segment.

Returns:

the mean

randomValue

public double randomValue()

Calculates a random value confined in the interval between the two ends of this Segment.

Returns:

a confined random value.

contains

public boolean contains(double x)

Checks whether x is contained inside this Segment.

Parameters:

x - a value.

Returns:

true if $min\; \le$x ≤ max.

toString

public String toString()

Overrides:

toString in class Object