HyperParameter-class          package:distr          R Documentation

_C_l_a_s_s "_H_y_p_e_r_P_a_r_a_m_e_t_e_r"

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

     The parameter of a hypergeometric distribution, used by
     'Hyper'-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("HyperParameter",
     k, m, n)'. Usually an object of this class is not needed on its
     own, it is generated automatically when an object of the class
     'Hyper' is instantiated.

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

     '_k': Object of class '"numeric"': k of a hypergeometric
          distribution 

     '_m': Object of class '"numeric"': m of a hypergeometric
          distribution 

     '_n': Object of class '"numeric"': n of a hypergeometric
          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 = "HyperParameter")': initialize
          method 

     _k 'signature(object = "HyperParameter")': returns the slot 'k' of
          the parameter of the distribution 

     _k<- 'signature(object = "HyperParameter")': modifies the slot 'k'
          of the parameter of the distribution 

     _m 'signature(object = "HyperParameter")': returns the slot 'm' of
          the parameter of the distribution 

     _m<- 'signature(object = "HyperParameter")': modifies the slot 'm'
          of the parameter of the distribution 

     _n 'signature(object = "HyperParameter")': returns the slot 'n' of
          the parameter of the distribution 

     _n<- 'signature(object = "HyperParameter")': modifies the slot 'n'
          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:

     'Hyper-class' 'Parameter-class'

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

     W=new("HyperParameter",k=3, m=3, n=3)
     m(W) # m of this distribution is 3.
     m(W)=2 # m of this distribution is now 2.

