negative.php 882 B

12345678910111213141516171819202122232425262728293031323334
  1. <?php
  2. /**
  3. *
  4. * Function code for the complex negative() function
  5. *
  6. * @copyright Copyright (c) 2013-2018 Mark Baker (https://github.com/MarkBaker/PHPComplex)
  7. * @license https://opensource.org/licenses/MIT MIT
  8. */
  9. namespace Complex;
  10. /**
  11. * Returns the negative of a complex number.
  12. *
  13. * @param Complex|mixed $complex Complex number or a numeric value.
  14. * @return Complex The negative value of the complex argument.
  15. * @throws Exception If argument isn't a valid real or complex number.
  16. *
  17. * @see rho
  18. *
  19. */
  20. if (!function_exists(__NAMESPACE__ . '\\negative')) {
  21. function negative($complex): Complex
  22. {
  23. $complex = Complex::validateComplexArgument($complex);
  24. return new Complex(
  25. -1 * $complex->getReal(),
  26. -1 * $complex->getImaginary(),
  27. $complex->getSuffix()
  28. );
  29. }
  30. }