add comment on src/eig.rs

doraneko94 · doraneko94 · commit a2bb5e2ad14c · 2020-03-30T10:36:20.000+09:00
diff --git a/src/eig.rs b/src/eig.rs
@@ -7,8 +7,10 @@ use crate::types::*;
 
 /// Eigenvalue decomposition of general matrix reference
 pub trait Eig {
+    /// EigVec is the right eivenvector
     type EigVal;
     type EigVec;
+    /// Calculate eigenvalues with the right eigenvector
     fn eig(&self) -> Result<(Self::EigVal, Self::EigVec)>;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@ use crate::types::*;`
`7`	`7`
`8`	`8`	`/// Eigenvalue decomposition of general matrix reference`
`9`	`9`	`pub trait Eig {`
	`10`	`+ /// EigVec is the right eivenvector`
`10`	`11`	`type EigVal;`
`11`	`12`	`type EigVec;`
	`13`	`+ /// Calculate eigenvalues with the right eigenvector`
`12`	`14`	`fn eig(&self) -> Result<(Self::EigVal, Self::EigVec)>;`
`13`	`15`	`}`
`14`	`16`