c_cpp/etc/calc/help/modify

   1 NAME
   2     modify - modify a list or matrix by changing the values of its elements
   3
   4 SYNOPSIS
   5     modify(A, fname)
   6
   7 TYPES
   8     A           lvalue with list, matrix or objectvalue
   9     fname       string, the name of a user-defined function
  10
  11     return      null value if successful, otherwise an error value
  12
  13 DESCRIPTION
  14     The value of each element of A is replaced by the value at that
  15     value of the user-defined function with name fname. Thus,
  16     modify(A, "f") has the effect of
  17
  18         for (i = 0; i < size(A); i++) A[[i]] = f(A[[i]]);
  19
  20     An error value is returned if A is not of acceptable type, if A has
  21     no-change protection, or if there is no user-defined function with
  22     name fname. The assignments are executed even if the protection
  23     status of some elements A[[i]] would normally prevent the
  24     assignment of f(A[[i]]) to A[[i]]. The modified elements retain
  25     whatever kinds of protection they had as well as gaining any
  26     other kinds of protection in the values returned by the function.
  27
  28     To obtain a modified copy of A without changing values in A,
  29     one may use
  30
  31         Amod = A; modify(A, fname)
  32
  33     or more simply
  34
  35         modify(Amod = A, fname).
  36
  37 EXAMPLE
  38     ; define f(x) = x^2
  39     ; A = list(2,4,6)
  40     ; modify(A, "f")
  41     ; print A
  42
  43     list (3 elements, 3 nonzero):
  44           [[0]] = 4
  45           [[1]] = 16
  46           [[3]] = 36
  47
  48 LIMITS
  49     none
  50
  51 LINK LIBRARY
  52     none
  53
  54 SEE ALSO
  55     makelist
  56
  57 ## Copyright (C) 1999  Landon Curt Noll
  58 ##
  59 ## Calc is open software; you can redistribute it and/or modify it under
  60 ## the terms of the version 2.1 of the GNU Lesser General Public License
  61 ## as published by the Free Software Foundation.
  62 ##
  63 ## Calc is distributed in the hope that it will be useful, but WITHOUT
  64 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  65 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
  66 ## Public License for more details.
  67 ##
  68 ## A copy of version 2.1 of the GNU Lesser General Public License is
  69 ## distributed with calc under the filename COPYING-LGPL.  You should have
  70 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
  71 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  72 ##
  73 ## @(#) $Revision: 30.1 $
  74 ## @(#) $Id: modify,v 30.1 2007/03/16 11:10:42 chongo Exp $
  75 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/modify,v $
  76 ##
  77 ## Under source code control:   1995/07/10 02:09:31
  78 ## File existed as early as:    1995
  79 ##
  80 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
  81 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/