CLHEP::RandMultiGauss Class Reference

#include <RandMultiGauss.h>

Inheritance diagram for CLHEP::RandMultiGauss:

Public Member Functions
	RandMultiGauss (HepRandomEngine &anEngine, const HepVector &mu, const HepSymMatrix &S)
	RandMultiGauss (HepRandomEngine *anEngine, const HepVector &mu, const HepSymMatrix &S)
	RandMultiGauss (HepRandomEngine &anEngine)
	RandMultiGauss (HepRandomEngine *anEngine)
virtual	~RandMultiGauss ()
HepVector	fire ()
HepVector	fire (const HepVector &mu, const HepSymMatrix &S)
void	fireArray (const int size, HepVector *array)
void	fireArray (const int size, HepVector *array, const HepVector &mu, const HepSymMatrix &S)
HepVector	operator() ()
HepVector	operator() (const HepVector &mu, const HepSymMatrix &S)
Public Member Functions inherited from CLHEP::HepRandomVector
	HepRandomVector ()
	HepRandomVector (long seed)
	HepRandomVector (HepRandomEngine &engine)
	HepRandomVector (HepRandomEngine *engine)
virtual	~HepRandomVector ()
HepVector	flat ()
HepVector	flat (HepRandomEngine *theNewEngine)
void	flatArray (const int size, HepVector *vect)
void	flatArray (HepRandomEngine *theNewEngine, const int size, HepVector *vect)
virtual HepVector	operator() ()

Additional Inherited Members
Protected Attributes inherited from CLHEP::HepRandomVector
HepRandomEngine *	theEngine

Detailed Description

Author

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

Definition at line 45 of file RandMultiGauss.h.

Constructor & Destructor Documentation

RandMultiGauss() [1/4]

CLHEP::RandMultiGauss::RandMultiGauss	(	HepRandomEngine &	anEngine,
		const HepVector &	mu,
		const HepSymMatrix &	S
	)

Definition at line 59 of file RandMultiGauss.cc.

      : localEngine(&anEngine), 
    deleteEngine(false), 
    set(false),
    nextGaussian(0.0)
{ 
  if (S.num_row() != mu.num_row()) {
    std::cerr << "In constructor of RandMultiGauss distribution: \n" <<
            "      Dimension of mu (" << mu.num_row() << 
        ") does not match dimension of S (" << S.num_row() << ")\n";
    std::cerr << "---Exiting to System\n";
    exit(1);
  }
  defaultMu = mu;
  defaultSigmas = HepVector(S.num_row());
  prepareUsigmas (S,  defaultU, defaultSigmas);
}

RandMultiGauss() [2/4]

CLHEP::RandMultiGauss::RandMultiGauss	(	HepRandomEngine *	anEngine,
		const HepVector &	mu,
		const HepSymMatrix &	S
	)

Definition at line 79 of file RandMultiGauss.cc.

      : localEngine(anEngine), 
    deleteEngine(true), 
    set(false),
    nextGaussian(0.0)
{ 
  if (S.num_row() != mu.num_row()) {
    std::cerr << "In constructor of RandMultiGauss distribution: \n" <<
            "      Dimension of mu (" << mu.num_row() << 
        ") does not match dimension of S (" << S.num_row() << ")\n";
    std::cerr << "---Exiting to System\n";
    exit(1);
  }
  defaultMu = mu;
  defaultSigmas = HepVector(S.num_row());
  prepareUsigmas (S,  defaultU, defaultSigmas);
}

RandMultiGauss() [3/4]

CLHEP::RandMultiGauss::RandMultiGauss

(

HepRandomEngine &

anEngine

)

Definition at line 99 of file RandMultiGauss.cc.

      : localEngine(&anEngine), 
    deleteEngine(false), 
    set(false),
    nextGaussian(0.0)
{ 
  defaultMu = HepVector(2,0);
  defaultU  = HepMatrix(2,1);
  defaultSigmas = HepVector(2);
  defaultSigmas(1) = 1.;
  defaultSigmas(2) = 1.;
}

RandMultiGauss() [4/4]

CLHEP::RandMultiGauss::RandMultiGauss

(

HepRandomEngine *

anEngine

)

Definition at line 112 of file RandMultiGauss.cc.

      : localEngine(anEngine), 
    deleteEngine(true), 
    set(false),
    nextGaussian(0.0)
{ 
  defaultMu = HepVector(2,0);
  defaultU  = HepMatrix(2,1);
  defaultSigmas = HepVector(2);
  defaultSigmas(1) = 1.;
  defaultSigmas(2) = 1.;
}

~RandMultiGauss()

CLHEP::RandMultiGauss::~RandMultiGauss ( )

virtual

Definition at line 125 of file RandMultiGauss.cc.

                                {
  if ( deleteEngine ) delete localEngine;
}

Member Function Documentation

fire() [1/2]

HepVector CLHEP::RandMultiGauss::fire

(

)

Definition at line 211 of file RandMultiGauss.cc.

                               {
  // Returns a pair of unit normals, using the S and mu set in constructor,
  // utilizing the engine belonging to this instance of RandMultiGauss.
 
  return defaultMu + deviates ( defaultU, defaultSigmas, 
                    localEngine, set, nextGaussian );
 
} // fire();

Referenced by operator()(), and testRandMultiGauss().

fire() [2/2]

HepVector CLHEP::RandMultiGauss::fire	(	const HepVector &	mu,
		const HepSymMatrix &	S
	)

Definition at line 221 of file RandMultiGauss.cc.

                                                                           {
 
  HepMatrix U;  
  HepVector sigmas(mu.num_row());
 
  if (mu.num_row() == S.num_row()) {
    prepareUsigmas ( S, U, sigmas );
    return mu + deviates ( U, sigmas, localEngine, set, nextGaussian );
  } else {
    std::cerr << "In firing RandMultiGauss distribution with explicit mu and S: \n"
         << "      Dimension of mu (" << mu.num_row() << 
        ") does not match dimension of S (" << S.num_row() << ")\n";
    std::cerr << "---Exiting to System\n";
    exit(1);
  }
  return mu;    // This line cannot be reached.  But without returning 
        // some HepVector here, KCC 3.3 complains.
 
} // fire(mu, S);

fireArray() [1/2]

void CLHEP::RandMultiGauss::fireArray	(	const int	size,
		HepVector *	array
	)

Definition at line 246 of file RandMultiGauss.cc.

                                                                 {
 
  int i;
  for (i = 0; i < size; ++i) {
    array[i] = defaultMu + deviates ( defaultU, defaultSigmas, 
                    localEngine, set, nextGaussian );
  } 
 
} // fireArray ( size, vect )

fireArray() [2/2]

void CLHEP::RandMultiGauss::fireArray	(	const int	size,
		HepVector *	array,
		const HepVector &	mu,
		const HepSymMatrix &	S
	)

Definition at line 257 of file RandMultiGauss.cc.

                                                                              {
 
  // For efficiency, we diagonalize S once and generate all the vectors based
  // on that U and sigmas.
 
  HepMatrix U;  
  HepVector sigmas(mu.num_row());
  HepVector mu_ (mu);
 
  if (mu.num_row() == S.num_row()) {
    prepareUsigmas ( S, U, sigmas );
  } else {
    std::cerr << 
    "In fireArray for RandMultiGauss distribution with explicit mu and S: \n"
         << "      Dimension of mu (" << mu.num_row() << 
        ") does not match dimension of S (" << S.num_row() << ")\n";
    std::cerr << "---Exiting to System\n";
    exit(1);
  }
 
  int i;
  for (i=0; i<size; ++i) {
    array[i] = mu_ + deviates(U, sigmas, localEngine, set, nextGaussian);
  }
 
} // fireArray ( size, vect, mu, S )

operator()() [1/2]

HepVector CLHEP::RandMultiGauss::operator() ( )

virtual

Reimplemented from CLHEP::HepRandomVector.

Definition at line 289 of file RandMultiGauss.cc.

                                     {
  return fire();
} 

operator()() [2/2]

HepVector CLHEP::RandMultiGauss::operator()	(	const HepVector &	mu,
		const HepSymMatrix &	S
	)

Definition at line 293 of file RandMultiGauss.cc.

                                                           {
  return fire(mu,S);
} 

---

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

• RandMultiGauss.h
• RandMultiGauss.cc