Add parameter out to four trigonometric functions (#786)

* change call_fptr_1in_1out function

Author: KsanaKozlova

dpnp/dpnp_algo/dpnp_algo.pxd

@@ -287,7 +287,7 @@ cpdef dparray dpnp_init_val(shape, dtype, value)
 Mathematical functions
 """
 cpdef dparray dpnp_add(object x1_obj, object x2_obj, object dtype=*, dparray out=*, object where=*)
-cpdef dparray dpnp_arctan2(object x1_obj, object x2_obj, object dtype=*, dparray out=*, object where=*)
+cpdef dparray dpnp_arctan2(dpnp_descriptor x1_obj, dpnp_descriptor x2_obj, object dtype=*, dparray out=*, object where=*)
 cpdef dparray dpnp_divide(object x1_obj, object x2_obj, object dtype=*, dparray out=*, object where=*)
 cpdef dparray dpnp_hypot(object x1_obj, object x2_obj, object dtype=*, dparray out=*, object where=*)
 cpdef dparray dpnp_maximum(object x1_obj, object x2_obj, object dtype=*, dparray out=*, object where=*)
@@ -331,9 +331,9 @@ Trigonometric functions
 """
 cpdef dparray dpnp_arccos(dpnp_descriptor array1)
 cpdef dparray dpnp_arccosh(dpnp_descriptor array1)
-cpdef dparray dpnp_arcsin(dpnp_descriptor array1)
+cpdef dparray dpnp_arcsin(dpnp_descriptor array1, dparray out)
 cpdef dparray dpnp_arcsinh(dpnp_descriptor array1)
-cpdef dparray dpnp_arctan(dpnp_descriptor array1)
+cpdef dparray dpnp_arctan(dpnp_descriptor array1, dparray out)
 cpdef dparray dpnp_arctanh(dpnp_descriptor array1)
 cpdef dparray dpnp_cbrt(dpnp_descriptor array1)
 cpdef dparray dpnp_cos(dpnp_descriptor array1, dparray out)
@@ -352,5 +352,5 @@ cpdef dparray dpnp_sin(dpnp_descriptor array1, dparray out)
 cpdef dparray dpnp_sinh(dpnp_descriptor array1)
 cpdef dparray dpnp_sqrt(dpnp_descriptor array1)
 cpdef dparray dpnp_square(dpnp_descriptor array1)
-cpdef dparray dpnp_tan(dpnp_descriptor array1)
+cpdef dparray dpnp_tan(dpnp_descriptor array1, dparray out)
 cpdef dparray dpnp_tanh(dpnp_descriptor array1)

dpnp/dpnp_algo/dpnp_algo_mathematical.pyx

@@ -105,8 +105,8 @@ cpdef dparray dpnp_add(object x1_obj, object x2_obj, object dtype=None, dparray
     return call_fptr_2in_1out(DPNP_FN_ADD, x1_obj, x2_obj, dtype=dtype, out=out, where=where)
 
 
-cpdef dparray dpnp_arctan2(object x1_obj, object x2_obj, object dtype=None, dparray out=None, object where=True):
-    return call_fptr_2in_1out(DPNP_FN_ARCTAN2, x1_obj, x2_obj, dtype=dtype, out=out, where=where)
+cpdef dparray dpnp_arctan2(utils.dpnp_descriptor x1_obj, utils.dpnp_descriptor x2_obj, object dtype=None, dparray out=None, object where=True):
+    return call_fptr_2in_1out(DPNP_FN_ARCTAN2, x1_obj, x2_obj, dtype=dtype, out=out, where=where, func_name="arctan2")
 
 
 cpdef dpnp_around(utils.dpnp_descriptor x1, int decimals):

dpnp/dpnp_algo/dpnp_algo_trigonometric.pyx

@@ -72,16 +72,16 @@ cpdef dparray dpnp_arccosh(utils.dpnp_descriptor x1):
     return call_fptr_1in_1out(DPNP_FN_ARCCOSH, x1, x1.shape)
 
 
-cpdef dparray dpnp_arcsin(utils.dpnp_descriptor x1):
-    return call_fptr_1in_1out(DPNP_FN_ARCSIN, x1, x1.shape)
+cpdef dparray dpnp_arcsin(utils.dpnp_descriptor x1, dparray out):
+    return call_fptr_1in_1out(DPNP_FN_ARCSIN, x1, x1.shape, out=out, func_name='arcsin')
 
 
 cpdef dparray dpnp_arcsinh(utils.dpnp_descriptor x1):
     return call_fptr_1in_1out(DPNP_FN_ARCSINH, x1, x1.shape)
 
 
-cpdef dparray dpnp_arctan(utils.dpnp_descriptor x1):
-    return call_fptr_1in_1out(DPNP_FN_ARCTAN, x1, x1.shape)
+cpdef dparray dpnp_arctan(utils.dpnp_descriptor x1, dparray out):
+    return call_fptr_1in_1out(DPNP_FN_ARCTAN, x1, x1.shape, out=out, func_name='arctan')
 
 
 cpdef dparray dpnp_arctanh(utils.dpnp_descriptor x1):
@@ -156,8 +156,8 @@ cpdef dparray dpnp_square(utils.dpnp_descriptor x1):
     return call_fptr_1in_1out(DPNP_FN_SQUARE, x1, x1.shape)
 
 
-cpdef dparray dpnp_tan(utils.dpnp_descriptor x1):
-    return call_fptr_1in_1out(DPNP_FN_TAN, x1, x1.shape)
+cpdef dparray dpnp_tan(utils.dpnp_descriptor x1, dparray out):
+    return call_fptr_1in_1out(DPNP_FN_TAN, x1, x1.shape, out=out, func_name='tan')
 
 
 cpdef dparray dpnp_tanh(utils.dpnp_descriptor x1):

dpnp/dpnp_iface_trigonometric.py

@@ -153,7 +153,7 @@ def arccosh(x1):
     return call_origin(numpy.arccosh, x1, **kwargs)
 
 
-def arcsin(x1):
+def arcsin(x1, out=None, **kwargs):
     """
     Inverse sine, element-wise.
 
@@ -162,6 +162,7 @@ def arcsin(x1):
     Limitations
     -----------
     Input array is supported as :obj:`dpnp.ndarray`.
+    Keyword arguments ``kwargs`` are currently unsupported.
     Input array data types are limited by supported DPNP :ref:`Data types`.
 
     See Also
@@ -186,9 +187,9 @@ def arcsin(x1):
 
     x1_desc = dpnp.get_dpnp_descriptor(x1)
     if x1_desc:
-        return dpnp_arcsin(x1_desc)
+        return dpnp_arcsin(x1_desc, out)
 
-    return call_origin(numpy.arcsin, x1, **kwargs)
+    return call_origin(numpy.arcsin, x1, out=out, **kwargs)
 
 
 def arcsinh(x1):
@@ -220,7 +221,7 @@ def arcsinh(x1):
     return call_origin(numpy.arcsinh, x1, **kwargs)
 
 
-def arctan(x1):
+def arctan(x1, out=None, **kwargs):
     """
     Trigonometric inverse tangent, element-wise.
 
@@ -229,6 +230,7 @@ def arctan(x1):
     Limitations
     -----------
     Input array is supported as :obj:`dpnp.ndarray`.
+    Keyword arguments ``kwargs`` are currently unsupported.
     Input array data types are limited by supported DPNP :ref:`Data types`.
 
     See Also
@@ -249,9 +251,9 @@ def arctan(x1):
 
     x1_desc = dpnp.get_dpnp_descriptor(x1)
     if x1_desc:
-        return dpnp_arctan(x1_desc)
+        return dpnp_arctan(x1_desc, out)
 
-    return call_origin(numpy.arctan, x1, **kwargs)
+    return call_origin(numpy.arctan, x1, out=out, **kwargs)
 
 
 def arctanh(x1):
@@ -361,8 +363,6 @@ def arctan2(x1, x2, dtype=None, out=None, where=True, **kwargs):
             pass
         elif dtype is not None:
             pass
-        elif out is not None:
-            pass
         elif not where:
             pass
         else:
@@ -974,7 +974,7 @@ def square(x1):
     return call_origin(numpy.square, x1, **kwargs)
 
 
-def tan(x1):
+def tan(x1, out=None, **kwargs):
     """
     Compute tangent element-wise.
 
@@ -983,6 +983,7 @@ def tan(x1):
     Limitations
     -----------
     Input array is supported as :obj:`dpnp.ndarray`.
+    Keyword arguments ``kwargs`` are currently unsupported.
     Input array data types are limited by supported DPNP :ref:`Data types`.
 
     Examples
@@ -998,9 +999,9 @@ def tan(x1):
 
     x1_desc = dpnp.get_dpnp_descriptor(x1)
     if x1_desc:
-        return dpnp_tan(x1_desc)
+        return dpnp_tan(x1_desc, out)
 
-    return call_origin(numpy.tan, x1, **kwargs)
+    return call_origin(numpy.tan, x1, out=out, **kwargs)
 
 
 def tanh(x1):

tests/test_umath.py

@@ -230,3 +230,163 @@ def test_invalid_shape(self, shape):
 
         with pytest.raises(ValueError):
             dpnp.exp(dp_array, out=dp_out)
+
+
+class TestArcsin:
+
+    def test_arcsin(self):
+        array_data = numpy.arange(10)
+        out = numpy.empty(10, dtype=numpy.float64)
+
+        # DPNP
+        dp_array = dpnp.array(array_data, dtype=dpnp.float64)
+        dp_out = dpnp.array(out, dtype=dpnp.float64)
+        result = dpnp.arcsin(dp_array, out=dp_out)
+
+        # original
+        np_array = numpy.array(array_data, dtype=numpy.float64)
+        expected = numpy.arcsin(np_array, out=out)
+
+        numpy.testing.assert_array_equal(expected, result)
+
+    @pytest.mark.parametrize("dtype",
+                            [numpy.float32, numpy.int64, numpy.int32],
+                            ids=['numpy.float32', 'numpy.int64', 'numpy.int32'])
+    def test_invalid_dtype(self, dtype):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(10, dtype=dtype)
+
+        with pytest.raises(ValueError):
+            dpnp.arcsin(dp_array, out=dp_out)
+
+    @pytest.mark.parametrize("shape",
+                            [(0,), (15, ), (2,2)],
+                            ids=['(0,)', '(15, )', '(2,2)'])
+    def test_invalid_shape(self, shape):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(shape, dtype=dpnp.float64)
+
+        with pytest.raises(ValueError):
+            dpnp.arcsin(dp_array, out=dp_out)
+
+
+class TestArctan:
+
+    def test_arctan(self):
+        array_data = numpy.arange(10)
+        out = numpy.empty(10, dtype=numpy.float64)
+
+        # DPNP
+        dp_array = dpnp.array(array_data, dtype=dpnp.float64)
+        dp_out = dpnp.array(out, dtype=dpnp.float64)
+        result = dpnp.arctan(dp_array, out=dp_out)
+
+        # original
+        np_array = numpy.array(array_data, dtype=numpy.float64)
+        expected = numpy.arctan(np_array, out=out)
+
+        numpy.testing.assert_array_equal(expected, result)
+
+    @pytest.mark.parametrize("dtype",
+                            [numpy.float32, numpy.int64, numpy.int32],
+                            ids=['numpy.float32', 'numpy.int64', 'numpy.int32'])
+    def test_invalid_dtype(self, dtype):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(10, dtype=dtype)
+
+        with pytest.raises(ValueError):
+            dpnp.arctan(dp_array, out=dp_out)
+
+    @pytest.mark.parametrize("shape",
+                            [(0,), (15, ), (2,2)],
+                            ids=['(0,)', '(15, )', '(2,2)'])
+    def test_invalid_shape(self, shape):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(shape, dtype=dpnp.float64)
+
+        with pytest.raises(ValueError):
+            dpnp.arctan(dp_array, out=dp_out)
+
+
+class TestTan:
+
+    def test_tan(self):
+        array_data = numpy.arange(10)
+        out = numpy.empty(10, dtype=numpy.float64)
+
+        # DPNP
+        dp_array = dpnp.array(array_data, dtype=dpnp.float64)
+        dp_out = dpnp.array(out, dtype=dpnp.float64)
+        result = dpnp.tan(dp_array, out=dp_out)
+
+        # original
+        np_array = numpy.array(array_data, dtype=numpy.float64)
+        expected = numpy.tan(np_array, out=out)
+
+        numpy.testing.assert_array_equal(expected, result)
+
+    @pytest.mark.parametrize("dtype",
+                            [numpy.float32, numpy.int64, numpy.int32],
+                            ids=['numpy.float32', 'numpy.int64', 'numpy.int32'])
+    def test_invalid_dtype(self, dtype):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(10, dtype=dtype)
+
+        with pytest.raises(ValueError):
+            dpnp.tan(dp_array, out=dp_out)
+
+    @pytest.mark.parametrize("shape",
+                            [(0,), (15, ), (2,2)],
+                            ids=['(0,)', '(15, )', '(2,2)'])
+    def test_invalid_shape(self, shape):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(shape, dtype=dpnp.float64)
+
+        with pytest.raises(ValueError):
+            dpnp.tan(dp_array, out=dp_out)
+
+
+class TestArctan2:
+
+    def test_arctan2(self):
+        array_data = numpy.arange(10)
+        out = numpy.empty(10, dtype=numpy.float64)
+
+        # DPNP
+        dp_array = dpnp.array(array_data, dtype=dpnp.float64)
+        dp_out = dpnp.array(out, dtype=dpnp.float64)
+        result = dpnp.arctan2(dp_array, dp_array, out=dp_out)
+
+        # original
+        np_array = numpy.array(array_data, dtype=numpy.float64)
+        expected = numpy.arctan2(np_array, np_array, out=out)
+
+        numpy.testing.assert_array_equal(expected, result)
+
+    @pytest.mark.parametrize("dtype",
+                            [numpy.float32, numpy.int64, numpy.int32],
+                            ids=['numpy.float32', 'numpy.int64', 'numpy.int32'])
+    def test_invalid_dtype(self, dtype):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(10, dtype=dtype)
+
+        with pytest.raises(ValueError):
+            dpnp.arctan2(dp_array, dp_array, out=dp_out)
+
+    @pytest.mark.parametrize("shape",
+                            [(0,), (15, ), (2,2)],
+                            ids=['(0,)', '(15, )', '(2,2)'])
+    def test_invalid_shape(self, shape):
+
+        dp_array = dpnp.arange(10, dtype=dpnp.float64)
+        dp_out = dpnp.empty(shape, dtype=dpnp.float64)
+
+        with pytest.raises(ValueError):
+            dpnp.arctan2(dp_array, dp_array, out=dp_out)