Re: [eigen] Ideas for better documenting coeffwise math functions |

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

*To*: eigen@xxxxxxxxxxxxxxxxxxx*Subject*: Re: [eigen] Ideas for better documenting coeffwise math functions*From*: Rasmus Larsen <rmlarsen@xxxxxxxxxx>*Date*: Thu, 2 Jun 2016 15:42:56 -0700*Dkim-signature*: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=mime-version:in-reply-to:references:from:date:message-id:subject:to; bh=M6izJH1z6f+A/ZIoy604byTqeLF0r0ZVNQ0NqkRCGck=; b=RApB+3LrQChPVxie4shC3oDB3em0EM4U7nq+XQ5nPsoqkI9yxDSkfmvVJG/UieP5MJ L6Y39WCqdhuAgSyUbvw2kewYTLDzCxKeLZ+IwBK2R4ZnGmXsRJKIJcnUwJCnqoOstYky tS957bZ74fIjxd8efrcWmgITzBiMVApypgdAB40lBSzX8jwzU7UxViP73ltWVJNeOWOR oBJhTi7GeBH5HmSCVMYexrCstNiMbdYLz5XqgNlgwVd6uxFbc3ImENvlM6YCeq84oqsd 1HQDJAAQ12l2xHFFE8b5G5tL7EIhGgBnJo2kybO/vtOomGSoVeG4CZaOSkkN8jyns10x dDQg==

Hi Gael,

I think it's a good format, but it needs some information about accuracy. Moreover, there should be some mention of the fact that versions for scalar, AVX and SSE differ. Indeed, sometimes they even use different algorithms and it would be nice to have some indication about relative speed and accuracy between them.

Rasmus

On Wed, Jun 1, 2016 at 2:51 PM, Gael Guennebaud <gael.guennebaud@xxxxxxxxx> wrote:

Hi list,as we are supporting more and more coefficient-wise math functions, we need a good way to structure and document them. To this end, I've started to sketch a table summarising the essential information about each of them:- available API (a.foo() ;foo(a) ; a.cwiseFoo())- what it does in a few words/equation- what is used under the hood, i.e., which STL function (with hyperlinks to cppreference)?, built-in implementation? (and if so, which scalar types are supported?) Which function has to be provided for custom scalar type?- SIMD status: supported instruction set, supported scalar types, accuracy (i.e., disabled in non-fast math mode).You can see a start here: http://eigen.tuxfamily.org/dox-devel/group__CoeffwiseMathFunctions.htmlI've included a very few functions just to see how it looks like, and to get feedbacks before making it complete.So,- Would you find such a table useful?- Does it provides too many or too few information?- Is the information clearly presented?- Any general comments on this aspect?And most importantly, feel free to volunteer to complete this task ;)cheers,gael

**References**:**[eigen] Ideas for better documenting coeffwise math functions***From:*Gael Guennebaud

**Messages sorted by:**[ date | thread ]- Prev by Date:
**Re: [eigen] Struct padding with the nvcc compiler.** - Next by Date:
**[PATCH] store rank of original QR decomposition in CompleteOrthogonalDecomposition, so that if the additional householder transformations change the rank (as measured by QR's rank()) method, we still stick with the initially computed rank in the CODs pseudoInverse() method when computing the pseudoinverse** - Previous by thread:
**Re: [eigen] Ideas for better documenting coeffwise math functions** - Next by thread:
**[PATCH] store rank of original QR decomposition in CompleteOrthogonalDecomposition, so that if the additional householder transformations change the rank (as measured by QR's rank()) method, we still stick with the initially computed rank in the CODs pseudoInverse() method when computing the pseudoinverse**

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