tools::rbinomial< FLAT, REAL, UINT > Class Template Reference

Public Member Functions
	rbinomial (FLAT &a_flat, UINT a_n=1, REAL a_p=REAL(0.5))
virtual	~rbinomial ()
	rbinomial (const rbinomial &a_from)
rbinomial &	operator= (const rbinomial &a_from)
UINT	shoot () const
FLAT &	flat ()
void	set_seed (unsigned int a_seed)

Protected Attributes
FLAT &	m_flat
UINT	m_n
REAL	m_p

Detailed Description

template<class FLAT, class REAL, class UINT>
class tools::rbinomial< FLAT, REAL, UINT >

Definition at line 196 of file randT.

Constructor & Destructor Documentation

rbinomial() [1/2]

template<class FLAT , class REAL , class UINT >

tools::rbinomial< FLAT, REAL, UINT >::rbinomial ( FLAT &  a_flat, UINT  a_n = 1, REAL  a_p = REAL(0.5)  )

inline

Definition at line 198 of file randT.

:m_flat(a_flat),m_n(a_n),m_p(a_p){}

~rbinomial()

template<class FLAT , class REAL , class UINT >

virtual tools::rbinomial< FLAT, REAL, UINT >::~rbinomial ( )

inlinevirtual

Definition at line 199 of file randT.

{}

rbinomial() [2/2]

template<class FLAT , class REAL , class UINT >

tools::rbinomial< FLAT, REAL, UINT >::rbinomial ( const rbinomial< FLAT, REAL, UINT > &  a_from )

inline

Definition at line 201 of file randT.

:m_flat(a_from.m_flat),m_n(a_from.m_n),m_p(a_from.m_p){}

Member Function Documentation

flat()

template<class FLAT , class REAL , class UINT >

FLAT& tools::rbinomial< FLAT, REAL, UINT >::flat ( )

inline

Definition at line 229 of file randT.

{return m_flat;}

operator=()

template<class FLAT , class REAL , class UINT >

rbinomial& tools::rbinomial< FLAT, REAL, UINT >::operator= ( const rbinomial< FLAT, REAL, UINT > &  a_from )

inline

Definition at line 202 of file randT.

                                                {
    m_n = a_from.m_n;
    m_p = a_from.m_p;
    return *this;
  }

set_seed()

template<class FLAT , class REAL , class UINT >

void tools::rbinomial< FLAT, REAL, UINT >::set_seed ( unsigned int  a_seed )

inline

Definition at line 230 of file randT.

{m_flat.set_seed(a_seed);}

shoot()

template<class FLAT , class REAL , class UINT >

UINT tools::rbinomial< FLAT, REAL, UINT >::shoot ( ) const

inline

Generates a random integer N according to the binomial law. Coded from Los Alamos report LA-5061-MS.

N is binomially distributed between 0 and ntot inclusive with mean prob*ntot and prob is between 0 and 1.

Note: This function should not be used when ntot is large (say >100). The normal approximation is then recommended instead (with mean =*ntot+0.5 and standard deviation sqrt(ntot*prob*(1-prob)).

Definition at line 208 of file randT.

                     {
    // from ROOT/TRandom.cxx.
    if((m_p<REAL(0))||(REAL(1)<m_p)) return 0;
    UINT n = 0;
    for(UINT i=0;i<m_n;i++) {
      if(m_flat.shoot()>m_p) continue;
      n++;
    }
    return n;
  }

Member Data Documentation

m_flat

template<class FLAT , class REAL , class UINT >

FLAT& tools::rbinomial< FLAT, REAL, UINT >::m_flat

protected

Definition at line 232 of file randT.

m_n

template<class FLAT , class REAL , class UINT >

UINT tools::rbinomial< FLAT, REAL, UINT >::m_n

protected

Definition at line 233 of file randT.

m_p

template<class FLAT , class REAL , class UINT >

REAL tools::rbinomial< FLAT, REAL, UINT >::m_p

protected

Definition at line 234 of file randT.

---

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

• /Users/barrand/private/dev/softinex/g4tools/g4tools/tools/randT