summaryrefslogtreecommitdiff
path: root/inst/arrays/generic/stk_boundingbox.m
blob: 47fd6e32811b380752af09573284d73761e63b2a (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
56
57
58
59
60
61
62
63
64
% STK_BOUNDINGBOX constructs the bounding box for a set of points
%
% CALL: B = stk_boundingbox (X)
%
%    returns the bounding box of X, defined as:
%
%       B = [min(X); max(X)].
%
%    The result is an stk_hrect object.
%
%  See also: stk_hrect

% Copyright Notice
%
%    Copyright (C) 2015, 2017, 2018 CentraleSupelec
%
%    Author:  Julien Bect  <julien.bect@centralesupelec.fr>

% Copying Permission Statement
%
%    This file is part of
%
%            STK: a Small (Matlab/Octave) Toolbox for Kriging
%               (https://github.com/stk-kriging/stk/)
%
%    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 box = stk_boundingbox (x)

if ~ isnumeric (x)
    stk_error (['The input argument should be a ' ...
        'numeric array.'], 'TypeMismatch');
elseif ndims (x) ~= 2  %#ok<ISMAT> see CODING_GUDELINES
    stk_error (['Arrays with more than two dimensions are ' ...
        'not supported.'], 'IncorrectSize');
end

xmin = min (x, [], 1);
xmax = max (x, [], 1);

box = stk_hrect ([xmin; xmax]);

end % function


%!shared x, y, cn
%! cn = {'a', 'b', 'c'};
%! x = [0 3 2; 1 4 1; 7 0 2];

%!error  y = stk_boundingbox ();
%!test   y = stk_boundingbox (x);

%!assert (isequal (y.data, [0 0 1; 7 4 2]));