Ignore:
Timestamp:
02/06/12 11:20:39 (2 years ago)
Author:
Jure Zbontar <jure.zbontar@…>
Branch:
default
Message:

Renamed RandomGenerator to Random

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orange/Orange/misc/__init__.py

    r9637 r9692  
    2020.. automodule:: Orange.misc.r 
    2121 
    22 .. automodule:: Orange.misc.random 
     22 
     23.. index: Random number generator 
     24 
     25*********************** 
     26Random number generator 
     27*********************** 
     28 
     29:obj:`Random` uses the  
     30`Mersenne twister <http://en.wikipedia.org/wiki/Mersenne_twister>`_ algorithm 
     31to generate random numbers. 
     32 
     33:: 
     34 
     35    >>> import Orange 
     36    >>> rg = Orange.misc.Random(42) 
     37    >>> rg(10) 
     38    4 
     39    >>> rg(10) 
     40    7 
     41    >>> rg.uses  # We called rg two times. 
     42    2 
     43    >>> rg.reset() 
     44    >>> rg(10) 
     45    4 
     46    >>> rg(10) 
     47    7 
     48    >>> rg.uses 
     49    2 
     50 
     51 
     52.. class:: Random(initseed) 
     53 
     54    :param initseed: Seed used for initializing the random generator. 
     55    :type initseed: int 
     56 
     57    .. method:: __call__(n) 
     58 
     59        Return a random integer R such that 0 <= R < n. 
     60 
     61        :type n: int 
     62 
     63    .. method:: reset([initseed]) 
     64 
     65        Reinitialize the random generator with `initseed`. If `initseed` 
     66        is not given use the existing value of attribute `initseed`. 
     67 
     68    .. attribute:: uses 
     69         
     70        The number of times the generator was called after 
     71        initialization/reset. 
     72     
     73    .. attribute:: initseed 
     74 
     75        Random seed. 
     76 
     77Two examples or random number generator uses found in the documentation 
     78are :obj:`Orange.evaluation.testing` and :obj:`Orange.data.Table`. 
    2379 
    2480""" 
     
    2783import render 
    2884import serverfiles 
     85 
     86from Orange.core import RandomGenerator as Random 
    2987 
    3088# addons is intentionally not imported; if it were, add-ons' directories would 
Note: See TracChangeset for help on using the changeset viewer.