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