[Summary view]

Differences Between: [Versions 310 and 311] [Versions 39 and 311]

   1  <?php
   2  
   3  /**
   4   *
   5   * Function code for the complex abs() function
   6   *
   7   * @copyright  Copyright (c) 2013-2018 Mark Baker (https://github.com/MarkBaker/PHPComplex)
   8   * @license    https://opensource.org/licenses/MIT    MIT
   9   */
  10  namespace Complex;
  11  
  12  /**
  13   * Returns the absolute value (modulus) of a complex number.
  14   * Also known as the rho of the complex number, i.e. the distance/radius
  15   *   from the centrepoint to the representation of the number in polar coordinates.
  16   *
  17   * This function is a synonym for rho()
  18   *
  19   * @param     Complex|mixed    $complex    Complex number or a numeric value.
  20   * @return    float            The absolute (or rho) value of the complex argument.
  21   * @throws    Exception        If argument isn't a valid real or complex number.
  22   *
  23   * @see    rho
  24   *
  25   */
  26  function abs($complex): float
  27  {
  28      return rho($complex);
  29  }