annotate extra/ver20/nansum.m @ 0:6b33357c7561 octave-forge

Initial revision
author pkienzle
date Wed, 10 Oct 2001 19:54:49 +0000
parents
children 999cd0f401d9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
1 ## Copyright (C) 2001 Paul Kienzle
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
2 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
6 ## (at your option) any later version.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
7 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
11 ## GNU General Public License for more details.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
12 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
15 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
16
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
17 ## v = nansum (X [, dim]);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
18 ## nansum is identical to the sum function except that NaN values are
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
19 ## treated as 0 and so ignored. If all values are NaN, the sum is
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
20 ## returned as 0. [Is this behaviour compatible?]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
21 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
22 ## See also: nanmin, nanmax, nanmean, nanmedian
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
23 function v = nansum (X, ...)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
24 if nargin < 1
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
25 usage ("v = nansum (X [, dim])");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
26 else
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
27 dfi = do_fortran_indexing;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
28 pzoi = prefer_zero_one_indexing;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
29 unwind_protect
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
30 do_fortran_indexing = 1;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
31 prefer_zero_one_indexing = 1;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
32
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
33 X(isnan(X)) = 0;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
34 v = sum (X, all_va_args);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
35 unwind_protect_cleanup
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
36 do_fortran_indexing = dfi;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
37 prefer_zero_one_indexing = pzoi;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
38 end_unwind_protect
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
39 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
40 endfunction