# -*- coding: utf-8 -*-
# *****************************************************************************
# Copyright (c) 2016-2024, Intel Corporation
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# - Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
# THE POSSIBILITY OF SUCH DAMAGE.
# *****************************************************************************
"""
Interface of the function from Python Math library
Notes
-----
This module is a face or public interface file for the library
it contains:
- Interface functions
- documentation for the functions
- The functions parameters check
"""
import math
import dpnp
# pylint: disable=no-name-in-module
from .dpnp_algo import (
dpnp_erf,
)
from .dpnp_utils import (
create_output_descriptor_py,
)
__all__ = ["erf"]
[docs]
def erf(in_array1):
"""
Returns the error function of complex argument.
For full documentation refer to :obj:`scipy.special.erf`.
Limitations
-----------
Parameter `in_array1` is supported as :obj:`dpnp.ndarray`.
Otherwise the function will be executed sequentially on CPU.
Input array data types are limited by supported DPNP :ref:`Data types`.
.. seealso:: :obj:`math.erf`
Examples
--------
>>> import dpnp as np
>>> x = np.linspace(2.0, 3.0, num=5)
>>> [i for i in x]
[2.0, 2.25, 2.5, 2.75, 3.0]
>>> out = np.erf(x)
>>> [i for i in out]
[0.99532227, 0.99853728, 0.99959305, 0.99989938, 0.99997791]
"""
x1_desc = dpnp.get_dpnp_descriptor(
in_array1, copy_when_strides=False, copy_when_nondefault_queue=False
)
if x1_desc:
return dpnp_erf(x1_desc).get_pyobj()
result = create_output_descriptor_py(
in_array1.shape, in_array1.dtype, None
).get_pyobj()
for i in range(result.size):
result[i] = math.erf(in_array1[i])
return result