CauchyParameter-class         package:distr         R Documentation

_C_l_a_s_s "_C_a_u_c_h_y_P_a_r_a_m_e_t_e_r"

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

     The parameter of a Cauchy distribution, used by Cauchy-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("CauchyParameter", location, scale)'. Usually an object of
     this class is not needed on its own, it is generated automatically
     when an object of the class Cauchy is instantiated.

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

     '_l_o_c_a_t_i_o_n': Object of class '"numeric"': the location of a Cauchy
          distribution 

     '_s_c_a_l_e': Object of class '"numeric"': the scale of a Cauchy
          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 = "CauchyParameter")': initialize
          method 

     _s_c_a_l_e 'signature(object = "CauchyParameter")': returns the slot
          'scale' of the parameter of the distribution

     _s_c_a_l_e<- 'signature(object = "CauchyParameter")': modifies the slot
          'scale' of the parameter of the distribution 

     _l_o_c_a_t_i_o_n 'signature(object = "CauchyParameter")': returns the slot
          'location' of the parameter of the distribution 

     _l_o_c_a_t_i_o_n<- 'signature(object = "CauchyParameter")': modifies the
          slot 'location' 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:

     'Cauchy-class' 'Parameter-class'

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

     W=new("CauchyParameter",location=1,scale=1)
     location(W) # location of this distribution is 1.
     location(W)=2 # location of this distribution is now 2.

