Skip to content

Commit 841e3ed

Browse files
authored
Merge pull request numpy#26627 from luxedo/DOC/21351/setbufsize
DOC: add `setbufsize` example
2 parents 38e9f7b + ee4b7ea commit 841e3ed

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

numpy/_core/_ufunc_config.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,24 @@ def setbufsize(size):
167167
size : int
168168
Size of buffer.
169169
170+
Returns
171+
-------
172+
bufsize : int
173+
Previous size of ufunc buffer in bytes.
174+
175+
Examples
176+
--------
177+
When exiting a `numpy.errstate` context manager the bufsize is restored:
178+
179+
>>> with np.errstate():
180+
... np.setbufsize(4096)
181+
... print(np.getbufsize())
182+
...
183+
8192
184+
4096
185+
>>> np.getbufsize()
186+
8192
187+
170188
"""
171189
old = _get_extobj_dict()["bufsize"]
172190
extobj = _make_extobj(bufsize=size)

0 commit comments

Comments
 (0)