[vsipl++] [patch] Document QR Decomposition

[Jules Bergmann]

Don McCoy wrote:
> As attached.  PDF output is in ~don/manual.pdf.

Don

This looks good!  Please check this in, with the following comments.
	
			thanks,
			-- Jules



4.5.1.1

- Remove leading blank line in class decl

For return mechanism instead of saying "must be a member of the 
enumeration ...," sprinkle the enumeration values into the documentation:

"The return mechanism indicates how foo() provides results: by_value 
indicates foo() returns a result matrix by value, by_reference indicates 
foo() returns results by reference into a matrix provided by the caller. 
  For details see enumeration type return_mechanism_type (SECTION)"

Don't mention easier to program/faster here.  Instead, we should mention 
this caveat in the return_mechanism_type documentation, plus the cases 
we avoid it with return-block-optimization.

4.5.1.2

- remove blank line at top of qrd decl.

4.5.1.3

- 'qrd' should be in <code></code>

- "," before "and"

4.5.1.4

- move the second sentence about modifying A into the requirements.

4.5.1.5

- Change to "The following fucntions are available only if the /qrd 
template class is parameterized with the ReturnMechanismType = by_value/"

Start a new paragraph before the following lines that precede the 4 tables:
  "For qstorage() == qrd_saveq1",
  "For qstorage() == qrd_saveq",

What are the tables showing exactly?  I.e. how should I interpret 
"Qm,rows(),s"?   "Qm" is the product computed, and "rows(),s" are its size?

It would help if the tables had captions.

Final senctence: "Note that the return matrix may have a different block 
type from Block"

rsol, qsol, lsqsol look good.  Nice equations!

4.5.1.6

- Similar comment about starting a new paragraph before the "For 
qstorage == ..." sentences preceding the tables.

Replace the sentence "where s is an arbitraty positive length_type" with 
"where s is an arbitrary /positive value/."

-- 
Jules Bergmann
CodeSourcery
jules at codesourcery.com
(650) 331-3385 x705