MxConstraint-class {OpenMx}R Documentation

MxConstraint Class

Description

MxConstraint is an S4 class. An MxConstraint object is a named entity. New instances of this class can be created using the function mxConstraint.

Details

The MxConstraint class has the following slots:

name - The name of the object
alg1 - The name of an MxAlgebra or MxMatrix object
relation - A character string, either '<', '=', or '>'
alg2 - The name of an MxAlgebra or MxMatrix object

The 'name' slot is the name of the MxConstraint object.

The 'alg1' and 'alg2' slots hold MxAlgebra or 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 MxModel object with all referenced MxAlgebra and MxMatrix objects.

Slots may be referenced with the @ symbol. See the documentation for Classes and the examples in the mxConstraint document for more information.

References

The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.

See Also

mxConstraint for the function that creates MxConstraint objects. MxAlgebra and MxMatrix for objects which may be entered as arguments in the 'alg' and 'alg2' arguments, and mxAlgebra and mxMatrix for the functions that create them. More information about the OpenMx package may be found here.


[Package OpenMx version 0.2.4-1038 Index]