{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The name sinc is short for \"sine cardinal\" or \"sinus cardinalis\"."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The sinc function is used in various signal processing applications, including in anti-aliasing, in the construction of a Lanczos resampling filter, and in interpolation."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "For bandlimited interpolation of discrete-time signals, the ideal interpolation kernel is proportional to the sinc function."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Raises": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Yields": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Methods": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Returns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Parameters",
          "__tag": 4026,
          "children": [
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "",
              "annotation": "array",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "sinc(x)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " calculated elementwise, which has the same shape as the input."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Return the normalized sinc function."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Receives": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warnings": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Attributes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Parameters",
          "__tag": 4026,
          "children": [
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "x",
              "annotation": "array",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Array (possibly multi-dimensional) of values for which to calculate "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "sinc(x)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ". Must have a real floating point dtype."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "xp",
              "annotation": "array_namespace, optional",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The standard-compatible namespace for "
                    },
                    {
                      "__type": "ParamRef",
                      "__tag": 4071,
                      "name": "x"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ". Default: infer."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The sinc function is equal to "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "\\sin(\\pi x)/(\\pi x)"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " for any argument "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "x\\ne 0"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "sinc(0)"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " takes the limit value 1, making "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "sinc"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " not only everywhere continuous but also infinitely differentiable."
            }
          ]
        },
        {
          "__type": "Admonition",
          "__tag": 4056,
          "kind": "note",
          "base_type": "note",
          "children": [
            {
              "__type": "AdmonitionTitle",
              "__tag": 4055,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "note "
                }
              ]
            },
            {
              "__type": "Paragraph",
              "__tag": 4045,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "Note the normalization factor of "
                },
                {
                  "__type": "InlineCode",
                  "__tag": 4051,
                  "value": "pi"
                },
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": " used in the definition. This is the most commonly used definition in signal processing. Use "
                },
                {
                  "__type": "InlineCode",
                  "__tag": 4051,
                  "value": "sinc(x / xp.pi)"
                },
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": " to obtain the unnormalized sinc function "
                },
                {
                  "__type": "InlineMath",
                  "__tag": 4057,
                  "value": "\\sin(x)/x"
                },
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": " that is more common in mathematics."
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Other Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    }
  },
  "_ordered_sections": [
    "Summary",
    "Extended Summary",
    "Parameters",
    "Attributes",
    "Methods",
    "Returns",
    "Yields",
    "Receives",
    "Other Parameters",
    "Raises",
    "Warns",
    "Warnings",
    "Notes"
  ],
  "item_file": "/scipy/_lib/array_api_extra/_delegation.py",
  "item_line": 687,
  "item_type": "function",
  "aliases": [
    "scipy.differentiate.xpx.sinc"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [
      {
        "__type": "Code",
        "__tag": 4050,
        "value": "import array_api_strict as xp\nimport array_api_extra as xpx\nx = xp.linspace(-4, 4, 41)\nxpx.sinc(x, xp=xp)\n",
        "execution_status": "unexpected_exception"
      }
    ],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "x",
        "annotation": "Array",
        "kind": "POSITIONAL_ONLY",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "xp",
        "annotation": "ModuleType | None",
        "kind": "KEYWORD_ONLY",
        "default": "None"
      }
    ],
    "return_annotation": "Array",
    "target_name": "sinc"
  },
  "references": [
    "#. Weisstein, Eric W. \"Sinc Function.\" From MathWorld--A Wolfram Web",
    "   Resource. https://mathworld.wolfram.com/SincFunction.html",
    "#. Wikipedia, \"Sinc function\",",
    "   https://en.wikipedia.org/wiki/Sinc_function"
  ],
  "qa": "scipy._lib.array_api_extra._delegation:sinc",
  "arbitrary": [],
  "local_refs": [
    "x",
    "xp"
  ]
}