Changeset 142 for trunk/SRC/ToBeReviewed/MATRICE/colle.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/MATRICE/colle.pro (modified) (8 diffs)

trunk/SRC/ToBeReviewed/MATRICE/colle.pro

@@ -2 +2 @@
 ; @file_comments 
 ; This concatenation function exist in IDL so long 
-;as we do not try to stick with a dimension superior or equal at 4.  
+; as we do not try to stick with a dimension superior or equal at 4.  
 ;
 ; @categories utilities
@@ -48 +48 @@
 ; @param a20 {in}{required}
 ;
-; @param CAS 1 {in}{required}
-;        table_of_pointer: It is a table of pointers, where each 
-;        element point on a table to stick
-;       
-;        For exemple, in a program, we want to stick n table ones with others.
-;
-;          tab=ptrarr(n,/allocate_heap)
-;          for i=0,n-1 do begin
-;             *tab[n]=replicate(n,2,3)
-;          endfor
-;          res=colle(tab,1)
-;
-; @param CAS 2 {in}{required}
-;        we directly give tables to stick
-;        Comment: In this case, the plus we can give is 20 tables.
-;
-;        BEWARE: whitout the keyword /SAUVE entry arguments are 
-;                delete when, we build res. In the first case,we 
-;                delete the table of pointers and variables on which we point.
-;
-; @param direc {in}{required} The direction on which stick them, 1,2,3... 
-;
 ; @keyword SAUVE mot cle qui force a sauvegarder le tableau de
 ;         pointeur et les tableaux a coller.
@@ -98 +76 @@
    res = -1
 ;------------------------------------------------------------
-; on met en place ptrtab et direc en fonction des arguments en entree
+; We put in place ptrtab and direc in function of input arguments
 ;------------------------------------------------------------
    case 1 of
-      n_params() EQ 2:BEGIN     ; cas ou l'on donne directement le tableau de pointeurs
+      n_params() EQ 2:BEGIN     ; case where we directly give the pointer array
          ptrtab = a0
          direc = a1
          if NOT keyword_set(sauve) then undefine, a0
-; on recupere le nombre de tableaux a coller
+; on recuperate the number of array to be pasted.
          nbretab = (size(ptrtab))[1]
       end
       n_params() GT 2:BEGIN
-; on recupere le nombre de tableaux a coller
+; on recuperate the number of array to be pasted.
          nbretab = n_params()-1
          bidon = execute('direc = a'+strtrim(n_params()-1, 2))
-; on ecrit le tableau de pointeur dont chaque element pointe sur un tableau
+; We write the pointer array whose each element point on an array.
          ptrtab=ptrarr(nbretab,/allocate_heap)
          for n = 0,nbretab-1 do begin
@@ -123 +101 @@
    endcase
 ;------------------------------------------------------------
-; case sur la valeure de direc
+; case on the direct's value.
 ;------------------------------------------------------------
    case direc of
-      1:BEGIN                   ; on colle suivant la dimension 1
+      1:BEGIN                   ; we paste following the dimension 1
          res = *ptrtab[0]
          if NOT keyword_set(sauve) then ptr_free, ptrtab[0]
@@ -134 +112 @@
          ENDFOR 
       END 
-      2:BEGIN                   ; on colle suivant la dimension 2
+      2:BEGIN                   ; we paste following the dimension 2
          res = *ptrtab[0]
          if NOT keyword_set(sauve) then ptr_free, ptrtab[0]
@@ -142 +120 @@
          ENDFOR 
       END 
-      3:BEGIN                   ; on colle suivant la dimension 3
+      3:BEGIN                   ; we paste following the dimension 3
          res = *ptrtab[0]
          if NOT keyword_set(sauve) then ptr_free, ptrtab[0]
@@ -151 +129 @@
       END
       ELSE:BEGIN 
-; on transpose res de facon a mettre la dimension a coller numero 1.
-; pour cela on contient le vecteur permute qui donne la place que
-; doivent prendre les dimensions ds la matrice transposee
+; We transpose res in order to put the dimension to be pasted number 1
+; To this, we contain the permuter vector which give the place that dimension 
+; in the transposed matrix must take.
         siz = (size(*ptrtab[0]))[0]
          if siz LT direc then $
@@ -162 +140 @@
          res = transpose(*ptrtab[0], permute)
          if NOT keyword_set(sauve) then ptr_free, ptrtab[0]
-         FOR n = 1,nbretab-1 DO BEGIN ; on colle suivant la dimension 1
+         FOR n = 1,nbretab-1 DO BEGIN ; we paste following the dimension 1on colle suivant la dimension 1
             if (size(*ptrtab[n]))[0] LT direc then $
              *ptrtab[n] = reform(*ptrtab[n], [(size(*ptrtab[n]))[1:siz], replicate(1, direc-siz)])