# SCM Repository

[matrix] Diff of /pkg/Matrix/man/forceSymmetric.Rd
 [matrix] / pkg / Matrix / man / forceSymmetric.Rd

# Diff of /pkg/Matrix/man/forceSymmetric.Rd

revision 3019, Sat Oct 11 20:51:53 2014 UTC revision 3020, Tue Oct 14 16:14:02 2014 UTC
# Line 46  Line 46
46  %  %
47  \title{Force a Matrix to 'symmetricMatrix' Without Symmetry Checks}  \title{Force a Matrix to 'symmetricMatrix' Without Symmetry Checks}
48  \description{  \description{
49    Force \code{x} (inheriting from \code{\linkS4class{Matrix}} class) to    Force a square matrix \code{x} to a \code{\linkS4class{symmetricMatrix}},
50    \code{\linkS4class{symmetricMatrix}}, \bold{without} a symmetry check    \bold{without} a symmetry check as it would be applied for \code{as(x,
51    (which \emph{is} applied for all \code{as(x, "symmetricMatrix")}      "symmetricMatrix")}.
alikes).
52  }  }
53  \usage{  \usage{
54  forceSymmetric(x, uplo)  forceSymmetric(x, uplo)
55  }  }
56  \arguments{  \arguments{
57    \item{x}{a (classed) square matrix.}    \item{x}{any square matrix (of numbers), either \dQuote{"traditional"}
58    \item{uplo}{optional string, \code{"U"} or \code{"L"}.      (\code{\link{matrix}}) or inheriting from
59      The default is \code{"U"} unless \code{x} already has a \code{uplo}      \code{\linkS4class{Matrix}}.}
60      slot (i.e., when it is \code{\linkS4class{symmetricMatrix}},    \item{uplo}{optional string, \code{"U"} or \code{"L"} indicating which
61      or  \code{\linkS4class{triangularMatrix}}), where the default will      \dQuote{triangle} half of \code{x} should determine the result.  The
62      be \code{x@uplo}.}      default is \code{"U"} unless \code{x} already has a \code{uplo} slot
63        (i.e., when it is \code{\linkS4class{symmetricMatrix}}, or
64        \code{\linkS4class{triangularMatrix}}), where the default will be
65        \code{x@uplo}.}
66  }  }
67  % \details{  % \details{
68  %  %
# Line 69  Line 71
71    a square matrix inheriting from class    a square matrix inheriting from class