summaryrefslogtreecommitdiff
path: root/inst/arrays/@stk_dataframe/std.m
blob: 5caf4d4c3c425a205f98f6aba590537a9be7e9f8 (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
% STD [overload base function]

% Copyright Notice
%
%    Copyright (C) 2013 SUPELEC
%
%    Author: Julien Bect  <julien.bect@centralesupelec.fr>

% Copying Permission Statement
%
%    This file is part of
%
%            STK: a Small (Matlab/Octave) Toolbox for Kriging
%               (http://sourceforge.net/projects/kriging)
%
%    STK is free software: you can redistribute it and/or modify it under
%    the terms of the GNU General Public License as published by the Free
%    Software Foundation,  either version 3  of the License, or  (at your
%    option) any later version.
%
%    STK is distributed  in the hope that it will  be useful, but WITHOUT
%    ANY WARRANTY;  without even the implied  warranty of MERCHANTABILITY
%    or FITNESS  FOR A  PARTICULAR PURPOSE.  See  the GNU  General Public
%    License for more details.
%
%    You should  have received a copy  of the GNU  General Public License
%    along with STK.  If not, see <http://www.gnu.org/licenses/>.

function z = std(x, flag, dim)

if nargin < 2, flag = 0; end % default: normalize by N-1
if nargin < 3, dim = 1; end % default: act along columns

z = apply(x, dim, @std, flag);

end % function


%!shared x1, df1
%! x1 = rand(9, 3);
%! df1 = stk_dataframe(x1, {'a', 'b', 'c'});
%!assert (isequal (std(df1),       std(x1)))
%!assert (isequal (std(df1, 0, 1), std(x1)))
%!assert (isequal (std(df1, 0, 2), std(x1, 0, 2)))
%!assert (isequal (std(df1, 1),    std(x1, 1)))
%!assert (isequal (std(df1, 1, 1), std(x1, 1)))
%!assert (isequal (std(df1, 1, 2), std(x1, 1, 2)))