Document HouseholderSequence.

Incomplete: I did not explain the difference between OnTheLeft and OnTheRight,
and there is only one example.
This commit is contained in:
Jitse Niesen
2011-01-02 16:59:44 +00:00
parent 583f963517
commit 47a9d2ed54
3 changed files with 159 additions and 10 deletions

View File

@@ -210,9 +210,11 @@ enum {
DontAlign = 0x2
};
/** \brief Enum for specifying whether to apply or solve on the left or right.
*/
enum {
OnTheLeft = 1,
OnTheRight = 2
OnTheLeft = 1, /**< \brief Apply transformation on the left. */
OnTheRight = 2 /**< \brief Apply transformation on the right. */
};
/* the following could as well be written: