ns3::ParetoVariableImpl Class Reference

Inheritance diagram for ns3::ParetoVariableImpl:
Inheritance graph
[legend]
Collaboration diagram for ns3::ParetoVariableImpl:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ParetoVariableImpl ()
 ParetoVariableImpl (double m)
 ParetoVariableImpl (double m, double s)
 ParetoVariableImpl (double m, double s, double b)
 Constructs a pareto random variable with the specified mean.
 ParetoVariableImpl (const ParetoVariableImpl &c)
virtual double GetValue ()
virtual RandomVariableBaseCopy () const

Static Public Member Functions

static double GetSingleValue (double m, double s, double b=0)

Private Attributes

double m_mean
double m_shape
double m_bound

Detailed Description

Definition at line 702 of file random-variable.cc.


Constructor & Destructor Documentation

ns3::ParetoVariableImpl::ParetoVariableImpl (  ) 

Constructs a pareto random variable with a mean of 1 and a shape parameter of 1.5

Definition at line 763 of file random-variable.cc.

Referenced by Copy().

ns3::ParetoVariableImpl::ParetoVariableImpl ( double  m  )  [explicit]

Constructs a pareto random variable with specified mean and shape parameter of 1.5

Parameters:
m Mean value of the distribution

Definition at line 766 of file random-variable.cc.

ns3::ParetoVariableImpl::ParetoVariableImpl ( double  m,
double  s 
)

Constructs a pareto random variable with the specified mean value and shape parameter.

Parameters:
m Mean value of the distribution
s Shape parameter for the distribution

Definition at line 769 of file random-variable.cc.

ns3::ParetoVariableImpl::ParetoVariableImpl ( double  m,
double  s,
double  b 
)

Constructs a pareto random variable with the specified mean.

value, shape (alpha), and upper bound. Since pareto distributions can theoretically return unbounded values, it is sometimes useful to specify a fixed upper limit. Note however when the upper limit is specified, the true mean of the distribution is slightly smaller than the mean value specified.

Parameters:
m Mean value
s Shape parameter
b Upper limit on returned values

Definition at line 772 of file random-variable.cc.

ns3::ParetoVariableImpl::ParetoVariableImpl ( const ParetoVariableImpl c  ) 

Definition at line 775 of file random-variable.cc.


Member Function Documentation

RandomVariableBase * ns3::ParetoVariableImpl::Copy ( void   )  const [virtual]

Implements ns3::RandomVariableBase.

Definition at line 797 of file random-variable.cc.

References ParetoVariableImpl().

double ns3::ParetoVariableImpl::GetSingleValue ( double  m,
double  s,
double  b = 0 
) [static]
Parameters:
m The mean value of the distribution from which the return value is drawn.
s The shape parameter of the distribution from which the return value is drawn.
b The upper bound to which to restrict return values
Returns:
A random number from a Pareto distribution with mean m and shape parameter s.

Definition at line 802 of file random-variable.cc.

References ns3::RandomVariableBase::Initialize(), ns3::RngStream::InitializeStream(), ns3::RandomVariableBase::m_static_generator, and ns3::RngStream::RandU01().

double ns3::ParetoVariableImpl::GetValue (  )  [virtual]

Member Data Documentation

Definition at line 760 of file random-variable.cc.

Referenced by GetValue().

Definition at line 758 of file random-variable.cc.

Referenced by GetValue().

Definition at line 759 of file random-variable.cc.

Referenced by GetValue().


The documentation for this class was generated from the following file:
Generated on Thu Dec 3 14:10:26 2009 for NS-3 by  doxygen 1.6.3