CFD Online Logo CFD Online URL
www.cfd-online.com
[Sponsors]
Home > Wiki > CFD-Wiki talk:Format and style guide

CFD-Wiki talk:Format and style guide

From CFD-Wiki

(Difference between revisions)
Jump to: navigation, search
(Vector/Matrix formating)
Line 14: Line 14:
* "Best" (for sake of consistency) letter to use as solution n-tuple
* "Best" (for sake of consistency) letter to use as solution n-tuple
** x is used in most of the linear algebra literature, so I (JasonD) think this would be best for the linear systems section.
** x is used in most of the linear algebra literature, so I (JasonD) think this would be best for the linear systems section.
 +
 +
=== Samples ===
 +
*<math> Ax = b </math><br>
 +
*<math> A\,x = b </math><br>
 +
*<math> A\vec{x} = \vec{b} </math><br>
 +
*<math> A\,\vec{x} = \vec{b} </math><br>
 +
*<math> A\mathbf{x} = \mathbf{b} </math><br>
 +
*<math> A\,\mathbf{x} = \mathbf{b} </math><br>

Revision as of 00:13, 18 December 2005

Vector/Matrix formating

I (JasonD) propose that we edit a paragraph/blurb here on this until it comes to some steady state and then either go the forum with it or just move it to the style guide.

Here's what we seem to agree on:

  • n-tuples (nx1 arrays) need to differentiated from matrices
  • Elements of arrays/vectors are lower case with subscripts

Here are some open questions:

  • Exact way to differentiate n-tuples:
    • \vec
    • \mathbf - this will avoid confusion with vectors in R^3
  • "Best" (for sake of consistency) letter to use as solution n-tuple
    • x is used in most of the linear algebra literature, so I (JasonD) think this would be best for the linear systems section.

Samples

  •  Ax = b
  •  A\,x = b
  •  A\vec{x} = \vec{b}
  •  A\,\vec{x} = \vec{b}
  •  A\mathbf{x} = \mathbf{b}
  •  A\,\mathbf{x} = \mathbf{b}
My wiki