IT++ Logo Newcom Logo

itpp::Complex_Normal_RNG Class Reference
[Random Number Generation]

A Complex Normal Source. More...

#include <itpp/base/random.h>

List of all members.

Public Member Functions

 Complex_Normal_RNG (std::complex< double > mean, double variance)
 Constructor. Set mean and variance.
 Complex_Normal_RNG ()
 Constructor. Set mean and variance.
void setup (std::complex< double > mean, double variance)
 Set mean and variance.
void get_setup (std::complex< double > &mean, double &variance)
 Get mean and variance.
std::complex< double > operator() ()
 Get one sample.
cvec operator() (int n)
 Get a sample vector.
cmat operator() (int h, int w)
 Get a sample matrix.
std::complex< double > sample ()
 Get a Complex Normal (0,1) distributed sample.
void sample_vector (int size, cvec &out)
 Get a Complex Normal (0,1) distributed vector.
void sample_matrix (int rows, int cols, cmat &out)
 Get a Complex Normal (0,1) distributed matrix.


Detailed Description

A Complex Normal Source.

Definition at line 501 of file random.h.


Constructor & Destructor Documentation

itpp::Complex_Normal_RNG::Complex_Normal_RNG ( std::complex< double >  mean,
double  variance 
) [inline]

Constructor. Set mean and variance.

Definition at line 504 of file random.h.

References setup().

itpp::Complex_Normal_RNG::Complex_Normal_RNG (  )  [inline]

Constructor. Set mean and variance.

Definition at line 506 of file random.h.


Member Function Documentation

void itpp::Complex_Normal_RNG::setup ( std::complex< double >  mean,
double  variance 
) [inline]

Set mean and variance.

Definition at line 508 of file random.h.

References itpp::sqrt().

Referenced by Complex_Normal_RNG().

void itpp::Complex_Normal_RNG::get_setup ( std::complex< double > &  mean,
double &  variance 
) [inline]

Get mean and variance.

Definition at line 510 of file random.h.

std::complex<double> itpp::Complex_Normal_RNG::operator() (  )  [inline]

Get one sample.

Definition at line 512 of file random.h.

References sample().

cvec itpp::Complex_Normal_RNG::operator() ( int  n  )  [inline]

Get a sample vector.

Definition at line 514 of file random.h.

References sample_vector().

cmat itpp::Complex_Normal_RNG::operator() ( int  h,
int  w 
) [inline]

Get a sample matrix.

Definition at line 516 of file random.h.

References sample_matrix().

std::complex<double> itpp::Complex_Normal_RNG::sample (  )  [inline]

Get a Complex Normal (0,1) distributed sample.

Definition at line 518 of file random.h.

References itpp::cos(), itpp::log(), itpp::m_2pi, itpp::Random_Generator::random_01(), itpp::sin(), and itpp::sqrt().

Referenced by operator()(), itpp::randn_c(), sample_matrix(), and sample_vector().

void itpp::Complex_Normal_RNG::sample_vector ( int  size,
cvec &  out 
) [inline]

Get a Complex Normal (0,1) distributed vector.

Definition at line 526 of file random.h.

References sample().

Referenced by operator()(), and itpp::randn_c().

void itpp::Complex_Normal_RNG::sample_matrix ( int  rows,
int  cols,
cmat &  out 
) [inline]

Get a Complex Normal (0,1) distributed matrix.

Definition at line 533 of file random.h.

References sample().

Referenced by operator()(), and itpp::randn_c().


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

Generated on Fri Jun 8 01:07:23 2007 for IT++ by Doxygen 1.5.2