Skip to content

Commit 014b5ee

Browse files
committed
Use katex in JobSvd document
1 parent 7aab3ca commit 014b5ee

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

lax/src/flags.rs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,17 +92,19 @@ impl JobEv {
9292
}
9393
}
9494

95-
/// Specifies how many of the columns of *U* and rows of *V*ᵀ are computed and returned.
95+
/// Specifies how many singular vectors are computed
9696
///
97-
/// For an input array of shape *m*×*n*, the following are computed:
97+
/// For an input matrix $A$ of shape $m \times n$,
98+
/// the following are computed on the singular value decomposition $A = U\Sigma V^T$:
99+
#[cfg_attr(doc, katexit::katexit)]
98100
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
99101
#[repr(u8)]
100102
pub enum JobSvd {
101-
/// All *m* columns of *U* and all *n* rows of *V*ᵀ.
103+
/// All $m$ columns of $U$, and/or all $n$ rows of $V^T$.
102104
All = b'A',
103-
/// The first min(*m*,*n*) columns of *U* and the first min(*m*,*n*) rows of *V*ᵀ.
105+
/// The first $\min(m, n)$ columns of $U$ and/or the first $\min(m, n)$ rows of $V^T$.
104106
Some = b'S',
105-
/// No columns of *U* or rows of *V*ᵀ.
107+
/// No columns of $U$ and/or rows of $V^T$.
106108
None = b'N',
107109
}
108110

0 commit comments

Comments
 (0)