Changeset 142 for trunk/SRC/ToBeReviewed/CALCULS/determ3.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/determ3.pro (modified) (1 diff)

trunk/SRC/ToBeReviewed/CALCULS/determ3.pro

@@ -1 +1 @@
 ;+
-; NAME:determ3
 ;
-; PURPOSE: computes the determinant of n 3 by 3 arrays
+; @file_comments
+; computes the determinant of n 3 by 3 arrays.
+; Z2DS is an 3*3*n array
 ;
-; CATEGORY: no DO loops and better accuracy
+; @categories
+; Without loop
 ;
-; CALLING SEQUENCE:2 cases:
-;     res = determ2(z2ds)
-;     res = determ2(in00, in01, in02, in10, in11, in12, in20, in21, in22)
+; @param IN00 {in}{required}
+; It is an n element array
+; defined by in00 = z2ds[0, 0, *]
 ;
-; INPUTS:
-;     z2ds: an 3*3*n array
-;     or
-;     in00, in01, in02, in10, in11, in12, in20, in21, in22: the nine n
-;     elements arrays defined as:
-;           in00 = z2ds[0, 0, *]
-;           in01 = z2ds[0, 1, *]
-;           in02 = z2ds[0, 2, *]
-;           in10 = z2ds[1, 0, *]
-;           in11 = z2ds[1, 1, *]
-;           in12 = z2ds[1, 2, *]
-;           in20 = z2ds[2, 0, *]
-;           in21 = z2ds[2, 1, *]
-;           in22 = z2ds[2, 2, *]
+; @param IN01 {in}{required}
+; It is an n element array
+; defined by in01 = z2ds[0, 1, *]
 ;
-; OUTPUTS: n elements array, the determinent of each 3*3 arrrays
+; @param IN02 {in}{required}
+; It is an n element array
+; defined by in02 = z2ds[0, 2, *]
 ;
-; EXAMPLE:
+; @param IN10 {in}{required}
+; It is an n element array
+; defined by in10 = z2ds[1, 0, *]
 ;
+;
+; @param IN11 {in}{required}
+; It is an n element array
+; defined by in11 = z2ds[1, 1, *]
+;
+;
+; @param IN12 {in}{required}
+; It is an n element array
+; defined by in12 = z2ds[1, 2, *]
+;
+;
+; @param IN20 {in}{required}
+; It is an n element array
+; defined by in20 = z2ds[2, 0, *]
+;
+;
+; @param IN21 {in}{required}
+; It is an n element array
+; defined by in21 = z2ds[2, 1, *]
+;
+;
+; @param IN22 {in}{required}
+; It is an n element array
+; defined by in22 = z2ds[2, 2, *]
+;
+; @returns 
+; n elements array, the determinent of each 3*3 arrrays
+;
+; @examples
 ; a=findgen(3,3,5)
 ; print, determ3(a^2)
 ; FOR i=0,4 DO print, determ((a[*,*,i])^2) ; IDL solution
 ;
-; MODIFICATION HISTORY:
+; @history
 ;           S. Masson (smasson@lodyc.jussieu.fr)
 ;           July 11th, 2002
+;
+; @version
+; $Id$
+;
 ;-
 FUNCTION determ3, in00, in01, in02, in10, in11, in12, in20, in21, in22