{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The following abbreviations are used throughout the documentation." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "PDF: probability density function" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "CDF: cumulative distribution function" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "CCDF: complementary CDF" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "entropy: differential entropy" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "log-" }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "F" } ] }, { "__type": "Text", "__tag": 4046, "value": ": logarithm of " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "F" } ] }, { "__type": "Text", "__tag": 4046, "value": " (e.g. log-CDF)" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "inverse " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "F" } ] }, { "__type": "Text", "__tag": 4046, "value": ": inverse function of " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "F" } ] }, { "__type": "Text", "__tag": 4046, "value": " (e.g. inverse CDF)" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The API documentation is written to describe the API, not to serve as a statistical reference. Effort is made to be correct at the level required to use the functionality, not to be mathematically rigorous. For example, continuity and differentiability may be implicitly assumed. For precise mathematical definitions, consult your preferred mathematical text." } ] } ], "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": "support", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "plot", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "sample", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "moment", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "mean", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "median", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "mode", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "variance", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "standard_deviation", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "skewness", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "kurtosis", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "pdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "logpdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "cdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "icdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "ccdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "iccdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "logcdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "ilogcdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "logccdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "ilogccdf", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "entropy", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "logentropy", "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": "Uniform distribution." } ] } ], "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": "All parameters are available as attributes.", "annotation": "", "desc": [] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "tol", "annotation": "positive float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The desired relative tolerance of calculations. Left unspecified, calculations may be faster; when provided, calculations may be more likely to meet the desired accuracy." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "validation_policy", "annotation": "{None, \"skip_all\"}", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies the level of input validation to perform. Left unspecified, input validation is performed to ensure appropriate behavior in edge case (e.g. parameters out of domain, argument outside of distribution support, etc.) and improve consistency of output dtype, shape, etc. Pass " }, { "__type": "InlineCode", "__tag": 4051, "value": "'skip_all'" }, { "__type": "Text", "__tag": 4046, "value": " to avoid the computational overhead of these checks when rough edges are acceptable." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "cache_policy", "annotation": "{None, \"no_cache\"}", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies the extent to which intermediate results are cached. Left unspecified, intermediate results of some calculations (e.g. distribution support, moments, etc.) are cached to improve performance of future calculations. Pass " }, { "__type": "InlineCode", "__tag": 4051, "value": "'no_cache'" }, { "__type": "Text", "__tag": 4046, "value": " to reduce memory reserved by the class instance." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The probability density function of the uniform distribution is:" } ] }, { "__type": "Math", "__tag": 4058, "value": "f(x; a, b) = \\frac{1}\n {b - a}" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "for " }, { "__type": "InlineMath", "__tag": 4057, "value": "x \\in [a, b]" }, { "__type": "Text", "__tag": 4046, "value": ". This class accepts one parameterization: " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " for " }, { "__type": "InlineMath", "__tag": 4057, "value": "a \\in (-\\infty, \\infty)" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": " for " }, { "__type": "InlineMath", "__tag": 4057, "value": "b \\in (a, \\infty)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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/stats/_new_distributions.py", "item_line": 342, "item_type": "ABCMeta", "aliases": [ "scipy.stats.Uniform" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "To use the distribution class, it must be instantiated using keyword\nparameters corresponding with one of the accepted parameterizations.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nimport matplotlib.pyplot as plt\nfrom scipy import stats\nfrom scipy.stats import Uniform\nX = Uniform(a=0.09, b=188.73)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nFor convenience, the ``plot`` method can be used to visualize the density\nand other functions of the distribution.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "X.plot()\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "plt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-507d612d9edcad14.png" } }, { "__type": "Text", "__tag": 4046, "value": "\nThe support of the underlying distribution is available using the ``support``\nmethod.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "X.support()\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe numerical values of parameters associated with all parameterizations\nare available as attributes.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "X.a, X.b, X.ab\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nTo evaluate the probability density/mass function of the underlying distribution\nat argument ``x=60.45``:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = 60.45\nX.pdf(x), X.pmf(x)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe cumulative distribution function, its complement, and the logarithm\nof these functions are evaluated similarly.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.allclose(np.exp(X.logccdf(x)), 1 - X.cdf(x))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe inverse of these functions with respect to the argument ``x`` is also\navailable.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "logp = np.log(1 - X.ccdf(x))\nnp.allclose(X.ilogcdf(logp), x)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nNote that distribution functions and their logarithms also have two-argument\nversions for working with the probability mass between two arguments. The\nresult tends to be more accurate than the naive implementation because it avoids\nsubtractive cancellation.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "y = 120.82\nnp.allclose(X.ccdf(x, y), 1 - (X.cdf(y) - X.cdf(x)))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThere are methods for computing measures of central tendency,\ndispersion, higher moments, and entropy.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "X.mean(), X.median(), X.mode()\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "X.variance(), X.standard_deviation()\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "X.skewness(), X.kurtosis()\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "np.allclose(X.moment(order=6, kind='standardized'),\n X.moment(order=6, kind='central') / X.variance()**3)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "np.allclose(np.exp(X.logentropy()), X.entropy())\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nPseudo-random samples can be drawn from\nthe underlying distribution using ``sample``.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "X.sample(shape=(4,))\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "rv_infrastructure", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "rv_infrastructure" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Tutorial" } ] } ], "type": "ref" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "b", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "kwargs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "VAR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "Uniform" }, "references": null, "qa": "scipy.stats._new_distributions:Uniform", "arbitrary": [], "local_refs": [ "All parameters are available as attributes.", "cache_policy", "ccdf", "cdf", "entropy", "iccdf", "icdf", "ilogccdf", "ilogcdf", "kurtosis", "logccdf", "logcdf", "logentropy", "logpdf", "mean", "median", "mode", "moment", "pdf", "plot", "sample", "skewness", "standard_deviation", "support", "tol", "validation_policy", "variance" ] }