time-to-botec

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

repl.txt (1016B)


      1 
      2 {{alias}}( x[, continuity] )
      3     Evaluates the Heaviside function.
      4 
      5     The `continuity` parameter may be one of the following:
      6 
      7     - 'half-maximum': if `x == 0`, the function returns `0.5`.
      8     - 'left-continuous': if `x == 0`, the function returns `0`.
      9     - 'right-continuous': if `x == 0`, the function returns `1`.
     10 
     11     By default, if `x == 0`, the function returns `NaN` (i.e., the function is
     12     discontinuous).
     13 
     14     Parameters
     15     ----------
     16     x: number
     17         Input value.
     18 
     19     continuity: string (optional)
     20         Specifies how to handle `x == 0`. By default, if `x == 0`, the function
     21         returns `NaN`.
     22 
     23     Returns
     24     -------
     25     y: number
     26         Function value.
     27 
     28     Examples
     29     --------
     30     > var y = {{alias}}( 3.14 )
     31     1.0
     32     > y = {{alias}}( -3.14 )
     33     0.0
     34     > y = {{alias}}( 0.0 )
     35     NaN
     36     > y = {{alias}}( 0.0, 'half-maximum' )
     37     0.5
     38     > y = {{alias}}( 0.0, 'left-continuous' )
     39     0.0
     40     > y = {{alias}}( 0.0, 'right-continuous' )
     41     1.0
     42 
     43     See Also
     44     --------
     45