DistConstant (DSOL core project 4.2.0 API)

java.lang.Object
- nl.tudelft.simulation.jstats.distributions.Dist
- - nl.tudelft.simulation.jstats.distributions.DistContinuous
  - - nl.tudelft.simulation.jstats.distributions.DistConstant

All Implemented Interfaces:

Serializable
```
public class DistConstant
extends DistContinuous
```
The Constant distribution. For more information on this distribution see https://mathworld.wolfram.com/ContinuousDistribution.html
Copyright (c) 2002-2023 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:

Peter Jacobs , Alexander Verbraeck

See Also:

Serialized Form

Field Summary
- Fields inherited from class nl.tudelft.simulation.jstats.distributions.Dist
  stream

Constructor Summary

Constructors
Constructor Description

DistConstant(StreamInterface stream, double constant)
constructs a new constant distribution.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`draw()`	draws the next stream value according to the probability of this this distribution.
`double`	`getConstant()`	Return the constant.
`double`	`getProbabilityDensity(double x)`	returns the probability density value of a value x.
`String`	`toString()`

Methods inherited from class nl.tudelft.simulation.jstats.distributions.Dist
getStream, setStream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DistConstant
```
public DistConstant(StreamInterface stream,
                    double constant)
```
    constructs a new constant distribution.
    
    Parameters:
    
    stream - StreamInterface; the random number stream
    
    constant - double; the value
- Method Detail
  - draw
```
public double draw()
```
    draws the next stream value according to the probability of this this distribution.
    
    Specified by:
    
    draw in class DistContinuous
    
    Returns:
    
    the next double value drawn.
  - getProbabilityDensity
```
public double getProbabilityDensity(double x)
```
    returns the probability density value of a value x.
    
    Specified by:
    
    getProbabilityDensity in class DistContinuous
    
    Parameters:
    
    x - double; the value for which the density function needs to be calculated
    
    Returns:
    
    double; the probability density for value x
  - getConstant
```
public double getConstant()
```
    Return the constant.
    
    Returns:
    
    double; the constant
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object