Skip to content

Commit 0eb4f4b

Browse files
committed
Fix readme example and add test
1 parent 96524b0 commit 0eb4f4b

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,17 +100,17 @@ import numpy as np
100100
import xtensor_python_test as xt
101101
102102
x = np.arange(15).reshape(3, 5)
103-
y = [1, 2, 3]
103+
y = [1, 2, 3, 4, 5]
104104
z = xt.vectorized_func(x, y)
105105
z
106106
```
107107

108108
**Outputs**
109109

110110
```
111-
[[-1. , 0.301169, 1.325444, 1.131113, -0.103159],
112-
[-1.958924, -0.819718, 1.073133, 1.979351, 1.065762],
113-
[-1.544021, -1.540293, -0.120426, 1.41016 , 1.644251]]
111+
[[-0.540302, 1.257618, 1.89929 , 0.794764, -1.040465],
112+
[-1.499227, 0.136731, 1.646979, 1.643002, 0.128456],
113+
[-1.084323, -0.583843, 0.45342 , 1.073811, 0.706945]]
114114
```
115115

116116
## Installation

test/main.cpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ double readme_example1(xt::pyarray<double> &m)
2828
return std::accumulate(sines.begin(), sines.end(), 0.0);
2929
}
3030

31+
double readme_example2(double i, double j)
32+
{
33+
return std::sin(i) - std::cos(j);
34+
}
35+
3136
// Vectorize Examples
3237

3338
int add(int i, int j)
@@ -43,6 +48,7 @@ PYBIND11_PLUGIN(xtensor_python_test)
4348
m.def("example2", example2, "");
4449

4550
m.def("readme_example1", readme_example1, "");
51+
m.def("readme_example2", xt::pyvectorize(readme_example2), "");
4652

4753
m.def("vectorize_example1", xt::pyvectorize(add), "");
4854

test/test_pyarray.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,13 @@ def test_readme_example1(self):
3535
v = np.arange(15).reshape(3, 5)
3636
y = xt.readme_example1(v)
3737
np.testing.assert_allclose(y, 1.2853996391883833, 1e-12)
38+
39+
def test_readme_example2(self):
40+
x = np.arange(15).reshape(3, 5)
41+
y = [1, 2, 3, 4, 5]
42+
z = xt.readme_example2(x, y)
43+
np.testing.assert_allclose(z,
44+
[[-0.540302, 1.257618, 1.89929 , 0.794764, -1.040465],
45+
[-1.499227, 0.136731, 1.646979, 1.643002, 0.128456],
46+
[-1.084323, -0.583843, 0.45342 , 1.073811, 0.706945]], 1e-5)
47+

0 commit comments

Comments
 (0)