time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (697B)

      1 
      2 {{alias}}( μ, σ )
      3     Returns the differential entropy of a lognormal distribution with location
      4     `μ` and scale `σ` (in nats).
      5 
      6     If provided `NaN` as any argument, the function returns `NaN`.
      7 
      8     If provided `σ <= 0`, the function returns `NaN`.
      9 
     10     Parameters
     11     ----------
     12     μ: number
     13         Location parameter.
     14 
     15     σ: number
     16         Scale parameter.
     17 
     18     Returns
     19     -------
     20     out: number
     21         Entropy.
     22 
     23     Examples
     24     --------
     25     > var y = {{alias}}( 0.0, 1.0 )
     26     ~1.419
     27     > y = {{alias}}( 5.0, 2.0 )
     28     ~7.112
     29     > y = {{alias}}( NaN, 1.0 )
     30     NaN
     31     > y = {{alias}}( 0.0, NaN )
     32     NaN
     33     > y = {{alias}}( 0.0, 0.0 )
     34     NaN
     35 
     36     See Also
     37     --------
     38