repl.txt (1661B)
1 2 {{alias}}( [x0, Ɣ] ) 3 Returns a Cauchy distribution object. 4 5 Parameters 6 ---------- 7 x0: number (optional) 8 Location parameter. Default: `0.0`. 9 10 Ɣ: number (optional) 11 Scale parameter. Must be greater than `0`. Default: `1.0`. 12 13 Returns 14 ------- 15 cauchy: Object 16 Distribution instance. 17 18 cauchy.x0: number 19 Location parameter. 20 21 cauchy.gamma: number 22 Scale parameter. If set, the value must be greater than `0`. 23 24 cauchy.entropy: number 25 Read-only property which returns the differential entropy. 26 27 cauchy.median: number 28 Read-only property which returns the median. 29 30 cauchy.mode: number 31 Read-only property which returns the mode. 32 33 cauchy.cdf: Function 34 Evaluates the cumulative distribution function (CDF). 35 36 cauchy.logcdf: Function 37 Evaluates the natural logarithm of the cumulative distribution function 38 (CDF). 39 40 cauchy.logpdf: Function 41 Evaluates the natural logarithm of the probability density function 42 (PDF). 43 44 cauchy.pdf: Function 45 Evaluates the probability density function (PDF). 46 47 cauchy.quantile: Function 48 Evaluates the quantile function at probability `p`. 49 50 Examples 51 -------- 52 > var cauchy = {{alias}}( 0.0, 1.0 ); 53 > cauchy.x0 54 0.0 55 > cauchy.gamma 56 1.0 57 > cauchy.entropy 58 ~2.531 59 > cauchy.median 60 0.0 61 > cauchy.mode 62 0.0 63 > cauchy.cdf( 0.8 ) 64 ~0.715 65 > cauchy.logcdf( 1.0 ) 66 ~-0.288 67 > cauchy.logpdf( 1.0 ) 68 ~-1.838 69 > cauchy.pdf( 1.0 ) 70 ~0.159 71 > cauchy.quantile( 0.8 ) 72 ~1.376 73 74 See Also 75 -------- 76