| MxAlgebra-class {OpenMx} | R Documentation |
MxAlgebra is an S4 class. An MxAlgebra object is a named entity. New instances of this class can be created using the function mxAlgebra.
The MxAlgebra class has the following slots:
| name | - | The name of the object |
| formula | - | The R expression to be evaluated |
| result | - | Either NULL or a 1x1 matrix with the computation result |
The 'name' slot is the name of the MxAlgebra object. Use of MxAlgebra objects in the mxConstraint function or an OpenMx objective function requires reference by name.
The 'formula' slot is an expression containing one or more MxMatrix objects. These objects are operated on or related to one another using one or more operations detailed in the mxAlgebra help file.
The 'result' slot is used to hold the results of an optimization on the expression in the 'formula' slot. If this MxAlgebra has not been used as an argument in an objective function and subsequently included in an MxModel object and executed using the mxRun function, this slot will have a value of NULL. If this MxAlgebra has been used as an argument in an objective function and subsequently included in an MxModel object and executed using the mxRun function, then this slot will have a 1x1 matrix with the results of that optimization as its only value.
Slots may be referenced with the @ symbol. See the documentation for Extract and the examples in the mxAlgebra document for more information.
The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
mxAlgebra for creating MxAlgebra objects. MxMatrix and mxMatrix for objects which may be entered in the 'formula' slot and the function that creates them. More information about the OpenMx package may be found here.