summaryrefslogtreecommitdiff
path: root/modules/statistics/macros/nanstdev.sci
blob: 6e38effd3171ffbfed80a96605f12cfd273405f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
// Copyright (C) 2000 - INRIA - Carlos Klimann
//
// This file must be used under the terms of the CeCILL.
// This source file is licensed as described in the file COPYING, which
// you should have received as part of this distribution.  The terms
// are also available at
// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
//

function [s]=nanstdev(x,orient)
    //
    //This function    computes the standard  deviation of   the values of a
    //vector or matrix x (ignoring the NANs).
    //
    //For a vector or a matrix x, y=nanstdev(x)  returns in the scalar y the
    //standard deviation of all the entries of x (ignoring the NANs).
    //
    //y=nanstdev(x,'r')  (or,  equivalently, y=nanstdev(x,1)) is the rowwise
    //standard deviation. It returns in each  entry of the  row vector y the
    //standard deviation of each column of x (ignoring the NANs).
    //
    //y=nanstdev(x,'c')  (or,    equivalently,   y=nanstdev(x,2))    is  the
    //columnwise standard deviation. It returns in  each entry of the column
    //vector y the standard deviation of each row of x (ignoring the NANs).
    //
    //
    //Fixings 2001-10-01. Communication from
    //Collewet Guylaine <guylaine.collewet@cemagref.fr>
    //

    if argn(2)==0 then error(msprintf(gettext("%s: Wrong number of input argument: %d to %d expected.\n"),"nanstdev",1,2)), end

    if x==[] then s=%nan, return, end

    if argn(2)==1 then  orient="*",end
    if orient=="r" then orient=1,elseif orient=="c" then orient=2,end

    isn=isnan(x)
    Mean=nanmean(x,orient);
    if orient=="*" then
        N=size(x,orient)-sum(bool2s(isn),orient)
        x=x-Mean
    else
        N=size(x,orient)-sum(bool2s(isn),orient)
        ind=list();for k=size(x),ind($+1)=:;end
        ind(orient)=ones(size(x,orient),1)
        x=x-Mean(ind(:))
    end
    x(isn)=0
    allnans=find(N==0)
    N(allnans)=1
    s=sqrt(sum(x.*x,orient)./max(N-1,1));
    s(allnans)=%nan
endfunction