Skip to content

Fix expm1 for complex special cases #1332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 11, 2023
Merged

Fix expm1 for complex special cases #1332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
19179e6
Fixed some complex special cases for expm1
ndgrigorian Aug 9, 2023
ccc4050
Silence remaining warnings in elementwise tests
ndgrigorian Aug 9, 2023
64282d6
Tweaks to expm1 complex special case logic
ndgrigorian Aug 9, 2023
27ea9c2
expm1 special case change
ndgrigorian Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions dpctl/tensor/libtensor/include/kernels/elementwise_functions/expm1.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
#include <cmath>
#include <cstddef>
#include <cstdint>
#include <limits>
#include <type_traits>

#include "kernels/elementwise_functions/common.hpp"
Expand Down Expand Up @@ -73,6 +74,46 @@ template <typename argT, typename resT> struct Expm1Functor
const realT x = std::real(in);
const realT y = std::imag(in);

// special cases
if (std::isinf(x)) {
if (x > realT(0)) {
// positive infinity cases
if (!std::isfinite(y)) {
return resT{x, std::numeric_limits<realT>::quiet_NaN()};
}
else if (y == realT(0)) {
return in;
}
else {
return (resT{std::copysign(x, std::cos(y)),
std::copysign(x, std::sin(y))});
}
}
else {
// negative infinity cases
if (!std::isfinite(y)) {
// copy sign of y to guarantee
// conj(expm1(x)) == expm1(conj(x))
return resT{realT(-1), std::copysign(realT(0), y)};
}
else {
return resT{realT(-1),
std::copysign(realT(0), std::sin(y))};
}
}
}

if (std::isnan(x)) {
if (y == realT(0)) {
return in;
}
else {
return resT{std::numeric_limits<realT>::quiet_NaN(),
std::numeric_limits<realT>::quiet_NaN()};
}
}

// x, y finite numbers
realT cosY_val;
const realT sinY_val = sycl::sincos(y, &cosY_val);
const realT sinhalfY_val = std::sin(y / 2);
Expand Down
56 changes: 40 additions & 16 deletions dpctl/tests/elementwise/test_expm1.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,29 +116,53 @@ def test_expm1_order(dtype):


def test_expm1_special_cases():
q = get_queue_or_skip()
get_queue_or_skip()

X = dpt.asarray(
[dpt.nan, 0.0, -0.0, dpt.inf, -dpt.inf], dtype="f4", sycl_queue=q
)
Xnp = dpt.asnumpy(X)
X = dpt.asarray([dpt.nan, 0.0, -0.0, dpt.inf, -dpt.inf], dtype="f4")
res = np.asarray([np.nan, 0.0, -0.0, np.inf, -1.0], dtype="f4")

tol = dpt.finfo(X.dtype).resolution
assert_allclose(
dpt.asnumpy(dpt.expm1(X)), np.expm1(Xnp), atol=tol, rtol=tol
)
assert_allclose(dpt.asnumpy(dpt.expm1(X)), res, atol=tol, rtol=tol)

# special cases for complex variant
num_finite = 1.0
vals = [
complex(*val)
for val in itertools.permutations(
[dpt.nan, dpt.inf, -dpt.inf, 0.0, -0.0, 1.0], 2
)
complex(0.0, 0.0),
complex(num_finite, dpt.inf),
complex(num_finite, dpt.nan),
complex(dpt.inf, 0.0),
complex(-dpt.inf, num_finite),
complex(dpt.inf, num_finite),
complex(-dpt.inf, dpt.inf),
complex(dpt.inf, dpt.inf),
complex(-dpt.inf, dpt.nan),
complex(dpt.inf, dpt.nan),
complex(dpt.nan, 0.0),
complex(dpt.nan, num_finite),
complex(dpt.nan, dpt.nan),
]
X = dpt.asarray(vals, dtype=dpt.complex64)
Xnp = dpt.asnumpy(X)
cis_1 = complex(np.cos(num_finite), np.sin(num_finite))
c_nan = complex(np.nan, np.nan)
res = np.asarray(
[
complex(0.0, 0.0),
c_nan,
c_nan,
complex(np.inf, 0.0),
0.0 * cis_1 - 1.0,
np.inf * cis_1 - 1.0,
complex(-1.0, 0.0),
complex(np.inf, np.nan),
complex(-1.0, 0.0),
complex(np.inf, np.nan),
complex(np.nan, 0.0),
c_nan,
c_nan,
],
dtype=np.complex64,
)

tol = dpt.finfo(X.dtype).resolution
assert_allclose(
dpt.asnumpy(dpt.expm1(X)), np.expm1(Xnp), atol=tol, rtol=tol
)
with np.errstate(invalid="ignore"):
assert_allclose(dpt.asnumpy(dpt.expm1(X)), res, atol=tol, rtol=tol)
47 changes: 34 additions & 13 deletions dpctl/tests/elementwise/test_log1p.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,28 +119,49 @@ def test_log1p_special_cases():
q = get_queue_or_skip()

X = dpt.asarray(
[dpt.nan, -1.0, -2.0, 0.0, -0.0, dpt.inf, -dpt.inf],
[dpt.nan, -2.0, -1.0, -0.0, 0.0, dpt.inf],
dtype="f4",
sycl_queue=q,
)
Xnp = dpt.asnumpy(X)
res = np.asarray([np.nan, np.nan, -np.inf, -0.0, 0.0, np.inf])

tol = dpt.finfo(X.dtype).resolution
assert_allclose(
dpt.asnumpy(dpt.log1p(X)), np.log1p(Xnp), atol=tol, rtol=tol
)
with np.errstate(divide="ignore", invalid="ignore"):
assert_allclose(dpt.asnumpy(dpt.log1p(X)), res, atol=tol, rtol=tol)

# special cases for complex
vals = [
complex(*val)
for val in itertools.permutations(
[dpt.nan, dpt.inf, -dpt.inf, 0.0, -0.0, 1.0, -1.0, -2.0], 2
)
complex(-1.0, 0.0),
complex(2.0, dpt.inf),
complex(2.0, dpt.nan),
complex(-dpt.inf, 1.0),
complex(dpt.inf, 1.0),
complex(-dpt.inf, dpt.inf),
complex(dpt.inf, dpt.inf),
complex(dpt.inf, dpt.nan),
complex(dpt.nan, 1.0),
complex(dpt.nan, dpt.inf),
complex(dpt.nan, dpt.nan),
]
X = dpt.asarray(vals, dtype=dpt.complex64)
Xnp = dpt.asnumpy(X)
c_nan = complex(np.nan, np.nan)
res = np.asarray(
[
complex(-np.inf, 0.0),
complex(np.inf, np.pi / 2),
c_nan,
complex(np.inf, np.pi),
complex(np.inf, 0.0),
complex(np.inf, 3 * np.pi / 4),
complex(np.inf, np.pi / 4),
complex(np.inf, np.nan),
c_nan,
complex(np.inf, np.nan),
c_nan,
],
dtype=np.complex64,
)

tol = dpt.finfo(X.dtype).resolution
assert_allclose(
dpt.asnumpy(dpt.log1p(X)), np.log1p(Xnp), atol=tol, rtol=tol
)
with np.errstate(invalid="ignore"):
assert_allclose(dpt.asnumpy(dpt.log1p(X)), res, atol=tol, rtol=tol)