A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::ZetaVariable Class Reference

Zeta Distributed Distributed Random VariableZetaVariable defines a discrete random variable with Zeta distribution. More...

#include <random-variable.h>

+ Inheritance diagram for ns3::ZetaVariable:

Public Member Functions

 ZetaVariable (double alpha)
 Returns a Zeta random variable with parameter alpha. More...
 
 ZetaVariable ()
 
- Public Member Functions inherited from ns3::RandomVariable
 RandomVariable (const RandomVariable &o)
 
uint32_t GetInteger (void) const
 Returns a random integer integer from the underlying distribution. More...
 
double GetValue (void) const
 Returns a random double from the underlying distribution. More...
 
RandomVariableoperator= (const RandomVariable &o)
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::RandomVariable
 RandomVariable (const RandomVariableBase &variable)
 
RandomVariableBasePeek (void) const
 

Detailed Description

Zeta Distributed Distributed Random Variable

ZetaVariable defines a discrete random variable with Zeta distribution.

The Zeta distribution is closely related to Zipf distribution when N goes to infinity.

Zeta distribution has one parameter, alpha, $ \alpha > 1 $ (real). Probability Mass Function is $ f(k; \alpha) = k^{-\alpha}/\zeta(\alpha) $ where $ \zeta(\alpha) $ is the Riemann zeta function ( $ \sum_{n=1}^\infty n^{-\alpha} ) $

Definition at line 698 of file random-variable.h.

Constructor & Destructor Documentation

ns3::ZetaVariable::ZetaVariable ( double  alpha)

Returns a Zeta random variable with parameter alpha.

Parameters
alphathe alpha parameter. Must be a strictly greater than 1, real.

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

References NS_LOG_FUNCTION.

ns3::ZetaVariable::ZetaVariable ( )

Constructs a Zeta random variable with alpha=3.14

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

References NS_LOG_FUNCTION.


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