NbinomParameter-class         package:distr         R Documentation

_C_l_a_s_s "_N_b_i_n_o_m_P_a_r_a_m_e_t_e_r"

_D_e_s_c_r_i_p_t_i_o_n:

     The parameter of a negative binomial distribution, used by
     Nbinom-class

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects can be created by calls of the form
     'new("NbinomParameter", prob, size)'. Usually an object of this
     class is not needed on its own, it is generated automatically when
     an object of the class Nbinom is prepared.

_S_l_o_t_s:

     '_p_r_o_b': Object of class '"numeric"': the probability of a negative
          binomial distribution 

     '_s_i_z_e': Object of class '"numeric"': the size of a negative
          binomial distribution 

     '_n_a_m_e': Object of class '"character"': a name / comment for the
          parameters 

_E_x_t_e_n_d_s:

     Class '"Parameter"', directly.

_M_e_t_h_o_d_s:

     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "NbinomParameter")': initialize
          method 

     _p_r_o_b 'signature(object = "NbinomParameter")': returns the slot
          'prob' of the parameter of the distribution 

     _p_r_o_b<- 'signature(object = "NbinomParameter")': modifies the slot
          'prob' of the parameter of the distribution 

     _s_i_z_e 'signature(object = "NbinomParameter")': returns the slot
          'size' of the parameter of the distribution 

     _s_i_z_e<- 'signature(object = "NbinomParameter")': modifies the slot
          'size' of the parameter of the distribution 

_A_u_t_h_o_r(_s):

     Thomas Stabla Thomas.Stabla@uni-bayreuth.de,
      Florian Camphausen Florian.Camphausen@uni-bayreuth.de,
      Peter Ruckdeschel Peter.Ruckdeschel@uni-bayreuth.de,
      Matthias Kohl Matthias.Kohl@uni-bayreuth.de

_S_e_e _A_l_s_o:

     'Nbinom-class' 'Parameter-class'

_E_x_a_m_p_l_e_s:

     W=new("NbinomParameter",prob=0.5,size=1)
     size(W) # size of this distribution is 1.
     size(W)=2 # size of this distribution is now 2.

