NAG Library Function Document

nag_binary_factor_service (g11sbc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:     order – Nag_OrderTypeInput

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by $\mathbf{order}=\mathrm{Nag\_RowMajor}$. See Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.

Constraint: $\mathbf{order}=\mathrm{Nag\_RowMajor}$ or $\mathrm{Nag\_ColMajor}$.

2:     p – IntegerInput

On entry: $p$, the number of dichotomous variables.

Constraint: $\mathbf{p}\ge 3$.

3:     n – IntegerInput

On entry: $n$, the number of individuals in the sample.

Constraint: $\mathbf{n}\ge 7$.

4:     ns – Integer *Output

On exit: the number of different score patterns, $s$.

5:     x[$\mathit{dim}$] – Nag_BooleanInput/Output

Note: the dimension, dim, of the array x must be at least

• $\max \left(1,\mathbf{pdx}\times \mathbf{p}\right)$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\max \left(1,\mathbf{n}\times \mathbf{pdx}\right)$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

Where $\mathbf{X}\left(i,j\right)$ appears in this document, it refers to the array element

• $\mathbf{x}\left[\left(j-1\right)\times \mathbf{pdx}+i-1\right]$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\mathbf{x}\left[\left(i-1\right)\times \mathbf{pdx}+j-1\right]$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

On entry: $\mathbf{X}\left(\mathit{i},\mathit{j}\right)$ must be set equal to Nag_TRUE if $x_{\mathit{i}\mathit{j}}=1$, and Nag_FALSE if $x_{\mathit{i}\mathit{j}}=0$, for $\mathit{i}=1,2,\dots ,n$ and $\mathit{j}=1,2,\dots ,p$.

On exit: the first $s$ rows of x contain the $s$ different score patterns.

6:     pdx – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array x.

Constraints:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $\mathbf{pdx}\ge \mathbf{n}$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $\mathbf{pdx}\ge \mathbf{p}$.

7:     irl[n] – IntegerOutput

On exit: the frequency with which the $\mathit{l}$th row of x occurs, for $\mathit{l}=1,2,\dots ,s$.

8:     fail – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.

NE_BAD_PARAM

On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.

NE_INT

On entry, $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{n}\ge 7$.

On entry, $\mathbf{p}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{p}\ge 3$.

On entry, $\mathbf{pdx}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdx}>0$.

NE_INT_2

On entry, $\mathbf{pdx}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdx}\ge \mathbf{n}$.

On entry, $\mathbf{pdx}=⟨\mathit{\text{value}}⟩$ and $\mathbf{p}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdx}\ge \mathbf{p}$.

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (g11sbce.c)

10.2  Program Data

Program Data (g11sbce.d)

10.3  Program Results

Program Results (g11sbce.r)