Skip to content

Commit

Permalink
improve-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
upsj committed Oct 2, 2023
1 parent 96ca8b9 commit c2bb1ea
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions include/ginkgo/core/base/lin_op.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,9 @@ class Permutable {
* In the resulting LinOp, the entry at location `(i,j)` contains the input
* value `(perm[i],perm[j])`.
*
* From the linear algebra perspective, with \f$P_{ij} = \delta_{i
* \pi(i)}\f$, this represents the operation \f$P A P^{-1}\f$.
*
* @param permutation_indices the array of indices containing the
* permutation order.
*
Expand All @@ -538,6 +541,9 @@ class Permutable {
* In the resulting LinOp, the entry at location `(perm[i],perm[j])`
* contains the input value `(i,j)`.
*
* From the linear algebra perspective, with \f$P_{ij} = \delta_{i
* \pi(i)}\f$, this represents the operation \f$P^{-1} A P\f$.
*
* @param permutation_indices the array of indices containing the
* permutation order.
*
Expand All @@ -555,6 +561,9 @@ class Permutable {
* object.
* In the resulting LinOp, the row `i` contains the input row `perm[i]`.
*
* From the linear algebra perspective, with \f$P_{ij} = \delta_{i
* \pi(i)}\f$, this represents the operation \f$P A\f$.
*
* @param permutation_indices the array of indices containing the
* permutation order.
*
Expand All @@ -569,6 +578,9 @@ class Permutable {
* In the resulting LinOp, the column `i` contains the input column
* `perm[i]`.
*
* From the linear algebra perspective, with \f$P_{ij} = \delta_{i
* \pi(i)}\f$, this represents the operation \f$A P^{-1}\f$.
*
* @param permutation_indices the array of indices containing the
* permutation order `perm`.
*
Expand All @@ -582,6 +594,9 @@ class Permutable {
* object.
* In the resulting LinOp, the row `perm[i]` contains the input row `i`.
*
* From the linear algebra perspective, with \f$P_{ij} = \delta_{i
* \pi(i)}\f$, this represents the operation \f$P^{-1} A\f$.
*
* @param permutation_indices the array of indices containing the
* permutation order `perm`.
*
Expand All @@ -596,6 +611,9 @@ class Permutable {
* In the resulting LinOp, the column `perm[i]` contains the input column
* `i`.
*
* From the linear algebra perspective, with \f$P_{ij} = \delta_{i
* \pi(i)}\f$, this represents the operation \f$A P\f$.
*
* @param permutation_indices the array of indices containing the
* permutation order `perm`.
*
Expand Down

0 comments on commit c2bb1ea

Please sign in to comment.