Add more aliases
[openmx:openmx.git] / man / MxMatrix-class.Rd
1 %
2 %   Copyright 2007-2013 The OpenMx Project
3 %
4 %   Licensed under the Apache License, Version 2.0 (the "License");
5 %   you may not use this file except in compliance with the License.
6 %   You may obtain a copy of the License at
7
8 %        http://www.apache.org/licenses/LICENSE-2.0
9
10 %   Unless required by applicable law or agreed to in writing, software
11 %   distributed under the License is distributed on an "AS IS" BASIS,
12 %   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 %   See the License for the specific language governing permissions and
14 %   limitations under the License.
15
16 \name{MxMatrix-class}
17 \alias{MxMatrix}
18 \alias{[,MxMatrix-method}
19 \alias{[<-,MxMatrix-method}
20 \alias{print,MxMatrix-method}
21 \alias{show,MxMatrix-method}
22 \alias{dim,MxMatrix-method}
23 \alias{ncol,MxMatrix-method}
24 \alias{nrow,MxMatrix-method}
25 \alias{length,MxMatrix-method}
26 \alias{dimnames,MxMatrix-method}
27 \alias{dimnames<-,MxMatrix-method}
28 \alias{DiagMatrix-class}
29 \alias{FullMatrix-class}
30 \alias{IdenMatrix-class}
31 \alias{LowerMatrix-class}
32 \alias{SdiagMatrix-class}
33 \alias{StandMatrix-class}
34 \alias{SymmMatrix-class}
35 \alias{UnitMatrix-class}
36 \alias{ZeroMatrix-class}
37     
38 \title{MxMatrix Class}
39
40 \description{
41    MxMatrix is an S4 class. An MxMatrix object is a \link[=Named-entity]{named entity}.
42    New instances of this class can be created using the function \link{mxMatrix}.
43    MxMatrix objects may be used as arguments in other functions from the OpenMx library, including \link{mxAlgebra}, \link{mxConstraint}, and \link{mxModel}.
44 }
45     
46     \details{
47 The MxMatrix class has the following slots:
48       \tabular{rcl}{
49             name \tab - \tab the name of the object \cr
50             free \tab - \tab  the free matrix \cr
51             values \tab - \tab the values matrix \cr
52             labels \tab - \tab  the labels matrix \cr
53       }
54       
55 The 'name' slot is the name of the MxMatrix object. Use of MxMatrix objects in an \link{mxAlgebra} or \link{mxConstraint} function requires reference by name.
56
57 The 'free' slot takes a matrix which describes the location of free and fixed parameters. A variable is a free parameter if-and-only-if the corresponding value in the 'free' matrix is 'TRUE'. Free parameters are elements of an MxMatrix object whose values may be changed by an objective function when that MxMatrix object is included in an \link{MxModel} object and evaluated using the \link{mxRun} function.
58
59 The 'values' slot takes a matrix of numeric values. If an element is specified as a fixed parameter in the 'free' matrix, then the element in the 'values' matrix is treated as a constant value and cannot be altered or updated by an objective function when included in an \link{mxRun} function. If an element is specified as a free parameter in the 'free' matrix, the element in the 'value' matrix is considered a starting value and can be changed by an objective function when included in an \link{mxRun} function. 
60
61 The 'labels' slot takes a matrix which describes the labels of free and fixed parameters. Fixed parameters with identical labels must have identical values.  Free parameters with identical labels impose an equality constraint. The same label cannot be applied to a free parameter and a fixed parameter. A free parameter with the label 'NA' implies a unique free parameter, that cannot be constrained to equal any other free parameter.
62
63 }
64
65 \references{
66 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
67 }
68
69 \seealso{
70 \link{mxMatrix} for creating MxMatrix objects. More information about the OpenMx package may be found \link[=OpenMx]{here}. 
71 }