Added omxCheckCloseEnough.Rd and changed vcu.edu links to openmx links
[openmx:openmx.git] / man / MxConstraint-class.Rd
1 \name{MxConstraint-class}
2 \alias{MxConstraint}
3
4 \title{MxConstraint Class}
5
6 \description{
7    MxConstraint is an S4 class. An MxConstraint object 
8    is a \link[=Named-entity]{named entity}. New instances of this class can
9    be created using the function \link{mxConstraint}.
10 }
11
12 \details{
13 The MxConstraint class has the following slots:
14
15   \tabular{rcl}{
16         \tab \tab \cr
17         name \tab - \tab The name of the object \cr
18         alg1 \tab - \tab The name of an \link{MxAlgebra} or \link{MxMatrix} object \cr 
19         relation \tab - \tab A character string, either '<', '=', or '>' \cr
20         alg2 \tab - \tab The name of an \link{MxAlgebra} or \link{MxMatrix} object \cr     
21   }
22   
23 The 'name' slot is the name of the MxConstraint object. %Use of MxConstraint objects in other functions in the \link{OpenMx} library may require reference by name.
24
25 The 'alg1' and 'alg2' slots hold \link{MxAlgebra} or \link{MxMatrix} objects whose relationship is constrained or defined by the contents of the 'relation' slot. To affect an estimation or optimization, an MxConstraint object must be included in an \link{MxModel} object with all referenced \link{MxAlgebra} and \link{MxMatrix} objects.
26
27 Slots may be referenced with the @ symbol. See the documentation for \link{Extract} and the examples in the \link{mxConstraint} document for more information.
28 }
29
30 \references{
31 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
32 }
33
34 \seealso{
35 \link{mxConstraint} for the function that creates MxConstraint objects. \link{MxAlgebra} and \link{MxMatrix} for objects which may be entered as arguments in the 'alg' and 'alg2' arguments, and \link{mxAlgebra} and \link{mxMatrix} for the functions that create them. More information about the OpenMx package may be found \link[=OpenMx]{here}. 
36 }