robotology-legacy / codyco-superbuild

Software repository for FP7 project CoDyCo - Whole-body Compliant Dynamical Contacts in Cognitive Humanoids - http://www.codyco.eu
13 stars 17 forks source link

Coding conventions that "serialize" dynamics notation #53

Closed traversaro closed 6 years ago

traversaro commented 9 years ago

@jeljaik @naveenoid You had the same idea! Here the issue to implement it. : )

naveenoid commented 9 years ago

I guess the 4 points I can think of to start off this discussion :

  1. subscripts and superscripts - using latex like convention but starting at the most superscripted character and using underscores for the rest : eg. w_T_b
  2. Greek symbols : using english names of symbols like omega.
  3. Treating subscripted symbols like joint velocity as qj(double character) or as q_j(using rule 1 above).
  4. As always, matrixes in capitals, vectors non capitalised.

Naveen Kuppuswamy, PhD Post-doctoral Fellow, Cognitive Humanoids Lab, Department of Robotics, Brain and Cognitive Sciences (RBCS), Istituto Italiano di Tecnologia, Genova, Italy

On Fri, Feb 6, 2015 at 12:14 PM, Silvio Traversaro <notifications@github.com

wrote:

@jeljaik https://github.com/jeljaik @naveenoid https://github.com/naveenoid You had the same idea! Here the issue to implement it. : )

— Reply to this email directly or view it on GitHub https://github.com/robotology/codyco-superbuild/issues/53.

traversaro commented 6 years ago

I think this is a good idea, but it is each project documentation duty to define this. For an inspiration, see the quite good Drake's docs on this: http://drake.mit.edu/doxygen_cxx/group__multibody__notation.html .