1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
%
% Copyright 2007-2021 by the individuals mentioned in the source code history
%
% Licensed under the Apache License, Version 2.0 (the "License");
% you may not use this file except in compliance with the License.
% You may obtain a copy of the License at
%
% http://www.apache.org/licenses/LICENSE-2.0
%
% Unless required by applicable law or agreed to in writing, software
% distributed under the License is distributed on an "AS IS" BASIS,
% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
% See the License for the specific language governing permissions and
% limitations under the License.
\name{MxConstraint-class}
\Rdversion{1.1}
\docType{class}
\alias{MxConstraint-class}
\alias{MxConstraint}
\alias{$<-,MxConstraint-method}
\alias{$,MxConstraint-method}
\alias{names,MxConstraint-method}
\alias{print,MxConstraint-method}
\alias{show,MxConstraint-method}
\title{Class \code{"MxConstraint"}}
\description{
MxConstraint is an S4 class. An MxConstraint object
is a \link[=Named-entity]{named entity}. New instances of this class can
be created using the function \code{\link{mxConstraint}()}.
}
\section{Slots}{
\describe{
\item{\code{name}:}{Character string; the name of the object.}
\item{\code{formula}:}{Object of class \code{"MxAlgebraFormula"}. The \link{MxAlgebra}-like expression representing the constraint function.}
\item{\code{alg1}:}{Object of class \code{"MxCharOrNumber"}. For internal use.}
\item{\code{alg2}:}{Object of class \code{"MxCharOrNumber"}. For internal use.}
\item{\code{relation}:}{Object of class \code{"MxCharOrNumber"}. For internal use.}
\item{\code{jac}:}{Object of class \code{"MxCharOrNumber"}. Identifies the \link{MxAlgebra} representing the Jacobian for the constraint function.}
\item{\code{linear}:}{Logical. For internal use.}
\item{\code{strict}:}{Logical. Whether to require that all Jacobian entries reference
free parameters.}
\item{\code{verbose}:}{integer. For values greater than zero, enable runtime
diagnostics.}
}
}
\section{Methods}{
\describe{
\item{$<-}{\code{signature(x = "MxConstraint")}}
\item{$}{\code{signature(x = "MxConstraint")}}
\item{\link{imxDeparse}}{\code{signature(object = "MxConstraint")}}
\item{names}{\code{signature(x = "MxConstraint")}}
\item{print}{\code{signature(x = "MxConstraint")}}
\item{show}{\code{signature(object = "MxConstraint")}}
}
}
\details{
Slots may be referenced with the $ symbol. See the documentation for \link[methods]{Classes} and the examples in the \link{mxConstraint} document for more information.
}
\references{
The OpenMx User's guide can be found at \url{https://openmx.ssri.psu.edu/documentation/}.
}
\seealso{
\code{\link{mxConstraint}()} for the function that creates MxConstraint objects.
}
\examples{
showClass("MxConstraint")
}
\keyword{classes}
|
