Skip to content

Commit 05d9001

Browse files
authored
Merge pull request numpy#21542 from sousaw/sinc_doc_pr
DOC: improve the docstring of numpy.sinc to explain behavior at zero.
2 parents e997604 + 70025f0 commit 05d9001

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

numpy/lib/function_base.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3562,14 +3562,16 @@ def sinc(x):
35623562
r"""
35633563
Return the normalized sinc function.
35643564
3565-
The sinc function is :math:`\sin(\pi x)/(\pi x)`.
3565+
The sinc function is equal to :math:`\sin(\pi x)/(\pi x)` for any argument
3566+
:math:`x\ne 0`. ``sinc(0)`` takes the limit value 1, making ``sinc`` not
3567+
only everywhere continuous but also infinitely differentiable.
35663568
35673569
.. note::
35683570
35693571
Note the normalization factor of ``pi`` used in the definition.
35703572
This is the most commonly used definition in signal processing.
35713573
Use ``sinc(x / np.pi)`` to obtain the unnormalized sinc function
3572-
:math:`\sin(x)/(x)` that is more common in mathematics.
3574+
:math:`\sin(x)/x` that is more common in mathematics.
35733575
35743576
Parameters
35753577
----------
@@ -3584,8 +3586,6 @@ def sinc(x):
35843586
35853587
Notes
35863588
-----
3587-
``sinc(0)`` is the limit value 1.
3588-
35893589
The name sinc is short for "sine cardinal" or "sinus cardinalis".
35903590
35913591
The sinc function is used in various signal processing applications,

0 commit comments

Comments
 (0)