{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The probability mass function for the Log Series distribution is" } ] }, { "__type": "Math", "__tag": 4058, "value": "P(k) = \\frac{-p^k}{k \\ln(1-p)}," }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where p = probability." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The log series distribution is frequently used to represent species richness and occurrence, first proposed by Fisher, Corbet, and Williams in 1943 " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": ". It may also be used to model the numbers of occupants seen in cars " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "3" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": "out", "annotation": "ndarray or scalar", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Drawn samples from the parameterized logarithmic series distribution." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Draw samples from a logarithmic series 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": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "p", "annotation": "float or array_like of floats", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shape parameter for the distribution. Must be in the range [0, 1)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "size", "annotation": "int or tuple of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output shape. If the given shape is, e.g., " }, { "__type": "InlineCode", "__tag": 4051, "value": "(m, n, k)" }, { "__type": "Text", "__tag": 4046, "value": ", then " }, { "__type": "InlineCode", "__tag": 4051, "value": "m * n * k" }, { "__type": "Text", "__tag": 4046, "value": " samples are drawn. If size is " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": " (default), a single value is returned if " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " is a scalar. Otherwise, " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.array(p).size" }, { "__type": "Text", "__tag": 4046, "value": " samples are drawn." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Samples are drawn from a log series distribution with specified shape parameter, 0 <= " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " < 1." } ] } ], "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": null, "item_line": null, "item_type": "cython_function_or_method", "aliases": [ "numpy.random.Generator.logseries" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Draw samples from the distribution:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "a = .6\nrng = np.random.default_rng()\ns = rng.logseries(a, 10000)\nimport matplotlib.pyplot as plt\nbins = np.arange(-.5, max(s) + .5 )\ncount, bins, _ = plt.hist(s, bins=bins, label='Sample count')\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nPlot against the distribution:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "def logseries(k, p):\n return -p**k/(k*np.log(1-p))\ncentres = np.arange(1, max(s) + 1)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "plt.plot(centres, logseries(centres, a) * s.size, 'r', label='logseries PMF')\nplt.legend()\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": "numpy", "version": "2.4.3", "kind": "assets", "path": "fig-4452dcfed461c526.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "scipy.stats.logser", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "scipy.stats.logser" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "probability density function, distribution or cumulative density function, etc." } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "p", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "logseries" }, "references": [ ".. [1] Buzas, Martin A.; Culver, Stephen J., Understanding regional", " species diversity through the log series distribution of", " occurrences: BIODIVERSITY RESEARCH Diversity & Distributions,", " Volume 5, Number 5, September 1999 , pp. 187-195(9).", ".. [2] Fisher, R.A,, A.S. Corbet, and C.B. Williams. 1943. The", " relation between the number of species and the number of", " individuals in a random sample of an animal population.", " Journal of Animal Ecology, 12:42-58.", ".. [3] D. J. Hand, F. Daly, D. Lunn, E. Ostrowski, A Handbook of Small", " Data Sets, CRC Press, 1994.", ".. [4] Wikipedia, \"Logarithmic distribution\",", " https://en.wikipedia.org/wiki/Logarithmic_distribution" ], "qa": "numpy.random._generator:Generator.logseries", "arbitrary": [], "local_refs": [ "out", "p", "size" ] }