Changeset 347

Timestamp:

03/27/08 09:07:29 (8 months ago)

Author:

powell

Message:

Better documentation of ternary_point

Files:

• trunk/matml/src/ternary/ternary.h (modified) (1 diff)

trunk/matml/src/ternary/ternary.h

@@ -12 +12 @@
 
 typedef struct {
-  double C2;     /*+ Ternary concentration variable 2 (0 -> 1) +*/
-  double C3;     /*+ Ternary concentration variable 3 (0 -> 1-C2) +*/
+  double C2;     /*+ Ternary concentration variable 2
+                   +latex+($0\rightarrow1$)
+                   -latex-(0 -> 1)
+                   +*/
+  double C3;     /*+ Ternary concentration variable 3
+                   +latex+($0\rightarrow1-C_2$)
+                   -latex-(0 -> 1-C2)
+                   +*/
   double G;      /*+ Free energy +*/
-  double x;      /*+ Visualization x-coordinate (0 -> 1) +*/
+  double x;      /*+ Visualization
+                   +latex+$x$-coordinate ($0\rightarrow1$)
+                   -latex-x-coordinate (0 -> 1)
+                   +*/
   double y;      /*+ Visualization y-coordinate (transformed free energy) +*/
-  double z;      /*+ Visualization z-coordinate (0 -> sqrt(3)/2) +*/
-  double red;    /*+ Visualization color red value (0 -> 1) +*/
-  double green;  /*+ Visualization color green value (0 -> 1) +*/
-  double blue;   /*+ Visualization color blue value (0 -> 1) +*/
-  double alpha;  /*+ Visualization color alpha value (0 -> 1) +*/
+  double z;      /*+ Visualization z-coordinate
+                   +latex+($0\rightarrow\sqrt{3}/2$)
+                   -latex-(0 -> sqrt(3)/2) +*/
+  double red;    /*+ Visualization color red value
+                   +latex+($0\rightarrow1$)
+                   -latex-(0 -> 1)
+                   +*/
+  double green;  /*+ Visualization color green value
+                   +latex+($0\rightarrow1$)
+                   -latex-(0 -> 1)
+                   +*/
+  double blue;   /*+ Visualization color blue value
+                   +latex+($0\rightarrow1$)
+                   -latex-(0 -> 1)
+                   +*/
+  double alpha;  /*+ Visualization color alpha value
+                   +latex+($0\rightarrow1$)
+                   -latex-(0 -> 1)
+                   +*/
 } ternary_point; /*+ Ternary "point" structure. +*/