pingu_98/cara
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated Custom and LogCustom classes' docstring

Browse source
This commit is contained in:
Luis Aleixo 2022-05-30 11:16:30 +02:00
parent 9f5311f42e
commit 431fa3b33d
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
cara/monte_carlo/sampleable.py
View file

@ -62,7 +62,9 @@ class Custom(SampleableDistribution):
"""
Defines a distribution which follows a custom curve vs. the random
variable. Uses a simple algorithm. This is appropriate for a smooth
distribution function (one should know its maximum).
distribution function.
Note: in max_function, a value slightly above the maximum of the distribution
function should be provided.
"""
def __init__(self, bounds: typing.Tuple[float, float],
function: typing.Callable, max_function: float):
@ -84,9 +86,11 @@ class Custom(SampleableDistribution):
class LogCustom(SampleableDistribution):
"""
Defines a distribution which follows a custom curve vs. the the log (in base 10)
Defines a distribution which follows a custom curve vs. the log (in base 10)
of the random variable. Uses a simple algorithm. This is appropriate for a smooth
distribution function (one should know its maximum).
distribution function.
Note: in max_function, a value slightly above the maximum of the distribution
function should be provided.
"""
def __init__(self, bounds: typing.Tuple[float, float],
function: typing.Callable, max_function: float):