From 2393578c5ff6de7e260e7de730a238c974e69fc6 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Mon, 20 Jun 2022 02:27:28 -0700 Subject: [PATCH 1/2] Add complex number support to `sin` --- .gitignore | 1 + .../array_api/elementwise_functions.py | 25 +++++++++++++++---- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 73e203a64..86bab2717 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,4 @@ node_modules/ __pycache__/ *.pyc spec/**/generated +tmp/ \ No newline at end of file diff --git a/spec/API_specification/array_api/elementwise_functions.py b/spec/API_specification/array_api/elementwise_functions.py index 7acefaf52..42ae1754b 100644 --- a/spec/API_specification/array_api/elementwise_functions.py +++ b/spec/API_specification/array_api/elementwise_functions.py @@ -1212,27 +1212,42 @@ def sign(x: array, /) -> array: """ def sin(x: array, /) -> array: - """ - Calculates an implementation-dependent approximation to the sine, having domain ``(-infinity, +infinity)`` and codomain ``[-1, +1]``, for each element ``x_i`` of the input array ``x``. Each element ``x_i`` is assumed to be expressed in radians. + r""" + Calculates an implementation-dependent approximation to the sine for each element ``x_i`` of the input array ``x``. + + Each element ``x_i`` is assumed to be expressed in radians. **Special cases** - For floating-point operands, + For real-valued floating-point operands, - If ``x_i`` is ``NaN``, the result is ``NaN``. - If ``x_i`` is ``+0``, the result is ``+0``. - If ``x_i`` is ``-0``, the result is ``-0``. - If ``x_i`` is either ``+infinity`` or ``-infinity``, the result is ``NaN``. + For complex floating-point operands, special cases must be handled as if the operation is implemented as ``-1j * sinh(x*1j)``. + + .. note:: + The sine is an entire function on the complex plane and has no branch cuts. + + .. note:: + For complex arguments, the mathematical definition of sine is + + .. math:: + \begin{align} \operatorname{sin}(x) &= \frac{e^{jx} - e^{-jx}}{2j} \\ &= \frac{\operatorname{sinh}(jx)}{1j} \\ &= \frac{\operatorname{sinh}(jx)}{1j} \cdot \frac{1j}{1j} \\ &= (-1j) \cdot \operatorname{sinh}(jx) \end{align} + + where :math:`\operatorname{sinh}` is the hyperbolic sine. + Parameters ---------- x: array - input array whose elements are each expressed in radians. Should have a real-valued floating-point data type. + input array whose elements are each expressed in radians. Should have a floating-point data type. Returns ------- out: array - an array containing the sine of each element in ``x``. The returned array must have a real-valued floating-point data type determined by :ref:`type-promotion`. + an array containing the sine of each element in ``x``. The returned array must have a floating-point data type determined by :ref:`type-promotion`. """ def sinh(x: array, /) -> array: From 19a4c8692b513e7a6a892326bcd107ab747f9916 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Mon, 20 Jun 2022 02:33:00 -0700 Subject: [PATCH 2/2] Update equation --- spec/API_specification/array_api/elementwise_functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/API_specification/array_api/elementwise_functions.py b/spec/API_specification/array_api/elementwise_functions.py index 42ae1754b..1c722bc3c 100644 --- a/spec/API_specification/array_api/elementwise_functions.py +++ b/spec/API_specification/array_api/elementwise_functions.py @@ -1235,7 +1235,7 @@ def sin(x: array, /) -> array: For complex arguments, the mathematical definition of sine is .. math:: - \begin{align} \operatorname{sin}(x) &= \frac{e^{jx} - e^{-jx}}{2j} \\ &= \frac{\operatorname{sinh}(jx)}{1j} \\ &= \frac{\operatorname{sinh}(jx)}{1j} \cdot \frac{1j}{1j} \\ &= (-1j) \cdot \operatorname{sinh}(jx) \end{align} + \begin{align} \operatorname{sin}(x) &= \frac{e^{jx} - e^{-jx}}{2j} \\ &= \frac{\operatorname{sinh}(jx)}{j} \\ &= \frac{\operatorname{sinh}(jx)}{j} \cdot \frac{j}{j} \\ &= -j \cdot \operatorname{sinh}(jx) \end{align} where :math:`\operatorname{sinh}` is the hyperbolic sine.