Added more documentation, and changed mxFOO() functions such
[openmx:openmx.git] / man / mxConstraint.Rd
1 \name{mxConstraint}
2 \alias{mxConstraint}
3
4 \title{Function To Create MxConstraint Object}
5
6 \description{
7    This function creates a new \link{MxConstraint} object.
8 }
9
10 \usage{
11         mxConstraint(alg1, relation, alg2, name = NA)
12 }
13
14
15 \arguments{
16    \item{alg1}{A character string indicating the 
17                 name of an \link{MxAlgebra} or \link{MxMatrix} object.}
18    \item{relation}{A character string indicating the relation between
19                 alg1 and alg2. Must be either "<", "=", or ">".}
20    \item{alg2}{A character string indicating the
21                 name of an \link{MxAlgebra} or \link{MxMatrix} object.}   
22    \item{name}{A character string indicating the
23                 name of this object. Optional.}
24 }
25
26 \value{
27         Returns a new \link{MxConstraint} object.
28 }
29
30 \examples{
31
32    #Create a constraint between MxMatrices 'A' and 'B'
33    constraint <- mxConstraint('A', '=', 'B', name = 'constraint')
34
35 }