summaryrefslogtreecommitdiffstats
path: root/vendor/markbaker/complex/classes/src/functions/argument.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/markbaker/complex/classes/src/functions/argument.php')
-rw-r--r--vendor/markbaker/complex/classes/src/functions/argument.php30
1 files changed, 30 insertions, 0 deletions
diff --git a/vendor/markbaker/complex/classes/src/functions/argument.php b/vendor/markbaker/complex/classes/src/functions/argument.php
new file mode 100644
index 0000000..17e6ecb
--- /dev/null
+++ b/vendor/markbaker/complex/classes/src/functions/argument.php
@@ -0,0 +1,30 @@
+<?php
+
+/**
+ *
+ * Function code for the complex argument() function
+ *
+ * @copyright Copyright (c) 2013-2018 Mark Baker (https://github.com/MarkBaker/PHPComplex)
+ * @license https://opensource.org/licenses/MIT MIT
+ */
+namespace Complex;
+
+/**
+ * Returns the argument of a complex number.
+ * Also known as the theta of the complex number, i.e. the angle in radians
+ * from the real axis to the representation of the number in polar coordinates.
+ *
+ * This function is a synonym for theta()
+ *
+ * @param Complex|mixed $complex Complex number or a numeric value.
+ * @return float The argument (or theta) value of the complex argument.
+ * @throws Exception If argument isn't a valid real or complex number.
+ *
+ * @see theta
+ */
+if (!function_exists(__NAMESPACE__ . '\\argument')) {
+ function argument($complex): float
+ {
+ return theta($complex);
+ }
+}