| 1 |
<?php |
| 2 |
|
| 3 |
/** |
| 4 |
* |
| 5 |
* Function code for the complex argument() 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 argument of a complex number. |
| 14 |
* Also known as the theta of the complex number, i.e. the angle in radians |
| 15 |
* from the real axis to the representation of the number in polar coordinates. |
| 16 |
* |
| 17 |
* This function is a synonym for theta() |
| 18 |
* |
| 19 |
* @param Complex|mixed $complex Complex number or a numeric value. |
| 20 |
* @return float The argument (or theta) value of the complex argument. |
| 21 |
* @throws Exception If argument isn't a valid real or complex number. |
| 22 |
* |
| 23 |
* @see theta |
| 24 |
*/ |
| 25 |
function argument($complex) |
| 26 |
{ |
| 27 |
return theta($complex); |
| 28 |
} |
| 29 |
|
