Class GLMFamily
- java.lang.Object
-
- dev.nm.stat.regression.linear.glm.distribution.GLMFamily
-
- Direct Known Subclasses:
QuasiFamily
public class GLMFamily extends Object
Family
provides a convenient way to specify the error distribution and link function used in GLM model. The R equivalent function isfamily
.
-
-
Field Summary
Fields Modifier and Type Field Description protected GLMExponentialDistribution
dist
-
Constructor Summary
Constructors Constructor Description GLMFamily(GLMBinomial binomial)
Construct a Binomial family.GLMFamily(GLMExponentialDistribution dist, LinkFunction link)
Construct an instance ofFamily
.GLMFamily(GLMGamma gamma)
Construct a Gamma family.GLMFamily(GLMGaussian gaussian)
Construct a Gaussian family.GLMFamily(GLMInverseGaussian inverseGaussian)
Construct an Inverse Gaussian family.GLMFamily(GLMPoisson poisson)
Construct a Poisson family.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GLMExponentialDistribution
distribution()
LinkFunction
link()
Get the link function of this distribution.
-
-
-
Field Detail
-
dist
protected final GLMExponentialDistribution dist
-
-
Constructor Detail
-
GLMFamily
public GLMFamily(GLMExponentialDistribution dist, LinkFunction link)
Construct an instance ofFamily
.- Parameters:
dist
- the error distributionlink
- the link function of this distribution
-
GLMFamily
public GLMFamily(GLMBinomial binomial)
Construct a Binomial family. The default link isLinkLogit
.- Parameters:
binomial
- a Binomial distribution
-
GLMFamily
public GLMFamily(GLMGamma gamma)
Construct a Gamma family. The default link isLinkInverse
.- Parameters:
gamma
- a Gamma distribution
-
GLMFamily
public GLMFamily(GLMGaussian gaussian)
Construct a Gaussian family. The default link isLinkIdentity
.- Parameters:
gaussian
- a Gaussian distribution
-
GLMFamily
public GLMFamily(GLMInverseGaussian inverseGaussian)
Construct an Inverse Gaussian family. The default link isLinkInverseSquared
.- Parameters:
inverseGaussian
- an Inverse Gaussian distribution
-
GLMFamily
public GLMFamily(GLMPoisson poisson)
Construct a Poisson family. The default link isLinkLog
.- Parameters:
poisson
- a Poisson distribution
-
-
Method Detail
-
link
public LinkFunction link()
Get the link function of this distribution.- Returns:
- the link function of this distribution
-
distribution
public GLMExponentialDistribution distribution()
-
-