Package dev.nm.stat.regression.linear.glm.distribution

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 is family.

Field Summary

Fields

Modifier and Type	Field	Description
protected final GLMExponentialDistribution	dist

Constructor Summary

Constructors

Constructor	Description
GLMFamily(GLMBinomial binomial)	Construct a Binomial family.
GLMFamily(GLMExponentialDistribution dist, LinkFunction link)	Construct an instance of Family.
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

Modifier and Type	Method	Description
GLMExponentialDistribution	distribution()
LinkFunction	link()	Get the link function of this distribution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dist

protected final GLMExponentialDistribution dist

Constructor Details

GLMFamily

public GLMFamily(GLMExponentialDistribution dist,
 LinkFunction link)

Construct an instance of Family.

Parameters:

dist - the error distribution

link - the link function of this distribution

GLMFamily

public GLMFamily(GLMBinomial binomial)

Construct a Binomial family. The default link is LinkLogit.

Parameters:

binomial - a Binomial distribution

GLMFamily

public GLMFamily(GLMGamma gamma)

Construct a Gamma family. The default link is LinkInverse.

Parameters:

gamma - a Gamma distribution

GLMFamily

public GLMFamily(GLMGaussian gaussian)

Construct a Gaussian family. The default link is LinkIdentity.

Parameters:

gaussian - a Gaussian distribution

GLMFamily

public GLMFamily(GLMInverseGaussian inverseGaussian)

Construct an Inverse Gaussian family. The default link is LinkInverseSquared.

Parameters:

inverseGaussian - an Inverse Gaussian distribution

GLMFamily

public GLMFamily(GLMPoisson poisson)

Construct a Poisson family. The default link is LinkLog.

Parameters:

poisson - a Poisson distribution

Method Details

link

public LinkFunction link()

Get the link function of this distribution.

Returns:

the link function of this distribution

distribution

public GLMExponentialDistribution distribution()