Changeset 568 in Sophya for trunk/SophyaLib/Samba/circle.h

Timestamp:

Nov 10, 1999, 3:17:10 PM (26 years ago)

Author:

ansari

Message:

ajout doc GLM

File:

• trunk/SophyaLib/Samba/circle.h (modified) (1 diff)

trunk/SophyaLib/Samba/circle.h

@@ -30 +30 @@
   // psi contient les 4 valeurs des angles d intersection. -1 si les cercles ne se coupent pas
   // voir la numerotation dans le .cc
+  /*   psi contains  4 values of the intersection  angles. 
+    -1 if  circles do not intersect
+    psi[0]=psi(i,j,0)
+    psi[1]=psi(i,j,1)
+    psi[2]=psi(j,i,0)
+    psi[3]=psi(j,i,1)
+  */
   bool Intersection(const Circle&, double* psi) const;
 
   // donne le UnitVector correspondant a une position donnee sur le cercle
+  /*!    Return UnitVector corresponding to a given position donnee on the circle
+   */
   UnitVector ConvToSphere(double psi) const;
 
   // donne le UnitVector correspondant la tangente au cercle en une position donnee sur le cercle
+  /*!    Return UnitVector corresponding to the tangent to the circle */
+//    at given position on the circle.
   UnitVector TanOnCircle(double psi) const;
 
   // donne le vecteur tangent dans le plan (xy) a la sphere en une position donnee sur le cercle
+  /*!    Return the  vector  tangent to the sphere in the plane (xy) 
+    at a given position on the circle.
+  */
   UnitVector EPhi(double psi) const;
 
   // donne l autre vecteur tangent (orthogonal a EPhi)
+  /*!    Return the other tangent  vector( orthogonal to EPhi)-- 
+    see previous method
+  */
   UnitVector ETheta(double psi) const;
 
    // donne l angle de separation dans [0,2Pi] en une position donnee sur le cercle et EPhi
+  /*!   Return separation angle in [0,2Pi] at a given position on the 
+    circle and EPhi
+  */
   double SepAngleTanEPhi02PI(double psi) const;