[Summary view]

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

   1  <?php
   2  
   3  /**
   4   *
   5   * Function code for the complex rho() 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 rho of a complex number.
  14   * This is the distance/radius from the centrepoint to the representation of the number in polar coordinates.
  15   *
  16   * @param     Complex|mixed    $complex    Complex number or a numeric value.
  17   * @return    float            The rho value of the complex argument.
  18   * @throws    Exception        If argument isn't a valid real or complex number.
  19   */
  20  function rho($complex): float
  21  {
  22      $complex = Complex::validateComplexArgument($complex);
  23  
  24      return \sqrt(
  25          ($complex->getReal() * $complex->getReal()) +
  26          ($complex->getImaginary() * $complex->getImaginary())
  27      );
  28  }