summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Slagle <kjslag@gmail.com>2016-10-26 22:54:20 -0700
committerKevin Slagle <kjslag@gmail.com>2016-10-26 22:54:20 -0700
commit3d7aa0b176573422e1a569078195407b168f8b2e (patch)
treee507d7bfcfe90b2c3592f5f81c2e9001776282af
parentb32b37472559f202995e894f9a627871737d4619 (diff)
clarify compactSVDTol corner case in documentation
-rw-r--r--packages/base/src/Internal/Algorithms.hs2
1 files changed, 1 insertions, 1 deletions
diff --git a/packages/base/src/Internal/Algorithms.hs b/packages/base/src/Internal/Algorithms.hs
index 7ead5b4..70d65d7 100644
--- a/packages/base/src/Internal/Algorithms.hs
+++ b/packages/base/src/Internal/Algorithms.hs
@@ -294,7 +294,7 @@ fromList [35.18264833189422,1.4769076999800903]
294compactSVD :: Field t => Matrix t -> (Matrix t, Vector Double, Matrix t) 294compactSVD :: Field t => Matrix t -> (Matrix t, Vector Double, Matrix t)
295compactSVD = compactSVDTol 1 295compactSVD = compactSVDTol 1
296 296
297-- | @compactSVDTol r@ is similar to 'compactSVD', but uses tolerance @tol=r*g*eps*(max rows cols)@ to distinguish nonzero singular values, where @g@ is the greatest singular value. 297-- | @compactSVDTol r@ is similar to 'compactSVD' (for which @r=1@), but uses tolerance @tol=r*g*eps*(max rows cols)@ to distinguish nonzero singular values, where @g@ is the greatest singular value. If @g<r*eps@, then only one singular value is returned.
298compactSVDTol :: Field t => Double -> Matrix t -> (Matrix t, Vector Double, Matrix t) 298compactSVDTol :: Field t => Double -> Matrix t -> (Matrix t, Vector Double, Matrix t)
299compactSVDTol r m = (u', subVector 0 d s, v') where 299compactSVDTol r m = (u', subVector 0 d s, v') where
300 (u,s,v) = thinSVD m 300 (u,s,v) = thinSVD m