External module "math/base/special/heaviside/docs/types/index.d"

Export assignment heaviside

• heaviside(x: number, continuity?: "half-maximum" | "left-continuous" | "right-continuous"): number

• Evaluates the Heaviside function.

  Notes

  • The continuity parameter may be one of the following:

    • 'half-maximum': if x == 0, the function returns 0.5.
    • 'left-continuous': if x == 0, the function returns 0.
    • 'right-continuous': if x == 0, the function returns 1.

  • By default, if x == 0, the function returns NaN (i.e., the function is discontinuous).

  Parameters

  • x: number

    input value

  • Optional continuity: "half-maximum" | "left-continuous" | "right-continuous"

    continuity option

  Returns number

  function value

  Example

  var v = heaviside( 3.14 );
  // returns 1.0

  Example

  var v = heaviside( -3.14 );
  // returns 0.0

  Example

  var v = heaviside( 0.0 );
  // returns NaN

  Example

  var v = heaviside( 0.0, 'half-maximum' );
  // returns 0.5

  Example

  var v = heaviside( 0.0, 'left-continuous' );
  // returns 0.0

  Example

  var v = heaviside( 0.0, 'right-continuous' );
  // returns 1.0

  Example

  var v = heaviside( NaN );
  // returns NaN