[eigen] Ideas for better documenting coeffwise math functions |

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

*To*: eigen <eigen@xxxxxxxxxxxxxxxxxxx>*Subject*: [eigen] Ideas for better documenting coeffwise math functions*From*: Gael Guennebaud <gael.guennebaud@xxxxxxxxx>*Date*: Wed, 1 Jun 2016 23:51:17 +0200*Dkim-signature*: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:from:date:message-id:subject:to; bh=E5qmQUahBCD4Zd0L4Ycl3/WVUzy5JHRWf2P/DDED3gk=; b=LCmL6K0zD9BGP+5QIdPrcJDR2M2RZhlzwdiUkTl9IUqp7+8HOi6+saKRWs47ar+BCt QoOYMmjWd6lnorkFSqSlQhst5ARTEaYF0NMu7h3NooW61ogsGoPMJ8C8U3w63aENDu/8 LDx7WoBYWnHdeFc3Kceuy6z8yTWX+w/bpaBYbz6rJ06COxHbSYuN5yLSGmlEzCcPbjdH CWP4vQ7HC/Q2p1rtcPdMn2ggIV7S3hoZLeqUv8lbzFpbfIg4MaNtIsmrrSqCZNdCsoqt naigcO/ZJdDMHERsurJ//yu0jbROOZf9ECh5mHYJmOJaFfda/fW6l1oW51yMN0zCXCxP q1Sg==

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.html

I'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

**Follow-Ups**:**Re: [eigen] Ideas for better documenting coeffwise math functions***From:*Dan Čermák

**Re: [eigen] Ideas for better documenting coeffwise math functions***From:*Rasmus Larsen

**Messages sorted by:**[ date | thread ]- Prev by Date:
**Re: [eigen] Struct padding with the nvcc compiler.** - Next by Date:
**Re: [eigen] Ideas for better documenting coeffwise math functions** - Previous by thread:
**Re: [eigen] Struct padding with the nvcc compiler.** - Next by thread:
**Re: [eigen] Ideas for better documenting coeffwise math functions**

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