HyperParameter-class
Class "HyperParameter"
The parameter of a hypergeometric distribution, used by Hyper
-class
- Keywords
- distribution
Objects from the Class
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.
Slots
k
Object of class
"numeric"
: k of a hypergeometric distributionm
Object of class
"numeric"
: m of a hypergeometric distributionn
Object of class
"numeric"
: n of a hypergeometric distributionname
Object of class
"character"
: a name / comment for the parameters
Extends
Class "Parameter"
, directly.
Methods
- initialize
signature(.Object = "HyperParameter")
: initialize method- k
signature(object = "HyperParameter")
: returns the slotk
of the parameter of the distribution- k<-
signature(object = "HyperParameter")
: modifies the slotk
of the parameter of the distribution- m
signature(object = "HyperParameter")
: returns the slotm
of the parameter of the distribution- m<-
signature(object = "HyperParameter")
: modifies the slotm
of the parameter of the distribution- n
signature(object = "HyperParameter")
: returns the slotn
of the parameter of the distribution- n<-
signature(object = "HyperParameter")
: modifies the slotn
of the parameter of the distribution
See Also
Examples
# NOT RUN {
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.
# }