[Summary view]

Differences Between: [Versions 39 and 311]

   1  <?php
   2  
   3  /**
   4   *
   5   * Function code for the complex ln() 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 natural logarithm of a complex number.
  14   *
  15   * @param     Complex|mixed    $complex    Complex number or a numeric value.
  16   * @return    Complex          The natural logarithm of the complex argument.
  17   * @throws    Exception        If argument isn't a valid real or complex number.
  18   * @throws    \InvalidArgumentException  If the real and the imaginary parts are both zero
  19   */
  20  function ln($complex)
  21  {
  22      $complex = Complex::validateComplexArgument($complex);
  23  
  24      if (($complex->getReal() == 0.0) && ($complex->getImaginary() == 0.0)) {
  25          throw new \InvalidArgumentException();
  26      }
  27  
  28      return new Complex(
  29          \log(rho($complex)),
  30          theta($complex),
  31          $complex->getSuffix()
  32      );
  33  }