Re: [eigen] docs updates |

[ Thread Index | Date Index | More lists.tuxfamily.org/eigen Archives ]

*To*: eigen@xxxxxxxxxxxxxxxxxxx*Subject*: Re: [eigen] docs updates*From*: Scott Wheeler <wheeler@xxxxxxx>*Date*: Sun, 12 Oct 2008 17:08:17 +0200

Benoît Jacob wrote:

"or \em dynamically by specifying \em Dynamic as the size." Here "size" is not precise enough, I'd say "as size template parameters".

Does that really give more information?

\param _Scalar Numeric type, i.e. float, double, int Here I prefered the old version which said: \param _Scalar the scalar type, i.e. the type of the coefficients

however I understand that it's a good idea to give an example 'float' but ifyou give the three types as above and says "i.e." it suggests these are theonly types allowed. So I'd go for\param _Scalar the scalar type, i.e. the type of the coefficients, for example\c float.*** * \param _Rows Numer of rows, or \b Dynamic * \param _Cols Number of columnss, or \b Dynamic typos :)

Heh, I suppose that being fixed is non-controversial. I'll fix. :-)

Moreover, why did you change this? The old version said basically the same,with more words. Did you feel it was important to have very shortdescriptions here and the old version was too wordy?

For reference:* \param _Rows the number of rows at compile-time. Use the special value \aDynamic to specify that the number of rows is dynamic, i.e. is not fixed atcompile-time.* \param _Cols the number of columns at compile-time. Use the special value \aDynamic to specify that the number of columns is dynamic, i.e. is not fixedat compile-time.Wasn't this more helpful ?

*** "Dynamic matrices <em>do not</em> expand dynamically." what do you mean?

If p is a compile-time constant then the user may as well call otherconvenience functions such as l1Norm() etc; if p is not, then we are probablyin the general case. I am reluctant to write code as above as it could easilygenerate binary code for all paths. If such a form were really needed i'drather make p a template parameter and use a meta-selector so only one pathgets compiled.

-Scott ---

**Follow-Ups**:**Re: [eigen] docs updates***From:*Benoît Jacob

**References**:**[eigen] docs updates***From:*Scott Wheeler

**Re: [eigen] docs updates***From:*Benoît Jacob

**Re: [eigen] docs updates***From:*Scott Wheeler

**Re: [eigen] docs updates***From:*Benoît Jacob

**Messages sorted by:**[ date | thread ]- Prev by Date:
**Re: [eigen] docs updates** - Next by Date:
**Re: [eigen] docs updates** - Previous by thread:
**Re: [eigen] docs updates** - Next by thread:
**Re: [eigen] docs updates**

Mail converted by MHonArc 2.6.19+ | http://listengine.tuxfamily.org/ |