{ "__type": "IngestedDoc", "__tag": 4010, "_content": {}, "_ordered_sections": [], "item_file": null, "item_line": null, "item_type": null, "aliases": [], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": null, "references": null, "qa": "reference:random:new-or-different", "arbitrary": [ { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Target", "__tag": 4061, "label": "new-or-different" } ], "title": [], "level": 0, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "NumPy 1.17.0 introduced " }, { "__type": "InlineRole", "__tag": 4003, "value": "Generator", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " as an improved replacement for the " }, { "__type": "CrossRef", "__tag": 4002, "value": "legacy", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:random:legacy" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "InlineRole", "__tag": 4003, "value": "RandomState", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". Here is a quick comparison of the two implementations." } ] }, { "__type": "Code", "__tag": 4050, "value": "======================= ================== =============\nFeature Older Equivalent Notes\n----------------------- ------------------ -------------\n`Generator` `RandomState` `Generator` requires a stream\n source, called a `BitGenerator`\n A number of these are provided.\n `RandomState` uses the Mersenne\n Twister `MT19937` by default,\n but can also be instantiated\n with any BitGenerator.\n----------------------- ------------------ -------------", "execution_status": null }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.random", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "InlineRole", "__tag": 4003, "value": "random_sample", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", Access the values in a" } ] }, "dd": [ { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineRole", "__tag": 4003, "value": "rand", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " BitGenerator, convert them to" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "float64" }, { "__type": "Text", "__tag": 4046, "value": " in the interval " }, { "__type": "InlineCode", "__tag": 4051, "value": "[0.0., 1.0)" }, { "__type": "Text", "__tag": 4046, "value": ". In addition to the " }, { "__type": "InlineCode", "__tag": 4051, "value": "size" }, { "__type": "Text", "__tag": 4046, "value": " kwarg, now supports " }, { "__type": "InlineCode", "__tag": 4051, "value": "dtype='d'" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "dtype='f'" }, { "__type": "Text", "__tag": 4046, "value": ", and an " }, { "__type": "InlineCode", "__tag": 4051, "value": "out" }, { "__type": "Text", "__tag": 4046, "value": " kwarg to fill a user-supplied array." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Many other distributions are also supported." } ] } ] } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "----------------------- ------------------ ------------- " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.integers", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "InlineRole", "__tag": 4003, "value": "randint", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", Use the " }, { "__type": "InlineCode", "__tag": 4051, "value": "endpoint" }, { "__type": "Text", "__tag": 4046, "value": " kwarg to" } ] }, "dd": [ { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineRole", "__tag": 4003, "value": "random_integers", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " adjust the inclusion or exclusion" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "of the " }, { "__type": "InlineCode", "__tag": 4051, "value": "high" }, { "__type": "Text", "__tag": 4046, "value": " interval endpoint." } ] } ] } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "======================= ================== ============= * The normal, exponential and gamma generators use 256-step Ziggurat" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "methods which are 2-10 times faster than NumPy's default implementation in " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_normal", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_exponential", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_gamma", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". Because of the change in algorithms, it is not possible to reproduce the exact random values using " }, { "__type": "InlineRole", "__tag": 4003, "value": "Generator", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for these distributions or any distribution method that relies on them." } ] } ] } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.integers", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is now the canonical way to generate integer random numbers from a discrete uniform distribution. This replaces both " }, { "__type": "InlineRole", "__tag": 4003, "value": "randint", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and the deprecated " }, { "__type": "InlineRole", "__tag": 4003, "value": "random_integers", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "InlineRole", "__tag": 4003, "value": "rand", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "randn", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " methods are only available through the legacy " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.RandomState", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineRole", "__tag": 4003, "value": "Generator.random", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is now the canonical way to generate floating-point random numbers, which replaces " }, { "__type": "InlineRole", "__tag": 4003, "value": "RandomState.random_sample", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "sample", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineRole", "__tag": 4003, "value": "ranf", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", all of which were aliases. This is consistent with Python's " }, { "__type": "InlineRole", "__tag": 4003, "value": "random.random", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "All bit generators can produce doubles, uint64s and uint32s via CTypes (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~PCG64.ctypes", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ") and CFFI (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~PCG64.cffi", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "). This allows these bit generators to be used in numba." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The bit generators can be used in downstream projects via Cython." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "All bit generators use " }, { "__type": "InlineRole", "__tag": 4003, "value": "SeedSequence", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " to " }, { "__type": "CrossRef", "__tag": 4002, "value": "convert seed integers to initialized states", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "reference:random:bit_generators:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional " }, { "__type": "InlineCode", "__tag": 4051, "value": "dtype" }, { "__type": "Text", "__tag": 4046, "value": " argument that accepts " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.float32" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.float64" }, { "__type": "Text", "__tag": 4046, "value": " to produce either single or double precision uniform random variables for select distributions. " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.integers", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " accepts a " }, { "__type": "InlineCode", "__tag": 4051, "value": "dtype" }, { "__type": "Text", "__tag": 4046, "value": " argument with any signed or unsigned integer dtype." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Uniforms (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.random", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.integers", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Normals (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_normal", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Standard Gammas (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_gamma", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Standard Exponentials (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_exponential", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] } ] } ] } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional " }, { "__type": "InlineCode", "__tag": 4051, "value": "out" }, { "__type": "Text", "__tag": 4046, "value": " argument that allows existing arrays to be filled for select distributions" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Uniforms (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.random", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Normals (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_normal", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Standard Gammas (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_gamma", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Standard Exponentials (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.standard_exponential", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This allows multithreading to fill large arrays in chunks using suitable BitGenerators in parallel." } ] } ] } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional " }, { "__type": "InlineCode", "__tag": 4051, "value": "axis" }, { "__type": "Text", "__tag": 4046, "value": " argument for methods like " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.choice", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.permutation", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.shuffle", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " that controls which axis an operation is performed over for multi-dimensional arrays." } ] } ] } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Added a method to sample from the complex normal distribution (" }, { "__type": "InlineRole", "__tag": 4003, "value": "~.Generator.complex_normal", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "What's new or different" } ], "level": 0, "target": null } ], "local_refs": [] }