quantified.uncertainty/squiggle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

hotfix: lint docs

Browse Source
This commit is contained in:
Quinn Dougherty 2022-09-09 15:26:20 +08:00
parent 45323b0e08
commit 3c0255cfb9
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/website/docs/Api/Danger.md
View File

@ -14,9 +14,9 @@ Danger.laplace: (number, number) => number
Calculates the probability implied by [Laplace's rule of succession](https://en.wikipedia.org/wiki/Rule_of_succession) Calculates the probability implied by [Laplace's rule of succession](https://en.wikipedia.org/wiki/Rule_of_succession)
```js ```js
trials = 10 trials = 10;
successes = 1 successes = 1;
Danger.laplace(trials, successes) // (successes + 1) / (trials + 2) = 2 / 12 = 0.1666 Danger.laplace(trials, successes); // (successes + 1) / (trials + 2) = 2 / 12 = 0.1666
``` ```
### factorial ### factorial
@ -49,7 +49,7 @@ Danger.binomial: (number, number, number) => number
Danger.integrateFunctionBetweenWithNumIntegrationPoints: (number => number, number, number, number) => number Danger.integrateFunctionBetweenWithNumIntegrationPoints: (number => number, number, number, number) => number
``` ```
`Danger.integrateFunctionBetweenWithNumIntegrationPoints(f, min, max, numIntegrationPoints)` integrates the function `f` between `min` and `max`, and computes `numIntegrationPoints` in between to do so. `Danger.integrateFunctionBetweenWithNumIntegrationPoints(f, min, max, numIntegrationPoints)` integrates the function `f` between `min` and `max`, and computes `numIntegrationPoints` in between to do so.
Note that the function `f` has to take in and return numbers. To integrate a function which returns distributios, use: Note that the function `f` has to take in and return numbers. To integrate a function which returns distributios, use:
@ -67,7 +67,7 @@ Danger.integrateFunctionBetweenWithEpsilon: (number => number, number, number, n
`Danger.integrateFunctionBetweenWithEpsilon(f, min, max, epsilon)` integrates the function `f` between `min` and `max`, and uses an interval of `epsilon` between integration points when doing so. This makes its runtime less predictable than `integrateFunctionBetweenWithNumIntegrationPoints`, because runtime will not only depend on `epsilon`, but also on `min` and `max`. `Danger.integrateFunctionBetweenWithEpsilon(f, min, max, epsilon)` integrates the function `f` between `min` and `max`, and uses an interval of `epsilon` between integration points when doing so. This makes its runtime less predictable than `integrateFunctionBetweenWithNumIntegrationPoints`, because runtime will not only depend on `epsilon`, but also on `min` and `max`.
Same caveats as `integrateFunctionBetweenWithNumIntegrationPoints` apply. Same caveats as `integrateFunctionBetweenWithNumIntegrationPoints` apply.
### optimalAllocationGivenDiminishingMarginalReturnsForManyFunctions ### optimalAllocationGivenDiminishingMarginalReturnsForManyFunctions
@ -83,4 +83,4 @@ Example:
Danger.optimalAllocationGivenDiminishingMarginalReturnsForManyFunctions([{|x| 20-x}, {|y| 10}], 100, 0.01) Danger.optimalAllocationGivenDiminishingMarginalReturnsForManyFunctions([{|x| 20-x}, {|y| 10}], 100, 0.01)
``` ```
Note also that the array ought to have more than one function in it. Note also that the array ought to have more than one function in it.