New user self-registration is currently disabled. Please email eigen-core-team @ lists.tuxfamily.org if you need an account.
Bug 828 - Confusing documentation of many SparseMatrixBase methods
Confusing documentation of many SparseMatrixBase methods
Status: RESOLVED FIXED
Product: Eigen
Classification: Unclassified
Component: Sparse
unspecified
All All
: Normal Documentation
Assigned To: Nobody
:
: 1163 (view as bug list)
Depends on:
Blocks: 3.3
  Show dependency treegraph
 
Reported: 2014-06-23 23:35 UTC by Christoph Hertzberg
Modified: 2016-09-16 09:29 UTC (History)
3 users (show)



Attachments

Description Christoph Hertzberg 2014-06-23 23:35:06 UTC
The documentation of many SparseMatrixBase functions is shared with the corresponding dense functions -- including the code samples. That leads to some open questions, e.g., are block-expressions overwritable and are unaryExpressions called only for non-zeros?
Comment 1 Gael Guennebaud 2016-02-03 14:05:36 UTC
*** Bug 1163 has been marked as a duplicate of this bug. ***
Comment 2 Gael Guennebaud 2016-02-03 15:27:51 UTC
That's indeed an issue that has to be fixed asap. At last I clarified the manual pages for block-expressions:

https://bitbucket.org/eigen/eigen/commits/435cc19842f5/
Summary:     Clarify documentation on the restrictions of writable sparse block expressions.
Comment 3 Gael Guennebaud 2016-09-16 08:43:08 UTC
https://bitbucket.org/eigen/eigen/commits/8246548665f6/
Summary:     Bug 828: clarify documentation of SparseMatrixBase's unary methods.
Comment 4 Gael Guennebaud 2016-09-16 09:29:31 UTC
For blocks: https://bitbucket.org/eigen/eigen/commits/d065e32c45f6/


Should be good enough.

Note You need to log in before you can comment on or make changes to this bug.