Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::math::ExponentialDistribution< double > Class Template Reference

A class that generates an exponential probability distribution for 64-bit floats. More...

#include <omExponentialDistribution.h>

Public Member Functions

 ExponentialDistribution ()
 Create an exponential distribution with lambda equal to 1. More...
 
 ExponentialDistribution (double newLambda)
 Create an exponential distribution with lambda equal to the specified value. More...
 
double sample ()
 Generate a sample from the exponential distribution. More...
 
double getLambda () const
 Get the lambda parameter of this exponential distribution. More...
 
void setLambda (double newLambda)
 Set the lambda parameter of this exponential distribution. More...
 
Random< double > & getRandom ()
 Get the random variable used to generate samples for this distribution. More...
 
const Random< double > & getRandom () const
 Get the random variable used to generate samples for this distribution. More...
 
void setRandom (const Random< double > &newRandom)
 Set the random variable used to generate samples for this distribution. More...
 

Detailed Description

template<>
class om::math::ExponentialDistribution< double >

A class that generates an exponential probability distribution for 64-bit floats.

Constructor & Destructor Documentation

Create an exponential distribution with lambda equal to 1.

om::math::ExponentialDistribution< double >::ExponentialDistribution ( double  newLambda)
inline

Create an exponential distribution with lambda equal to the specified value.

Member Function Documentation

double om::math::ExponentialDistribution< double >::sample ( )
inline

Generate a sample from the exponential distribution.

double om::math::ExponentialDistribution< double >::getLambda ( ) const
inline

Get the lambda parameter of this exponential distribution.

void om::math::ExponentialDistribution< double >::setLambda ( double  newLambda)
inline

Set the lambda parameter of this exponential distribution.

Random<double>& om::math::ExponentialDistribution< double >::getRandom ( )
inline

Get the random variable used to generate samples for this distribution.

const Random<double>& om::math::ExponentialDistribution< double >::getRandom ( ) const
inline

Get the random variable used to generate samples for this distribution.

void om::math::ExponentialDistribution< double >::setRandom ( const Random< double > &  newRandom)
inline

Set the random variable used to generate samples for this distribution.


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