CLHEP::RandSkewNormal Class Reference

#include <RandSkewNormal.h>

Inheritance diagram for CLHEP::RandSkewNormal:

Public Member Functions
	RandSkewNormal (HepRandomEngine &anEngine, double shape=0.)
	RandSkewNormal (HepRandomEngine *anEngine, double shape=0.)
virtual	~RandSkewNormal ()
double	fire ()
double	fire (double shape)
void	fireArray (const int size, double *vect)
void	fireArray (const int size, double *vect, double shape)
double	operator() ()
double	operator() (double shape)
std::ostream &	put (std::ostream &os) const
std::istream &	get (std::istream &is)
std::string	name () const
HepRandomEngine &	engine ()
Public Member Functions inherited from CLHEP::HepRandom
	HepRandom ()
	HepRandom (long seed)
	HepRandom (HepRandomEngine &algorithm)
	HepRandom (HepRandomEngine *algorithm)
virtual	~HepRandom ()
double	flat ()
void	flatArray (const int size, double *vect)
double	flat (HepRandomEngine *theNewEngine)
void	flatArray (HepRandomEngine *theNewEngine, const int size, double *vect)
virtual double	operator() ()
virtual std::string	name () const
virtual HepRandomEngine &	engine ()
virtual std::ostream &	put (std::ostream &os) const
virtual std::istream &	get (std::istream &is)

Static Public Member Functions
static double	shoot ()
static double	shoot (double shape)
static void	shootArray (const int size, double *vect, double shape=0.)
static double	shoot (HepRandomEngine *anEngine)
static double	shoot (HepRandomEngine *anEngine, double shape)
static void	shootArray (HepRandomEngine *anEngine, const int size, double *vect, double shape=0.)
static std::string	distributionName ()
Static Public Member Functions inherited from CLHEP::HepRandom
static void	setTheSeed (long seed, int lxr=3)
static long	getTheSeed ()
static void	setTheSeeds (const long *seeds, int aux=-1)
static const long *	getTheSeeds ()
static void	getTheTableSeeds (long *seeds, int index)
static HepRandom *	getTheGenerator ()
static void	setTheEngine (HepRandomEngine *theNewEngine)
static HepRandomEngine *	getTheEngine ()
static void	saveEngineStatus (const char filename[]="Config.conf")
static void	restoreEngineStatus (const char filename[]="Config.conf")
static std::ostream &	saveFullState (std::ostream &os)
static std::istream &	restoreFullState (std::istream &is)
static std::ostream &	saveDistState (std::ostream &os)
static std::istream &	restoreDistState (std::istream &is)
static std::ostream &	saveStaticRandomStates (std::ostream &os)
static std::istream &	restoreStaticRandomStates (std::istream &is)
static void	showEngineStatus ()
static int	createInstance ()
static std::string	distributionName ()

Protected Member Functions
double	getShapeParameter ()
HepRandomEngine *	getLocalEngine ()

Static Protected Member Functions
static double	gaussianSkewNormal (HepRandomEngine *e, double k)

Additional Inherited Members
Static Protected Attributes inherited from CLHEP::HepRandom
static const long	seedTable [215][2]

Detailed Description

Author

mf@fn.nosp@m.al.g.nosp@m.ov

Definition at line 34 of file RandSkewNormal.h.

Constructor & Destructor Documentation

RandSkewNormal() [1/2]

CLHEP::RandSkewNormal::RandSkewNormal ( HepRandomEngine &  anEngine, double  shape = 0.  )

inline

RandSkewNormal() [2/2]

CLHEP::RandSkewNormal::RandSkewNormal ( HepRandomEngine *  anEngine, double  shape = 0.  )

inline

~RandSkewNormal()

CLHEP::RandSkewNormal::~RandSkewNormal ( )

virtual

Definition at line 29 of file RandSkewNormal.cc.

{}

Member Function Documentation

distributionName()

static std::string CLHEP::RandSkewNormal::distributionName ( )

inlinestatic

Definition at line 92 of file RandSkewNormal.h.

{return "RandSkewNormal";}  

engine()

HepRandomEngine & CLHEP::RandSkewNormal::engine ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 27 of file RandSkewNormal.cc.

{return *localEngine;}

fire() [1/2]

double CLHEP::RandSkewNormal::fire

(

)

Definition at line 85 of file RandSkewNormal.cc.

                            {
  return gaussianSkewNormal( getLocalEngine(), getShapeParameter() );
}

Referenced by fireArray(), operator()(), and testSkewNormal().

fire() [2/2]

double CLHEP::RandSkewNormal::fire

(

double

shape

)

Definition at line 89 of file RandSkewNormal.cc.

                                        {
  return gaussianSkewNormal( getLocalEngine(), shape );
}

fireArray() [1/2]

void CLHEP::RandSkewNormal::fireArray	(	const int	size,
		double *	vect
	)

Definition at line 93 of file RandSkewNormal.cc.

{
  for( double* v = vect; v != vect+size; ++v )
    *v = fire( shapeParameter );
}

fireArray() [2/2]

void CLHEP::RandSkewNormal::fireArray	(	const int	size,
		double *	vect,
		double	shape
	)

Definition at line 99 of file RandSkewNormal.cc.

{
  for( double* v = vect; v != vect+size; ++v )
    *v = fire( shape );
}

gaussianSkewNormal()

double CLHEP::RandSkewNormal::gaussianSkewNormal ( HepRandomEngine *  e, double  k  )

staticprotected

Definition at line 108 of file RandSkewNormal.cc.

{ 
  // RandSkewNormal is an implementation of Azzalini's SN generator
  // http://azzalini.stat.unipd.it/SN/
  // K. McFarlane, June 2010.
  // For location parameter m = 0., scale = 1.
  // To get a distribution with scale parameter b and location m:
  //    r = m + b * RandSkewNormal.fire(k);
  double u[2] = {0.};
  RandGaussT::shootArray(e, 2, u, 0, 1);
  double delta = k/std::sqrt(1. + k*k);
  double u1 = delta*u[0] + std::sqrt(1 - delta*delta)*u[1];
  double r = u[0] >= 0 ? u1 : -u1;
  return r;
}

Referenced by fire(), and shoot().

get()

std::istream & CLHEP::RandSkewNormal::get ( std::istream &  is )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 137 of file RandSkewNormal.cc.

                                                   {
  std::string inName;
  is >> inName;
  if (inName != name()) {
    is.clear(std::ios::badbit | is.rdstate());
    std::cerr << "Mismatch when expecting to read state of a "
              << name() << " distribution\n"
          << "Name found was " << inName
          << "\nistream is left in the badbit state\n";
    return is;
  }
  if (possibleKeywordInput(is, "Uvec", shapeParameter)) {
    std::vector<unsigned long> t(2);
    is >> shapeParameter >> t[0] >> t[1]; shapeParameter = DoubConv::longs2double(t); 
    return is;
  }
  // is >> shapeParameter encompassed by possibleKeywordInput
  return is;
}

getLocalEngine()

HepRandomEngine * CLHEP::RandSkewNormal::getLocalEngine ( )

inlineprotected

Referenced by fire().

getShapeParameter()

double CLHEP::RandSkewNormal::getShapeParameter ( )

inlineprotected

Definition at line 98 of file RandSkewNormal.h.

{ return shapeParameter; }

Referenced by fire().

name()

std::string CLHEP::RandSkewNormal::name ( ) const

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 26 of file RandSkewNormal.cc.

{return "RandSkewNormal";}

Referenced by get(), and put().

operator()() [1/2]

double CLHEP::RandSkewNormal::operator() ( )

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 31 of file RandSkewNormal.cc.

{
  return fire( shapeParameter );
}

operator()() [2/2]

double CLHEP::RandSkewNormal::operator()

(

double

shape

)

Definition at line 36 of file RandSkewNormal.cc.

{
  return fire( shape );
}

put()

std::ostream & CLHEP::RandSkewNormal::put ( std::ostream &  os ) const

virtual

Reimplemented from CLHEP::HepRandom.

Definition at line 126 of file RandSkewNormal.cc.

                                                         {
  long pr=os.precision(20);
  std::vector<unsigned long> t(2);
  os << " " << name() << "\n";
  os << "Uvec" << "\n";
  t = DoubConv::dto2longs(shapeParameter);
  os << shapeParameter << " " << t[0] << " " << t[1] << "\n";
  os.precision(pr);
  return os;
}

shoot() [1/4]

double CLHEP::RandSkewNormal::shoot ( )

static

Definition at line 55 of file RandSkewNormal.cc.

{
  // really dumb use of RandSkewNormal
  HepRandomEngine* anEngine = HepRandom::getTheEngine();
  double k = 1;
  return gaussianSkewNormal( anEngine, k );
}

Referenced by captureStatics(), randomizeStatics(), and shootArray().

shoot() [2/4]

double CLHEP::RandSkewNormal::shoot ( double  shape )

static

Definition at line 63 of file RandSkewNormal.cc.

{
  HepRandomEngine* anEngine = HepRandom::getTheEngine();
  return gaussianSkewNormal( anEngine, shape );
}

shoot() [3/4]

double CLHEP::RandSkewNormal::shoot ( HepRandomEngine *  anEngine )

static

Definition at line 43 of file RandSkewNormal.cc.

{
  // really dumb use of RandSkewNormal
  double k = 1;
  return gaussianSkewNormal( anEngine, k );
}

shoot() [4/4]

double CLHEP::RandSkewNormal::shoot ( HepRandomEngine *  anEngine, double  shape  )

static

Definition at line 50 of file RandSkewNormal.cc.

{
  return gaussianSkewNormal( anEngine, shape );
}

shootArray() [1/2]

void CLHEP::RandSkewNormal::shootArray ( const int  size, double *  vect, double  shape = 0.  )

static

Definition at line 69 of file RandSkewNormal.cc.

{
  for( double* v = vect; v != vect+size; ++v )
    *v = shoot(shape);
}

shootArray() [2/2]

void CLHEP::RandSkewNormal::shootArray ( HepRandomEngine *  anEngine, const int  size, double *  vect, double  shape = 0.  )

static

Definition at line 76 of file RandSkewNormal.cc.

{
  for( double* v = vect; v != vect+size; ++v )
    *v = shoot(anEngine, shape);
}

---

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

• RandSkewNormal.h
• RandSkewNormal.cc