LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-11-01 11:43:47 +01:00
Code Issues Releases Wiki Activity
2705353f1d
dft_tools/doc/reference/random_generator/contents.rst

50 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
.. index:: Random number generator
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
.. module:: pytriqs.random_generator
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
.. _random_generator:
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
Random number generators
==========================
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
TRIQS exposes to python the random number generators used in C++,
in the module ``RandomGenerator``.
The generators are the boost random generators.
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
Usage
-----
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
The generator is constructed from a name (the name of the boost generator) and a seed::
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
from pytriqs.random_generator import *
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
r = RandomGenerator("mt19937", 237849)
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
A list of available random generators is obtained with::
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
print random_generator_names_list()
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
Then you can either generate float number on the interval :math:`[0,1[`
simply by calling the generator, or integer numbers in the inverval :math:`[0,N-1]` by calling
it with `N` ::
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
print r()
print r(10)
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
Example
-------
Here's a simple example showing how to use the generator.
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-17 18:15:19 +02:00
.. plot:: reference/random_generator/random.py
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
:include-source:
:scale: 70
Complete reference
------------------
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
.. autoclass:: pytriqs.random_generator.RandomGenerator
Cythonize random generators A trivial cythonized version of the c++ random_generator class. Useful to get the names of the generators from the python. new file: pytriqs/random/* new file: doc/reference/python/random/*
2013-09-13 17:49:28 +02:00
:members:
Change implementation of random_generator & python wrapper. - Use a new buffered_function to replace the complicated generator code from ALPS. - Clean the implementation of the random_generator - update the documentation - update to the new python wrapper (could not be done with the previous version, because of lack of move constructor).
2014-05-29 21:35:00 +02:00
.. autofunction:: pytriqs.random_generator.random_generator_names_list
Reference in New Issue Copy Permalink