{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Properties of Bernstein polynomials are well documented in the literature, see for example " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "3" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "BPoly", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.interpolate._interpolate:BPoly" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ⛔ \nPyTorch ✅ ⛔ \nJAX ⚠️ no JIT ⛔ \nDask ⛔ n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "__call__", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "extend", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "derivative", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "antiderivative", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "integrate", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "construct_fast", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "from_power_basis", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "from_derivatives", "annotation": "", "desc": [] } ] } ], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Piecewise polynomial in the Bernstein basis." } ] } ], "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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "x", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Breakpoints." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "c", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Coefficients of the polynomials. They are reshaped to a 3-D array with the last dimension representing the trailing dimensions of the original coefficient array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Interpolation axis." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "c", "annotation": "ndarray, shape (k, m, ...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Polynomial coefficients, order " }, { "__type": "InlineRole", "__tag": 4003, "value": "k", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "m", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " intervals" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "x", "annotation": "ndarray, shape (m+1,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Polynomial breakpoints. Must be sorted in either increasing or decreasing order." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "extrapolate", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If bool, determines whether to extrapolate to out-of-bounds points based on first and last intervals, or to return NaNs. If 'periodic', periodic extrapolation is used. Default is True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Interpolation axis. Default is zero." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The polynomial between " }, { "__type": "InlineCode", "__tag": 4051, "value": "x[i]" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "x[i + 1]" }, { "__type": "Text", "__tag": 4046, "value": " is written in the Bernstein polynomial basis " } ] }, { "__type": "Code", "__tag": 4050, "value": "S = sum(c[a, i] * b(a, k; x) for a in range(k+1)),", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where " }, { "__type": "InlineCode", "__tag": 4051, "value": "k" }, { "__type": "Text", "__tag": 4046, "value": " is the degree of the polynomial, and " } ] }, { "__type": "Code", "__tag": 4050, "value": "b(a, k; x) = binom(k, a) * t**a * (1 - t)**(k - a),", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "with " }, { "__type": "InlineCode", "__tag": 4051, "value": "t = (x - x[i]) / (x[i+1] - x[i])" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "binom" }, { "__type": "Text", "__tag": 4046, "value": " is the binomial coefficient." } ] } ], "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/interpolate/_interpolate.py", "item_line": 1316, "item_type": "class", "aliases": [ "scipy.interpolate.BPoly" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy.interpolate import BPoly\nx = [0, 1]\nc = [[1], [2], [3]]\nbp = BPoly(c, x)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThis creates a 2nd order polynomial\n\n.. math::\n\n B(x) = 1 \\times b_{0, 2}(x) + 2 \\times b_{1, 2}(x) + 3\n \\times b_{2, 2}(x) \\\\\n = 1 \\times (1-x)^2 + 2 \\times 2 x (1 - x) + 3 \\times x^2" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "PPoly", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.interpolate._interpolate:PPoly" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "piecewise polynomials in the power basis" } ] } ], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "c", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "extrapolate", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "BPoly" }, "references": [ ".. [1] https://en.wikipedia.org/wiki/Bernstein_polynomial", "", ".. [2] Kenneth I. Joy, Bernstein polynomials,", " http://www.idav.ucdavis.edu/education/CAGDNotes/Bernstein-Polynomials.pdf", "", ".. [3] E. H. Doha, A. H. Bhrawy, and M. A. Saker, Boundary Value Problems,", " vol 2011, article ID 829546, :doi:`10.1155/2011/829543`." ], "qa": "scipy.interpolate._interpolate:BPoly", "arbitrary": [], "local_refs": [ "__call__", "antiderivative", "axis", "c", "construct_fast", "derivative", "extend", "extrapolate", "from_derivatives", "from_power_basis", "integrate", "x" ] }