Changeset 133 for trunk/SRC/Utilities/linearequation.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

File:

• trunk/SRC/Utilities/linearequation.pro (moved) (moved from trunk/SRC/ToBeReviewed/UTILITAIRE/linearequation.pro) (1 diff)

trunk/SRC/Utilities/linearequation.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: linearequation
 ;
-; PURPOSE:calcule une equation de droite du type ax+by+c=0 a partir
-; des coordonnees de 2 points. Rq: on peut avoir un tableau de couple
-; de points.
+; @file_comments 
+; Calculate a linear equation of the type ax+by+c=0
+; thanks to coordinates of 2 points.
+; comment: we can have a table with pairs of points.
 ;
-; CATEGORY:petit truc qui peut etre utile (sans boucles, ca va de soit!)
+; @categories utilities
+; 
+; @param point1 {in}{required} This is the first point of(the) straight 
+; line(s) whose we want to calculate equation(s)
 ;
-; CALLING SEQUENCE:abc=linearequation(point1, point2)
-; 
-; INPUTS: point1 et point2 dont deux point de(s) la droite(s) dont on
-; veut calculer l(es) equations(s).
-; deux possibilites sont possibles:
-;      1) point est un complexe ou un tableau de complexes, ou chaque
-;      element du complexe est les coordonnees du point
-;      2) points est un tableau de reels de dimensions 2
-;      ,nbre_de_droite. ou pour chaque ligne du tableau on a les
-;      coordonnees du point.
+; @param point2 {in}{required} This is the second point of(the) straight 
+; line(s) whose we want to calculate equation(s)
 ;
-; KEYWORD PARAMETERS:
+;    There is 2 possibilities:
+;      1) point is a complex or a table ofcomplex, where each element is the coordinates of the point.
+;      2) point is a table of real of dimension 2,number_of_straight_line.
+;         For each row of the table, we have coordinates of the point.
 ;
-; OUTPUTS:abc c''est un tableau de dimensions 3, nbre_de_droite, ou
-; pour chaque ligne du tableau on obtient les 3 parametres a, b, c de
-; l'equation de la droite ax+by+c=0
+; @returns abc is a table of dimension 3, number_of_straight_line, 
+;          where for each lign of the table we obtain the 3 parameters
+;          a, b and c of the linear equation ax+by+c=0
 ;
-; COMMON BLOCKS:
+; @examples IDL> abc=linearequation(complex(1,2),[3,4])
+;           IDL> print, abc[0]*1+abc[1]*2+abc[2]
+;           0.00000
 ;
-; SIDE EFFECTS:
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          10 juin 2000
 ;
-; RESTRICTIONS:
+; @version $Id$
 ;
-; EXAMPLE:
-;    IDL> abc=linearequation(complex(1,2),[3,4])
-;    IDL> print, abc[0]*1+abc[1]*2+abc[2]
-;          0.00000
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       10 juin 2000
 ;-
 ;------------------------------------------------------------