CategoricalGenLinModel.OptionalDistributionParameterColumn Property

CategoricalGenLinModelOptionalDistributionParameterColumn Property

The column number in x that contains an optional distribution parameter for each observation.

Namespace: Imsl.Stat
Assembly: ImslCS (in ImslCS.dll) Version: 6.5.2.0

Syntax

public virtual int OptionalDistributionParameterColumn { set; }

Public Overridable WriteOnly Property OptionalDistributionParameterColumn As Integer
	Set

public:
virtual property int OptionalDistributionParameterColumn {
	void set (int value);
}

abstract OptionalDistributionParameterColumn : int with set
override OptionalDistributionParameterColumn : int with set

Type: Int32
An int scalar which indicates the column number in x that contains an optional distribution parameter for each observation.

Exceptions

Exception	Condition
ArgumentException	is thrown when OptionalDistributionParameterColumn is less than 0 or greater than or equal to the number of columns of x

Remarks

The distribution parameter values are interpreted as follows depending on the model chosen:

Model	Meaning of x[i,OptionalDistributionParameterColumn]
0	The Poisson parameter is given by $x[i,OptionalDistributionParameterColumn]\times{e^\rho}$ .
1	The number of successes required in the negative binomial is given by x[i,OptionalDistributionParameterColumn].
2	x[i,OptionalDistributionParameterColumn] is not used.
3-5	The number of trials in the binomial distribution is given by x[i,OptionalDistributionParameterColumn].

By default, the distribution parameter is assumed to be 1.