GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-09-23 14:53:13 +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 include paths, and your binary must be linked to the Accelerate framework.
* The Accelerate library is only available on Apple hardware. * The Accelerate library is only available on Apple hardware.
* *
* Note that many of the algorithms require additional information about your * Note that many of the algorithms can be influenced by the UpLo template
* matrices. This can be provided by setting the UpLo template argument when * argument. All matrices are assumed to be symmetric. For example, the following
* defining the factorization class. For example, the following creates an * creates an LDLT factorization where your matrix is symmetric (implicit) and
* LDLT factorization where your matrix is symmetric and uses the lower * uses the lower triangle:
* triangle:
* *
* \code * \code
* AccelerateLDLT<SparseMatrix<float>, Lower | Symmetric> ldlt; * AccelerateLDLT<SparseMatrix<float>, Lower> ldlt;
* \endcode * \endcode
*
* Failure to do so may result in your application crashing.
*/ */
#include "src/AccelerateSupport/AccelerateSupport.h" #include "src/AccelerateSupport/AccelerateSupport.h"