Package org.arakhne.afc.math.stochastic
Class ConstantStochasticLaw
- java.lang.Object
-
- org.arakhne.afc.math.stochastic.StochasticLaw
-
- org.arakhne.afc.math.stochastic.ConstantStochasticLaw
-
- All Implemented Interfaces:
MathFunction
,MathInversableFunction
,JsonableObject
public class ConstantStochasticLaw extends StochasticLaw
Law that representes an uniform density with as its upper and lower bounds equal.This class uses the uniform random number distribution provided by
Random
. This class replies the value of the law.- Since:
- 13.0
- Version:
- 17.0 2020-01-04 14:41:41
- Author:
- Christophe BOHRHAUER
- Maven Group Id:
- org.arakhne.afc.core
- Maven Artifact Id:
- mathstochastic
-
-
Field Summary
-
Fields inherited from class org.arakhne.afc.math.stochastic.StochasticLaw
NAME_NAME
-
-
Constructor Summary
Constructors Constructor Description ConstantStochasticLaw(double value1)
Create a constant stochastic law.ConstantStochasticLaw(Map<String,String> parameters)
Construct a law with the following parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
f(double x)
Replies the value of the function.MathFunctionRange[]
getRange()
Replies the range of the function.double
inverseF(double u)
Replies the x according to the value of the inverted cummulative distribution functionF<sup>-1</sup>(u)
whereu = U(0, 1)
.void
toJson(JsonBuffer buffer)
Replies the Json representation of this node.-
Methods inherited from class org.arakhne.afc.math.stochastic.StochasticLaw
generateRandomValue, getLawName, inverseF, paramBoolean, paramDouble, toString
-
-
-
-
Constructor Detail
-
ConstantStochasticLaw
public ConstantStochasticLaw(double value1)
Create a constant stochastic law.- Parameters:
value1
- is the value replied by this law.
-
ConstantStochasticLaw
public ConstantStochasticLaw(Map<String,String> parameters) throws OutsideDomainException, LawParameterNotFoundException
Construct a law with the following parameters.value
- Parameters:
parameters
- is the set of accepted paramters.- Throws:
LawParameterNotFoundException
- if the list of parameters does not permits to create the law.OutsideDomainException
- when lambda is outside its domain
-
-
Method Detail
-
inverseF
@Pure public double inverseF(double u) throws MathException
Description copied from class:StochasticLaw
Replies the x according to the value of the inverted cummulative distribution functionF<sup>-1</sup>(u)
whereu = U(0, 1)
.- Specified by:
inverseF
in interfaceMathInversableFunction
- Specified by:
inverseF
in classStochasticLaw
- Parameters:
u
- is a value given by the uniform random variable generatorU(0, 1)
.- Returns:
F<sup>-1</sup>(u)
- Throws:
MathException
- in caseF<sup>-1</sup>(u)
could not be computed
-
f
@Pure public double f(double x) throws MathException
Description copied from interface:MathFunction
Replies the value of the function.- Parameters:
x
- the x.- Returns:
- the value of
f(x)
. - Throws:
MathException
- in casef(x)
could not be computed
-
getRange
@Pure public MathFunctionRange[] getRange()
Description copied from interface:MathFunction
Replies the range of the function.- Returns:
- a array of ranges. It corresponds to a list of couples that defined the set of valid values.
-
toJson
@Pure public void toJson(JsonBuffer buffer)
Description copied from interface:JsonableObject
Replies the Json representation of this node.- Parameters:
buffer
- the Json buffer.
-
-