Re: [Boost-users] [boost-users][QVM] Boost.QVM formal review is ongoing

Subject: Re: [Boost-users] [boost-users][QVM] Boost.QVM formal review is ongoing
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2015-12-09 05:43:49

> -----Original Message-----
> From: Boost-users [mailto:boost-users-bounces_at_[hidden]] On Behalf Of Adam Wulkiewicz
> Sent: 09 December 2015 03:24
> To: boost-users_at_[hidden]
> Subject: [Boost-users] [boost-users][QVM] Boost.QVM formal review is ongoing
> 
> Dear Boost community,
> 
> It seems that there are some problems with gmane.org related to handling of messages sent to many
> mailing lists at once. Therefore I'm reposting the information about the formal review. I
appologize
> those of you who recieve this message for the second time.
> 
> The formal review of Emil Dotchevski's QVM library begined on 7th Dec and it ends on 16th Dec.
> 
> Boost QVM defines a set of generic functions and operator overloads for working with quaternions,
> vectors and matrices of static size with the emphasis on 2, 3 and 4-dimensional operations needed
in
> graphics, video games and simulation applications. While it provides its own quaternion, matrix
and
> vector types, it is designed to work primarily with user-defined types through user
specializations of
> the q_traits, v_traits and m_traits templates.
> 
> QVM's source code is available on Github:
> https://github.com/zajo/boost-qvm
> 
> Full documentation is also viewable on Github:
> http://zajo.github.io/boost-qvm/
> 
> We encourage your participation in this review. At a minimum, kindly
> state:
> - Whether you believe the library should be accepted into Boost
>    * Conditions for acceptance
> - Your name
> - Your knowledge of the problem domain.
> 
> You are strongly encouraged to also provide additional information:
> - What is your evaluation of the library's:
>    * Design
>    * Implementation
>    * Documentation
>    * Tests
>    * Usefulness
> - Did you attempt to use the library? If so:
>    * Which compiler(s)
>    * What was the experience? Any problems?
> - How much effort did you put into your evaluation of the review?
> 
> More information about the review process can be found here:
> http://www.boost.org/community/reviews.html
> 
> We await your feedback!

I'm not qualified to give a full review of this library beyond observing:

1  It looks very useful.

2  Boost prefers clarity to curtness.  The naming is much too terse making the resulting code rather
'write-only'.  I'd at least go for col_mat for col_m and transpose for transp etc.  (I know any
changes will be a big PITA but shows that asking sooner than later is a good idea for would-be Boost
library authors ;-)

3  Documentation is OK, but I'd like many more examples of every function, and some much bigger
fuller real-life examples showing use too.

4  Does this mesh at all with the quaternions in Boost.Math library?

FWIW

Paul

PS If you build the Boost inspect tool  \modular-boost\tools\inspect by running its jamfile, (and
making sure that it is in your PATH) then from your /doc folder you can simply call 
> inspect > inspect.html 

and view any transgressions of the Boost rules in inspect.html - and, most important, any dud links.

You may get a few false positives, but you can spot these easily.

---
Paul A. Bristow
Prizet Farmhouse
Kendal UK LA8 8AB
[phone]