[Summary view]

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

   1  <?php
   2  
   3  /**
   4   *
   5   * Function code for the complex negative() 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 negative of a complex number.
  14   *
  15   * @param     Complex|mixed    $complex    Complex number or a numeric value.
  16   * @return    Complex          The negative value of the complex argument.
  17   * @throws    Exception        If argument isn't a valid real or complex number.
  18   *
  19   * @see    rho
  20   *
  21   */
  22  function negative($complex): Complex
  23  {
  24      $complex = Complex::validateComplexArgument($complex);
  25  
  26      return new Complex(
  27          -1 * $complex->getReal(),
  28          -1 * $complex->getImaginary(),
  29          $complex->getSuffix()
  30      );
  31  }