Fixes formulas for Sor #1720
Fixes formulas for Sor #1720
Conversation
ginkgo-bot
added
mod:core
| * $\omega$ is known as the relaxation factor. | ||
| * The preconditioner can be made symmetric, leading to the SSOR preconitioner. | ||
| * Here, $M$ is defined as | ||
| * $$ | ||
| * \f[ |
There was a problem hiding this comment.
I thought \[ is enough, does it need to \f[?
There was a problem hiding this comment.
No \[ doesn't work, it has to be \f[.
There was a problem hiding this comment.
I assume you also look this page https://www.doxygen.nl/manual/formulas.html
maybe we or they have the tranformation from $ to \f$? I wonder the transformation makes \f[ to \ff[
There was a problem hiding this comment.
I was a bit confused by that, somehow \f$ didn't work, but $works as expected.
There was a problem hiding this comment.
I found we have used \f[ and the formula is shown in https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/classgko_1_1matrix_1_1Fft.html.
I think we can rely on \f[
| * $\omega$ is known as the relaxation factor. | ||
| * The preconditioner can be made symmetric, leading to the SSOR preconitioner. | ||
| * Here, $M$ is defined as | ||
| * $$ | ||
| * \f[ |
There was a problem hiding this comment.
I found we have used \f[ and the formula is shown in https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/classgko_1_1matrix_1_1Fft.html.
I think we can rely on \f[
MarcelKoch
added
1:ST:ready-to-merge
MarcelKoch
force-pushed
the
fix-sor-doc
branch
from
572e2db to
daae47b
Compare
|
Error: PR already merged! |
This merge fixes the formulas for SOR by using `\f[` instead of `$$` (or `\[`). Related PR: ginkgo-project#1720
This PR fixes the SOR (and Gauss-Seidel) documentation.