Re: [eigen] documentation: the long tutorial

[Benoit Jacob <jacob.benoit.1@xxxxxxxxx>]

Just write FIXME in plain text, as we do in the code, no particular
dox/html tag.

Sorry i've not yet written the dox page myself, i have saturday
lethargy and used the little energy i had to push my fixes for the
upcoming firefox 4 beta... ;)

Benoit

2010/6/19 Carlos Becker <carlosbecker@xxxxxxxxx>:
> Just started writing and had a question that might be useful to make clear
> before I go on: if there is some text that is not yet clear or should be
> revised, which dox/html command shall I use? I think it is better if we all
> follow a single convention to avoid misunderstandings later.
> thanks.
>
>
> On Sat, Jun 19, 2010 at 4:59 PM, Carlos Becker <carlosbecker@xxxxxxxxx>
> wrote:
>>
>> Great, I will take care of the Arithmetic with matrices and vectors and
>> Array class and coeff-wise operations.
>> I will send you a draft soon then.
>> Carlos
>>
>> On Sat, Jun 19, 2010 at 3:01 PM, Benoit Jacob <jacob.benoit.1@xxxxxxxxx>
>> wrote:
>>>
>>> Great; I don't think you'll be able to reuse the current tutorial
>>> much, except perhaps for some sentences that you might copy and paste,
>>> as the whole approach we're discussing here is quite different from
>>> the approach of the existing tutorial. We're aiming at pages that have
>>> a lot more text, a lot more detail, not just "reference tables" with
>>> minimal explanations.
>>>
>>> You're very welcome to start writing some of the above-discussed
>>> pages; please write here to say which one you're starting with, so as
>>> to avoid duplication of effort. Don't hesitate to show an early draft
>>> so we can check we agree on the approach. Please let me do the 1st one
>>> in my list ("the matrix class"), i'll try to do it today to show an
>>> example of what I had in mind.
>>>
>>> Benoit
>>>
>>> 2010/6/19 Carlos Becker <carlosbecker@xxxxxxxxx>:
>>> > Hi all. I believe I can take care of a part of this tutorial or maybe
>>> > the
>>> > whole of it. Should I start by modifying the current tutorial in
>>> > doxygen?
>>> > thanks!
>>> > Carlos
>>> >
>>> >
>>> > On Sat, Jun 19, 2010 at 2:52 AM, Thomas Capricelli
>>> > <orzel@xxxxxxxxxxxxxxx>
>>> > wrote:
>>> >>
>>> >> In data venerdì 18 giugno 2010 15:18:05, Benoit Jacob ha scritto:
>>> >> > 11. Eigen's class hierarchy
>>> >> ...
>>> >> > 12. Eigen's various header files
>>> >> >
>>> >> > We mention here the headers such as Eigen/Core (so far we talked
>>> >> > only
>>> >> > about Eigen/Dense and perhaps Sparse).
>>> >>
>>> >> Yes, I agree. This is very important to lower the "barrier to entry"
>>> >> for
>>> >> newcomers.
>>> >>
>>> >> All of this is for users, and is what is needed first. Ideally, one
>>> >> day,
>>> >> there would be also some doc toward developers (of eigen). It is
>>> >> harder to
>>> >> write, but something very great would be a general overview of the
>>> >> design.
>>> >> Something very high level, not going into details (only giving
>>> >> pointers),
>>> >> that would help understanding, from a developer point of view, how
>>> >> things
>>> >> are done.
>>> >> It would mention the various c++ tricks used, the general way of
>>> >> handling
>>> >> vectorization(paquets?), how different codepaths are taken according
>>> >> to
>>> >> various compilers options/matrix or vector types/features
>>> >> detected(such as
>>> >> availability of vectorization or openmp), and so on.
>>> >>
>>> >> Yes, i fully agree this can wait for after 3.0. But then, it would
>>> >> become
>>> >> a must-have !
>>> >>
>>> >> greetings,
>>> >> Thomas
>>> >> --
>>> >> Thomas Capricelli <orzel@xxxxxxxxxxxxxxx>
>>> >> http://www.freehackers.org/thomas
>>> >>
>>> >>
>>> >
>>> >
>>>
>>>
>>
>
>