octave_packages/financial-0.4.0/eomdate.m

   1 ## Copyright (C) 2008 Bill Denney <bill@denney.ws>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{e} =} eomdate (@var{y}, @var{m})
  18 ## Return the last day of the month @var{m} for the year @var{y} in
  19 ## datenum format.
  20 ## @seealso{datenum, datevec, weekday, eomday}
  21 ## @end deftypefn
  22
  23 function e = eomdate (y, m)
  24
  25   if (nargin != 2)
  26     print_usage ();
  27   endif
  28
  29   d = eomday (y, m);
  30   e = datenum (y, m, d);
  31
  32 endfunction
  33
  34 ## Tests
  35 ## Leap years
  36 %!assert(eomdate(2008, 2), datenum(2008, 2, 29))
  37 %!assert(eomdate(2007, 2), datenum(2007, 2, 28))
  38 ## Vectors
  39 %!assert(eomdate([2008 2007], [3 4]), [datenum(2008, 3, 31) datenum(2007, 4, 30)])
  40 %!assert(eomdate([2008;2007], [3;4]), [datenum(2008, 3, 31);datenum(2007, 4, 30)])