IT++ Logo Newcom Logo

itpp::I_Uniform_RNG Class Reference
[Random Number Generation]

Integer uniform distribution. More...

#include <itpp/base/random.h>

List of all members.

Public Member Functions

 I_Uniform_RNG (int min=0, int max=1)
 constructor. Sets min and max values.
void setup (int min, int max)
 set min and max values
void get_setup (int &min, int &max) const
 get the parameters
int operator() ()
 Get one sample.
ivec operator() (int n)
 Get a sample vector.
imat operator() (int h, int w)
 Get a sample matrix.
int sample ()
 Return a single value from this random generator.


Detailed Description

Integer uniform distribution.

Example: Generation of random uniformly distributed integers in the interval [0,10].

    #include "itpp/sigproc.h"
  
    int main() {
  
    I_Uniform_RNG gen(0, 10);
  
    cout << gen() << endl; // prints a random integer
    cout << gen(10) << endl; // prints 10 random integers
    }

Definition at line 304 of file random.h.


Constructor & Destructor Documentation

itpp::I_Uniform_RNG::I_Uniform_RNG ( int  min = 0,
int  max = 1 
)

constructor. Sets min and max values.

Definition at line 148 of file random.cpp.

References setup().


Member Function Documentation

void itpp::I_Uniform_RNG::setup ( int  min,
int  max 
)

set min and max values

Definition at line 153 of file random.cpp.

Referenced by I_Uniform_RNG(), and itpp::randi().

void itpp::I_Uniform_RNG::get_setup ( int &  min,
int &  max 
) const

get the parameters

Definition at line 165 of file random.cpp.

int itpp::I_Uniform_RNG::operator() (  )  [inline]

Get one sample.

Definition at line 313 of file random.h.

References sample().

ivec itpp::I_Uniform_RNG::operator() ( int  n  ) 

Get a sample vector.

Definition at line 171 of file random.cpp.

References sample().

imat itpp::I_Uniform_RNG::operator() ( int  h,
int  w 
)

Get a sample matrix.

Definition at line 181 of file random.cpp.

References sample().

int itpp::I_Uniform_RNG::sample (  )  [inline]

Return a single value from this random generator.

Definition at line 319 of file random.h.

References itpp::floor_i(), and itpp::Random_Generator::random_01().

Referenced by operator()().


The documentation for this class was generated from the following files:
SourceForge Logo

Generated on Sat Aug 25 23:40:34 2007 for IT++ by Doxygen 1.5.2