Changeset 163 for trunk/SRC/Matrix


Ignore:
Timestamp:
08/29/06 14:59:46 (18 years ago)
Author:
navarro
Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

Location:
trunk/SRC/Matrix
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Matrix/cmapply.pro

    r157 r163  
    22; @file_comments 
    33; Utility function, adapted from CMPRODUCT 
     4; 
     5; @param X 
     6; 
    47; 
    58; @version $Id$ 
    … …  
    2831; cmapply_redim : Utility function, used to collect collaped dimensions 
    2932; 
     33; @param newarr 
     34; 
     35; 
     36; @param dimapply 
     37; 
     38; 
     39; @param dimkeep 
     40; 
     41; 
     42; @param nkeep 
     43; 
     44; 
     45; @param totcol 
     46; 
     47; 
     48; @param totkeep 
     49; 
     50; 
    3051; @todo seb 
    3152;- 
    … …  
    109130; Array 
    110131; 
    111 ; @param OP {in}{required} 
     132; @param OP {in}{required}{type=string} 
    112133; The operation to perform, as a string.  May be upper or lower case. 
    113134; 
    … …  
    116137; the user-defined function. 
    117138; 
    118 ; @param ARRAY {in}{required} 
     139; @param ARRAY {in}{required}{type=array}  
    119140; An array of values to be operated on. 
    120141; Must not be of type STRING (7) or STRUCTURE (8). 
    121142; 
    122 ; @param dimapply {in}{optional}{default=1 (ie, first dimension)} 
     143; @param dimapply {in}{optional}{default=1 (ie, first dimension)}{type=array} 
    123144; An array of dimensions that are to be "collapsed", where 
    124145; the the first dimension starts with 1 (ie, same convention 
    … …  
    135156; precision (real or complex) then DOUBLE=1 is implied. 
    136157; 
    137 ; @keyword TYPE 
     158; @keyword TYPE {default=same as input type} 
    138159; Set this to the IDL code of the desired output type (refer 
    139160; to documentation of SIZE()).  Internal results will be 
    140161; rounded to the nearest integer if the output type is an 
    141162; integer type. 
    142 ; DEFAULT: same is input type 
    143163; 
    144164; @keyword FUNCTARGS 
    … …  
    199219; @history Mar 1998, Written, CM 
    200220;   Changed usage message to not bomb, 24 Mar 2000, CM 
    201 ;   Signficant rewrite for *, MIN and MAX (inspired by Todd Clements 
     221;   Significant rewrite for *, MIN and MAX (inspired by Todd Clements 
    202222;     <Todd_Clements\@alumni.hmc.edu>); FOR loop indices are now type 
    203223;     LONG; copying terms are liberalized, CM, 22, Aug 2000 

  • trunk/SRC/Matrix/cmset_op.pro

    r157 r163  
    4141; 
    4242;   The complements of either set can be taken as well, by using the 
    43 ;   NOT1 and NOT2 keywords. For example, it may be desireable to find 
     43;   NOT1 and NOT2 keywords. For example, it may be desirable to find 
    4444;   the elements in A but not B, or B but not A (they are different!). 
    4545;   The following IDL expressions achieve each of those effects: 
    … …  
    7979; See A 
    8080; 
    81 ; @param OP0 {in}{required} 
     81; @param OP0 {in}{required}{type=string} 
    8282; a string, the operation to be performed. Must be one of 
    8383; 'AND', 'OR' or 'XOR' (lower or mixed case is permitted). 
    … …  
    101101; 
    102102; @keyword INDEX 
    103 ; if set, then return a list of indices instead of the array 
     103; if set, then return a list of indexes instead of the array 
    104104; values themselves. The "slower" set operations are always 
    105105; performed in this case. 
    106106; 
    107 ; The indices refer to the *combined* array [A,B]. To 
     107; The indexes refer to the *combined* array [A,B]. To 
    108108; clarify, in the following call: I = CMSET_OP(..., /INDEX); 
    109109; returned values from 0 to NA-1 refer to A[I], and values 
    … …  
    118118; The resulting set as a one-dimensional array. The set may be 
    119119; represented by either an array of data values (default), or an 
    120 ; array of indices (if INDEX is set). Duplicate elements, if any, 
     120; array of indexes (if INDEX is set). Duplicate elements, if any, 
    121121; are removed, and element order may not be preserved. 
    122122; 

  • trunk/SRC/Matrix/different.pro

    r157 r163  
    55; 
    66; @file_comments  
    7 ; calculate the different elements of 2 matrix of positif whole numbers. 
     7; calculate the different elements of 2 matrix of positive whole numbers. 
    88; 
    99; @categories 

  • trunk/SRC/Matrix/extrac2.pro

    r157 r163  
    55; 
    66; @file_comments 
    7 ; extraction of subdomains of matrixes; 
     7; extraction of subdomains of matrices; 
    88; Even if the subdomain is "pierced" (see the example) 
    99; By default, IDL can make extractions of subdomain: 

  • trunk/SRC/Matrix/inter.pro

    r157 r163  
    55; 
    66; @file_comments  
    7 ; calculate the intersection between 2 matrixes of whole numbers 
     7; calculate the intersection between 2 matrices of whole numbers 
    88; 
    99; @categories  
    … …  
    1111; 
    1212; @param a {in}{required} arrays of positive integers, which need not to be 
    13 ; sorted. Duplicate elements are ignored, as they have noeffect on the 
     13; sorted. Duplicate elements are ignored, as they have no effect on the 
    1414; result 
    1515; 

  • trunk/SRC/Matrix/make_selection.pro

    r134 r163  
    1212; @param SELNAMES {in}{required} A list of selected values 
    1313; 
    14 ; @keyword ONLY_VALID Return only indices of found values. Values not 
     14; @keyword ONLY_VALID Return only indexes of found values. Values not 
    1515;            found are skipped. Default is to return 1 index value for 
    1616;            each SELNAME, which is -1 if SELNAME is not contained in  
    … …  
    1919;            at all. 
    2020; 
    21 ; @keyword REQUIRED Normally, MAKE_SELECTION will return indices for 
     21; @keyword REQUIRED Normally, MAKE_SELECTION will return indexes for 
    2222;            all values that are found, simply ignoring the selected 
    2323;            values that are not in the NAMES array (although an error 
    … …  
    2929;            still be set). 
    3030; 
    31 ; @returns A (long) array with indices to reference the selected values 
     31; @returns A (long) array with indexes to reference the selected values 
    3232;        in the NAMES array. 
    3333; 
    … …  
    5858; 
    5959; @history mgs, 28 Aug 1998: VERSION 1.00 
    60 ;          mgs, 29 Aug 1998: - changed behaviour and added ONLY_VALID keyword 
     60;          mgs, 29 Aug 1998: - changed behavior and added ONLY_VALID keyword 
    6161; 
    6262; @version $Id$ 

  • trunk/SRC/Matrix/union.pro

    r157 r163  
    55; 
    66; @file_comments  
    7 ; calculate tne union between 2 matrixes of whole numbers 
     7; calculate the union between 2 matrices of whole numbers 
    88; 
    99; @categories  

  • trunk/SRC/Matrix/zero_one.pro

    r157 r163  
    44;+ 
    55; @file_comments  
    6 ; Send back a vector or a matrix constituate of 0 and 1 in alternation 
     6; Send back a vector or a matrix constituted of 0 and 1 in alternation 
    77; 
    88; @categories  
    … …  
    1010; 
    1111; @param n1 {in}{required} number of elements in the first dimension 
    12 ; @param n2 {in}{required} numbre of elements in the second dimension 
     12; @param n2 {in}{required} number of elements in the second dimension 
    1313; 
    14 ; @returns resultat 
     14; @returns result 
    1515;  
    1616; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
Note: See TracChangeset for help on using the changeset viewer.