added mike's explanation of the computational cost of an mxConstraint over a labelled...
[openmx:openmx.git] / man / mxConstraint.Rd
1 %
2 %   Copyright 2007-2010 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{mxConstraint}
17 \alias{mxConstraint}
18
19 \title{Create MxConstraint Object}
20
21 \description{
22 This function creates a new \link{MxConstraint} object.
23 }
24
25 \usage{
26 mxConstraint(expression, name = NA)
27 }
28
29 \arguments{
30    \item{expression}{An R expression of matrix operators and matrix functions.}
31    \item{name}{An optional character string indicating the name of the object.}
32 }
33
34 \details{
35 The mxConstraint function defines relationships between two \link{MxAlgebra} or \link{MxMatrix} objects. They are used to affect the estimation of free parameters in the referenced objects. The constraint relation is written identically to how a \link{MxAlgebra} expression would be written.  The outermost operator in this relation must be either \sQuote{<}, \sQuote{==} or \sQuote{>}. To affect an estimation or optimization, an \link{MxConstraint} object must be included in an \link{MxModel} object with all referenced \link{MxAlgebra} and \link{MxMatrix} objects.
36
37 Usage Note: Use of mxConstraint should be avoided where it is possible to achieve the constraint by equating free parameters by label or position in an \link{MxMatrix} or \link{MxAlgebra} object. Including mxConstraints in an mxModel will disable standard errors and the calculation of the final Hessian, and thus should be avoided when standard errors are of importance. Constraints also add computational overhead. If one labels two parameters the same, the optimizer has one fewer parameter to optimize. However, if one uses mxConstraint to do the same thing, both parameters remain estimated and a Lagrangian multiplier is added to maintain the constraint. This constraint also has to have its gradients computed and the order of the Hessian grows as well.  So while both approaches should work, the mxConstraint() will take longer to do so.
38
39 Alernatives to mxConstraints include using labels, lbound or ubound arguments or algebras. Free parameters in the same \link{MxModel} may be constrained to equality by giving them the same name in their respective 'labels' matrices. Similarly, parameters may be fixed to an individual element in a \link{MxModel} object or the result of an \link{MxAlgebra} object through labeling. For example, assigning a label of ``name[1,1]`` fixes the value of a parameter at the value in first row and first column of the matrix or algebra ``name``. The mxConstraint function should be used to enforce inequalities that cannot be conveyed using other methods.
40 }
41
42 \value{
43 Returns an \link{MxConstraint} object.
44 }
45
46 \references{
47 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
48 }
49
50 \seealso{
51 \link{MxConstraint} for the S4 class created by mxConstraint. 
52 }
53
54 \examples{
55 #Create a constraint between MxMatrices 'A' and 'B'
56 constraint <- mxConstraint(A > B, name = 'AdominatesB')
57
58 # Constrain matrix 'K' to be equal to matrix 'limit'
59
60 model <- mxModel("con_test", 
61     mxMatrix(type="Full", nrow=2, ncol=2, free=TRUE, name="K"),
62     mxMatrix(type="Full", nrow=2, ncol=2, free=FALSE, name="limit", values=1:4),
63         mxConstraint(K == limit, name = "Klimit_equality"), 
64         mxAlgebra(min(K), name="minK"), 
65         mxAlgebraObjective("minK")
66 )
67 \dontrun{
68 fit <- mxRun(model)
69 fit@matrices$K@values
70 }
71 #      [,1] [,2]
72 # [1,]    1    3
73 # [2,]    2    4
74
75 # Constrain both free parameters of a matrix to equality using labels (both are set to "eq")
76 equal <- mxMatrix("Full", 2, 1, free=TRUE, values=1, labels="eq", name="D")
77
78 # Constrain a matrix element in to be equal to the result of an algebra
79 start <- mxMatrix("Full", 1, 1, free=TRUE,  values=1, labels="param", name="F")
80 alg   <- mxAlgebra(log(start), name="logP")
81
82 # Force the fixed parameter in matrix G to be the result of the algebra
83 end   <- mxMatrix("Full", 1, 1, free=FALSE, values=1, labels="logP[1,1]", name="G")
84
85 }