improve inst/@sym/supremum.m

Author: latot

inst/@sym/supremum.m

@@ -0,0 +1,51 @@
+%% Copyright (C) 2017 Lagu
+%%
+%% This file is part of OctSymPy.
+%%
+%% OctSymPy 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.
+%%
+%% This software 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 this software; see the file COPYING.
+%% If not, see <http://www.gnu.org/licenses/>.
+
+%% -*- texinfo -*-
+%% @documentencoding UTF-8
+%% @defmethod @@sym supremum (@var{x})
+%% The supremum of @var{x}.
+%%
+%% Example:
+%% @example
+%% @group
+%% a = interval (sym (1), 2);
+%% supremum (a)
+%%   @result{} ans = (sym) 2
+%% @end group
+%% @end example
+%%
+%% @end defmethod
+
+
+function y = supremum(x)
+  if (nargin ~= 1)
+    print_usage ();
+  end
+  y = elementwise_op ('lambda x: x.sup', sym (x));
+end
+
+
+%!test
+%! a = interval (sym (0), 1);
+%! assert( isequal( supremum (a), sym (1)))
+
+%!test
+%! a = interval (sym (0), 1);
+%! b = interval (sym (2), 3);
+%! assert (isequal (supremum (a + b), sym (3)))