Re: [Rd] ?eigen documentation suggestion

From: Martin Maechler <maechler_at_stat.math.ethz.ch>
Date: Thu, 29 Nov 2007 17:46:38 +0100

>>>>> "DD" == Dan Davison <davison_at_stats.ox.ac.uk>
>>>>> on Thu, 29 Nov 2007 11:34:18 +0000 writes:

    DD> from ?eigen
    DD> symmetric: if 'TRUE', the matrix is assumed to be symmetric (or
    DD> Hermitian if complex) and only its lower triangle is used. If
    DD> 'symmetric' is not specified, the matrix is inspected for
    DD> symmetry.


    DD> I think that could mislead a naive reader as it suggests that, with symmetric=TRUE,
    DD> the result of eigen() (vectors and values) depends only on the lower-triangular values,     DD> and thus not on the values on the diagonal (that's not true for the eigenvalues).

Well, that all depends on what you think when you read "lower triangle".

For many of us, this can include the diagonal or not, and we don't know if it is not specified further.

?lower.tri -- shows the option to include the diagonal.

Consequently, I'd suggest to replace

       "only its lower triangle is used" with "only its lower triangle (diagonal included) is used"

Martin Maechler, ETH Zurich

    DD> I suggest that changing it to

    DD> "... and only its lower triangle is used when computing the eigenvectors."

    DD> would be more accurate, perhaps even with a reminder about the trace - sum of eigenvalues     DD> relationship.

    DD> Dan

    DD> ______________________________________________
    DD> R-devel_at_r-project.org mailing list     DD> https://stat.ethz.ch/mailman/listinfo/r-devel

R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Thu 29 Nov 2007 - 17:03:03 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Fri 30 Nov 2007 - 09:30:33 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.