Dave Keenan & Douglas Blumeyer's guide to RTT/Conventions for names, variables, units, and notations: Difference between revisions
ArrowHead294 (talk | contribs) mNo edit summary |
Dave Keenan (talk | contribs) Improved the clarity and consistency of the variable-styling-convention table. |
||
| Line 6: | Line 6: | ||
See [[Extended bra-ket notation#Variant including curly and square brackets|here]] for more information on our variation on extended bra-ket notation. | See [[Extended bra-ket notation#Variant including curly and square brackets|here]] for more information on our variation on extended bra-ket notation. | ||
We've followed a | We've followed a variable styling convention, explained in the table below, which we hope serves as an aid to quickly identifying objects and remembering their properties and purposes, but at the least we hope our choices are unobtrusive. In short, the objects with simple units of primes, generators or cents, i.e. the things which are actually audible in our application, are distinguished by upright formatting, while other variables are italic as is conventional. This is crossed with the linear-algebra convention that objects of order-1 like vectors are bolded and order-2 like matrices are uppercased: | ||
{| class="wikitable center-all" | {| class="wikitable center-all" | ||
| Line 18: | Line 18: | ||
| ↓ Order | | ↓ Order | ||
| ↓ Style → | | ↓ Style → | ||
| | | Roman (upright) | ||
| ''Italic'' | | ''Italic'' | ||
|- | |- | ||
| Line 26: | Line 26: | ||
|- | |- | ||
| 0 | | 0 | ||
| | | lowercase | ||
! rowspan="3" | | ! rowspan="3" | | ||
| | | scalar (with simple unit) | ||
| '' | | ''scalar'' (with no unit) | ||
|- | |- | ||
| 1 | | 1 | ||
| ''' | | '''bold lowercase''' | ||
| ''' | | '''vector''' | ||
| ''''' | | '''''map''''' (row vector) | ||
|- | |- | ||
| 2 | | 2 | ||
| UPPERCASE | | UPPERCASE | ||
| LIST | | BASIS or LIST (of vectors) | ||
| | | ''MATRIX'' | ||
|} | |} | ||