HyperParameter-class

0th

Percentile

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 distribution
m
Object of class "numeric": m of a hypergeometric distribution
n
Object of class "numeric": n of a hypergeometric distribution
name
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 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

See Also

Hyper-class Parameter-class

Aliases
  • HyperParameter-class
  • initialize,HyperParameter-method
Examples
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.
Documentation reproduced from package distr, version 2.6, License: LGPL-3

Community examples

Looks like there are no examples yet.