Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "math/base/special/kernel-tan/docs/types/index.d"

Index

Functions

Functions

Export assignment kernelTan

  • kernelTan(x: number, y: number, k: -1 | 1): number
  • Computes the tangent of a number on [-π/4, π/4].

    Notes

    • For increased accuracy, the number for which the tangent should be evaluated can be supplied as a double-double number (i.e., a non-evaluated sum of two double-precision floating-point numbers x and y).
    • The numbers x and y must satisfy |y| < 0.5 * ulp( x ).
    • If either x or y is NaN, the function returns NaN.

    Parameters

    • x: number

      input value (in radians, assumed to be bounded by ~π/4 in magnitude)

    • y: number

      tail of x

    • k: -1 | 1

      indicates whether tan (if k = 1) or -1/tan (if k = -1) is returned

    Returns number

    tangent

    Example

    var out = kernelTan( 3.141592653589793/4.0, 0.0, 1 );
    // returns ~1.0

    Example

    var out = kernelTan( 3.141592653589793/4.0, 0.0, -1 );
    // returns ~-1.0

    Example

    var out = kernelTan( 3.141592653589793/6.0, 0.0, 1 );
    // returns ~0.577

    Example

    var out = kernelTan( 0.664, 5.288e-17, 1 );
    // returns ~0.783

    Example

    var out = kernelTan( NaN, 0.0, 1 );
    // returns NaN

    Example

    var out = kernelTan( 3.0, NaN, 1 );
    // returns NaN

    Example

    var out = kernelTan( NaN, NaN, 1 );
    // returns NaN