Stata 11 help for mf_j
help mata J()
-------------------------------------------------------------------------------
Title
[M-5] J() -- Matrix of constants
Syntax
transmorphic matrix J(real scalar r, real scalar c, scalar val)
transmorphic matrix J(real scalar r, real scalar c, matrix mat)
Description
J(r, c, val) returns an r x c matrix with each element equal to val.
J(r, c, mat) returns an (r*rows(mat)) x (c*cols(mat)) matrix with
elements equal to mat.
The first, J(r, c, val), is how J() is commonly used. The first is
nothing more than a special case of the second, J(r, c, mat), when mat is
1 x 1.
Remarks
First syntax: J(r, c, val), val a scalar
J(r, c, val) creates matrices of constants. For example, J(2, 3, 0)
creates
1 2 3
+-------------+
1 | 0 0 0 |
2 | 0 0 0 |
+-------------+
J() must be typed in uppercase.
J() can create any type of matrix:
function returns
------------------------------------------------------------------
J(2, 3, 4) 2 x 3 real matrix, each element = 4
J(2, 3, 4+5i) 2 x 3 complex matrix, each element = 4+5i
J(2, 3, "hi") 2 x 3 string matrix, each element = "hi"
J(2, 3, &x) 2 x 3 pointer matrix, each element = address of x
------------------------------------------------------------------
Also, J() can create void matrices:
J(0, 0, .) 0 x 0 real
J(0, 1, .) 0 x 1 real
J(1, 0, .) 1 x 0 real
J(0, 0, 1i) 0 x 0 complex
J(0, 1, 1i) 0 x 1 complex
J(1, 0, 1i) 1 x 0 complex
J(0, 0, "") 0 x 0 string
J(0, 1, "") 0 x 1 string
J(1, 0, "") 1 x 0 string
J(0, 0, NULL) 0 x 0 pointer
J(0, 1, NULL) 0 x 1 pointer
J(1, 0, NULL) 1 x 0 pointer
When J(r, c, val) is used to create a void matrix, the particular value
of the third argument does not matter. Its element type, however,
determines the type of matrix produced. Thus, J(0, 0, .), J(0, 0, 1),
and J(0, 0, 1/3) all create the same result: a 0 x 0 real matrix.
Similarly, J(0, 0, ""), J(0, 0, "name"), and J(0, 0, "?") all create the
same result: a 0 x 0 string matrix. See [M-2] void to learn how void
matrices are used.
Second syntax: J(r, c, mat), mat a matrix
J(r, c, mat) is a generalization of J(r, c, val). When the third
argument is a matrix, that matrix is replicated in the result. For
instance, if X is (1,2\3,4), then J(2, 3, X) creates
1 2 3 4 5 6
+-------------------------+
1 | 1 2 1 2 1 2 |
2 | 3 4 3 4 3 4 |
3 | 1 2 1 2 1 2 |
4 | 3 4 3 4 3 4 |
+-------------------------+
J(r, c, val) is a special case of J(r, c, mat); it just happens that mat
is 1 x 1.
The matrix created has r*rows(mat) rows and c*cols(mat) columns.
Note that J(r, c, mat) creates a void matrix if any of r, c, rows(mat),
or cols(mat) are zero.
Conformability
J(r, c, val):
r: 1 x 1
c: 1 x 1
val: 1 x 1
result: r x c
J(r, c, mat):
r: 1 x 1
c: 1 x 1
mat: m x n
result: r*m x c*n
Diagnostics
J(r, c, val) and J(r, c, mat) abort with error if r<0 or c<0, or if r>=.
or c>=.. Arguments r and c are interpreted as trunc(r) and trunc(c).
Source code
Function is built in.
Also see
Manual: [M-5] J()
Help: [M-5] missingof(); [M-4] standard
| 