## Copyright (C) 2019, 2023, 2024 Andrew Janke <floss@apjanke.net>
##
## This file is part of Tablicious.
##
## Octave 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.
##
## Octave 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 Octave; see the file COPYING.  If not, see
## <https://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function} {@var{out} =} isduration (@var{x})
##
## True if input is a @code{duration} array, false otherwise.
##
## Respects @code{isduration} override methods on user-defined classes, even if
## they do not inherit from @code{duration} or were known to Tablicious at
## authoring time.
##
## Returns a scalar logical.
##
## @end deftypefn

function out = isduration (x)
  #ISDURATION True if input is a duration array

  # Developer note: see istable for an explanation of this logic.
  if (isa (x, 'duration'))
    out = true;
  elseif (isobject (x))
    # Respect isduration methods on classes.
    if (ismember ('isduration', methods (x)))
      out = isduration (x);
    else
      out = false;
    endif
  else
    out = false;
  endif
endfunction

%!assert (isduration (duration))
%!assert (! isduration (datetime))
%!assert (isequal (isduration (repmat (duration, [2 3])), true))
%!assert (! isduration (42))
%!assert (! isduration ('01:02:03'))
%!assert (isequal (isduration (repmat (42, [2 3])), false))
