Module org.arakhne.afc.core.mathstochastic

Package org.arakhne.afc.math.stochastic

Class MathFunctionRange

java.lang.Object

org.arakhne.afc.math.stochastic.MathFunctionRange

public class MathFunctionRange
extends Object

Define the range of a mathematic function.

Since:

13.0

Version:

17.0 2020-01-04 14:41:41

Author:

Stéphane GALLAND

See Also:

"http://en.wikipedia.org/wiki/Range_(mathematics)"

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathstochastic

Constructor Summary

Constructors

Constructor	Description
MathFunctionRange(double value)	A bounding set with one value.
MathFunctionRange(double min1, boolean includeMin1, double max1, boolean includeMax1)	A bounding set with with two bounds.
MathFunctionRange(double min1, double max1)	A bounding set with with two bounds.

Method Summary

Modifier and Type	Method	Description
static MathFunctionRange[]	createDiscreteSet(double... values)	Create a set of bounds that correspond to the specified discrete values.
static MathFunctionRange[]	createInfinitySet()	Create a bound that corresponds to -infinity; +infinity.
static MathFunctionRange[]	createSet(double... values)	Create a set of bounds that correspond to the specified values.
double	getMax()	Replies the maximal value of the value set.
double	getMin()	Replies the minimal value of the value set.
boolean	isMaxValueIncluded()	Replies if the maximal value is included in the value set.
boolean	isMinValueIncluded()	Replies if the minimal value is included in the value set.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MathFunctionRange

public MathFunctionRange(double value)

A bounding set with one value.

Parameters:

value - is the value of the minimal and maximale values in the set.

MathFunctionRange

public MathFunctionRange(double min1,
                         double max1)

A bounding set with with two bounds.

Parameters:

min1 - is the minimal value

max1 - is the maximal value

MathFunctionRange

public MathFunctionRange(double min1,
                         boolean includeMin1,
                         double max1,
                         boolean includeMax1)

A bounding set with with two bounds.

Parameters:

min1 - is the minimal value

includeMin1 - indicates if the minimal value is inside the bounds or outside.

max1 - is the maximal value

includeMax1 - indicates if the maximal value is inside the bounds or outside.

Method Detail

createDiscreteSet

@Pure
public static MathFunctionRange[] createDiscreteSet(double... values)

Create a set of bounds that correspond to the specified discrete values.

Parameters:

values - are put in there own bounds object

Returns:

the set of bounds

createSet

@Pure
public static MathFunctionRange[] createSet(double... values)

Create a set of bounds that correspond to the specified values.

The first value is the minimal value of the first bounds, the second value is the maximal value of the first bounds, the third value is the minimal value of the second bounds, the forth value is the maximal value of the second bounds, and so on.

Parameters:

values - are put in there own bounds object

Returns:

the set of bounds

createInfinitySet

@Pure
public static MathFunctionRange[] createInfinitySet()

Create a bound that corresponds to -infinity; +infinity.

Returns:

the set of bounds

toString

@Pure
public String toString()

Overrides:

toString in class Object

getMin

@Pure
public double getMin()

Replies the minimal value of the value set.

Returns:

the minimal value of the value set.

getMax

@Pure
public double getMax()

Replies the maximal value of the value set.

Returns:

the maximal value of the value set.

isMinValueIncluded

@Pure
public boolean isMinValueIncluded()

Replies if the minimal value is included in the value set.

Returns:

true if the minimal value is inside the set, otherwise false

isMaxValueIncluded

@Pure
public boolean isMaxValueIncluded()

Replies if the maximal value is included in the value set.

Returns:

true if the maximal value is inside the set, otherwise false