-----Original Message----- From: Boost [mailto:boost-bounces@lists.boost.org] On Behalf Of Paul A. Bristow Sent: Friday, May 10, 2013 10:39 AM To: boost@lists.boost.org Subject: Re: [boost] Can anyone take a quick read of an array type?
-----Original Message----- From: Boost [mailto:boost-bounces@lists.boost.org] On Behalf Of Daryle Walker Sent: Saturday, May 04, 2013 11:05 AM
I banged out a little something at https://github.com/CTMacUser/ArrayMD.
Gulp. This would seem to be quite a BIG something?
And that I have yet to digest :-(
You mentioned docs but I haven't found them in the link above.
No, the other guy had docs. My library doesn't have any besides Doxygen comments. But those comments tend to be huge. I write the Doxygen comment after the declaration but before the definition. Doing those comments and figuring out a test take a lot longer than the actual code! I've added the ordered operators (< > <= >=) and the tuple interface (get, tuple_size, tuple_element). The latter assumes increments of value_type, since users would be confused if I picked any other (I.e. sub-arrays) unit. So it should be substitutable for std::array, when given 1 dimension. (If we can find a std::array demonstration program, maybe it can be applied against array_md.) I just recently added an example. It just a quick & dirty matrix class. It demonstrates in-sync updating of iterators from two different objects (of the same shape) for addition and subtraction. The core multiplication routine shows use of "apply."
Well I'm a great fan of good Doxygen comments - and you could use those with Quickbook to produce some really smart docs.
This isn't usually possible because people don't start by writing the Doxygen comments, then the code, so the prospect of going back writing the comments is too much to contemplate...
If you need help with setting this up, please ask - I've done this before. Once working it is painless to write the text for introductions and tutorial in Quickbook.
I've knocked together a very rough draft using the Boost.Sandbox format - and I could commit so you can see the whole thing. To whet your enthusiasm (I hope) I've put pdf version in my Dropbox https://dl.dropboxusercontent.com/u/43940943/arraymd/arraymd.pdf and I hope you can also download the html version at /html/index.html And also a slightly tarted-up Doxygen version at https://www.dropbox.com/sh/1745u8wl2vm9mlp/Bp7wz9BjkT/arraymd but you already have that. You will note that 1 I've just pasted your readme file to the Quickbook intro. 2 The Doxygen comments stuff is available. 3 There is an index of all the functions (can also have separate index for functions, class, macros, typedefs). 4 The example is split into parts to show how to use snippets, and provide a link to the source. 5 There are several buglets. 6 There is much more to be done :-( Tell me if I can help more. Cheers Paul PS I note that the include files need changing from sandbox format - this is going to be a *big PITA* if/when GIT is adopted and implemented. It had better be worth it! So you will have some tiresome work on the various links to do to use in Boost/GIT format. --- Paul A. Bristow, Prizet Farmhouse, Kendal LA8 8AB UK +44 1539 561830 07714330204 pbristow@hetp.u-net.com