GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-08-08 09:49:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated AccelerateSupport documentation after PR 966.

Browse Source
This commit is contained in:
John Mather 2022-07-29 17:42:31 +00:00 committed by Rasmus Munk Larsen
parent 69714ff613
commit 7dd3dda3da
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Eigen/AccelerateSupport
View File

@ -33,17 +33,14 @@
* the include paths, and your binary must be linked to the Accelerate framework.
* The Accelerate library is only available on Apple hardware.
*
* Note that many of the algorithms require additional information about your
* matrices. This can be provided by setting the UpLo template argument when
* defining the factorization class. For example, the following creates an
* LDLT factorization where your matrix is symmetric and uses the lower
* triangle:
* Note that many of the algorithms can be influenced by the UpLo template
* argument. All matrices are assumed to be symmetric. For example, the following
* creates an LDLT factorization where your matrix is symmetric (implicit) and
* uses the lower triangle:
*
* \code
* AccelerateLDLT<SparseMatrix<float>, Lower | Symmetric> ldlt;
* AccelerateLDLT<SparseMatrix<float>, Lower> ldlt;
* \endcode
*
* Failure to do so may result in your application crashing.
*/
#include "src/AccelerateSupport/AccelerateSupport.h"