csl::Noise Class Reference

#include <Noise.h>

Inheritance diagram for csl::Noise:

csl::UnitGenerator csl::Scalable csl::Model csl::Controllable csl::PinkNoise csl::WhiteNoise

List of all members.

Public Member Functions

int generateRandomNumber ()
 returns the next pseudo-random number
float generateNormalizedRandomNumber ()
 returns next pseudo-random normalised to +/- 1.0
void setSeed (int seed)
 set the seed integer for the pseudo-random number generators
void dump ()
 Tell me more about what is happening.
 Noise ()
 Constructors.
 Noise (double ampl, double offset=0.0)
 Noise (int seed, double ampl=1.0, double offset=0.0)
 ~Noise ()

Protected Attributes

int mSeed
 Destructor.
float mDivisor
 factor to scale ints to +/- 1.0


Detailed Description

Abstract Noise class - inherits from UnitGenerator & Scalable, and provides constructors and basic pseudo-raondom methods

Constructor & Destructor Documentation

Noise::Noise (  ) 

Constructors.

Abstract Noise class Constructors call UnitGenerator & Scalable constructors Noise defaults to expansion copy policy (i.e. distinct noise per channel) if no seed is specified, current clock time is used

References csl::kExpand, and csl::UnitGenerator::setCopyPolicy().

Noise::Noise ( double  ampl,
double  offset = 0.0 
)

Noise::Noise ( int  seed,
double  ampl = 1.0,
double  offset = 0.0 
)

csl::Noise::~Noise (  )  [inline]


Member Function Documentation

int csl::Noise::generateRandomNumber (  )  [inline]

returns the next pseudo-random number

References mSeed.

Referenced by csl::PinkNoise::nextPink().

float csl::Noise::generateNormalizedRandomNumber (  )  [inline]

returns next pseudo-random normalised to +/- 1.0

References mSeed.

void csl::Noise::setSeed ( int  seed  )  [inline]

set the seed integer for the pseudo-random number generators

References mSeed.

void Noise::dump ( void   )  [virtual]

Tell me more about what is happening.

Reimplemented from csl::UnitGenerator.

References csl::logMsg().


Member Data Documentation

int csl::Noise::mSeed [protected]

Destructor.

seed integer for the pseudo-random number generators

Referenced by generateNormalizedRandomNumber(), generateRandomNumber(), and setSeed().

float csl::Noise::mDivisor [protected]

factor to scale ints to +/- 1.0


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

Generated on Thu Sep 17 23:14:17 2009 for CSL by  doxygen 1.5.8