Document for Diag

termoshtt · termoshtt · commit ef80e1a66a2d · 2022-09-03T15:17:36.000+09:00
diff --git a/lax/src/flags.rs b/lax/src/flags.rs
@@ -120,10 +120,13 @@ impl JobSvd {
     }
 }
 
+/// Specify whether input triangular matrix is unit or not
 #[derive(Debug, Clone, Copy)]
 #[repr(u8)]
 pub enum Diag {
+    /// Unit triangular matrix, i.e. all diagonal elements of the matrix are `1`
     Unit = b'U',
+    /// Non-unit triangular matrix. Its diagonal elements may be different from `1`
     NonUnit = b'N',
 }
 

Original file line number	Diff line number	Diff line change
`@@ -120,10 +120,13 @@ impl JobSvd {`
`120`	`120`	`}`
`121`	`121`	`}`
`122`	`122`
	`123`	`+/// Specify whether input triangular matrix is unit or not`
`123`	`124`	`#[derive(Debug, Clone, Copy)]`
`124`	`125`	`#[repr(u8)]`
`125`	`126`	`pub enum Diag {`
	`127`	+ /// Unit triangular matrix, i.e. all diagonal elements of the matrix are `1`
`126`	`128`	`Unit = b'U',`
	`129`	+ /// Non-unit triangular matrix. Its diagonal elements may be different from `1`
`127`	`130`	`NonUnit = b'N',`
`128`	`131`	`}`
`129`	`132`