Chris_T avatar Chris_T committed fd8be13

Improved the documentation of [lassq].

Comments (0)

Files changed (1)

lib/impl_SDCZ.mli

 (** [lassq ?n ?ofsx ?incx ?scale ?sumsq] @return [(scl, ssq)], where
     [scl] is a scaling factor and [ssq] the sum of squares of vector
     [x] starting at [ofs] and using increment [incx] and initial
-    [scale] and [sumsq].  See LAPACK-documentation for details!
+    [scale] and [sumsq].  The following equality holds:
+    [scl**2. *. ssq = x.{1}**2. +. ... +. x.{n}**2. +. scale**2. *. sumsq].
+    See LAPACK-documentation for details!
 
     @param n default = greater n s.t. [ofsx+(n-1)(abs incx) <= dim x]
     @param ofsx default = 1
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.