Change period semantics to include end date (#893)

Author: AltGr

stdlib/c/period_internal.c

@@ -90,9 +90,11 @@ PeriodInternal__split_by_month(const CATALA_TUPLE(CATALA_DATE; CATALA_DATE) p)
   CATALA_DATE stop = p[1].content;
   int estimated_size;
   CATALA_ARRAY(CATALA_TUPLE(CATALA_DATE; CATALA_DATE)) ret;
+  dc_date * next_end;
   dc_date * next;
   dc_date tmp;
   dc_period one_month;
+  dc_period m_one_day;
   char should_continue;
   int idx;
 
@@ -109,6 +111,7 @@ PeriodInternal__split_by_month(const CATALA_TUPLE(CATALA_DATE; CATALA_DATE) p)
   ret->elements = catala_malloc(estimated_size * sizeof(CATALA_TUPLE(_)));
 
   dc_make_period(&one_month, 0, 1, 0);
+  dc_make_period(&m_one_day, 0, 0, -1);
   idx = 0;
 
   while (1) {
@@ -117,7 +120,9 @@ PeriodInternal__split_by_month(const CATALA_TUPLE(CATALA_DATE; CATALA_DATE) p)
     dc_add_dates(next, dc_date_round_abort, &tmp, &one_month);
 
     if (dc_compare_dates(next, stop) < 0){
-      ret->elements[idx++] = mk_period(start, next);
+      next_end = catala_malloc(sizeof(dc_date));
+      dc_add_dates(next_end, dc_date_round_abort, next, &m_one_day);
+      ret->elements[idx++] = mk_period(start, next_end);
       start = next;
       continue;
     }
@@ -150,8 +155,10 @@ PeriodInternal__split_by_year(CATALA_INT start_month, const CATALA_TUPLE(CATALA_
   int estimated_size;
   CATALA_ARRAY(CATALA_TUPLE(CATALA_DATE; CATALA_DATE)) ret;
   dc_date * next;
+  dc_date * next_end;
   dc_date tmp;
   dc_period one_year;
+  dc_period m_one_day;
   char should_continue;
   int idx;
 
@@ -169,6 +176,7 @@ PeriodInternal__split_by_year(CATALA_INT start_month, const CATALA_TUPLE(CATALA_
   estimated_size = (dc_date_year(stop) - dc_date_year(start) + 1);
   ret->elements = catala_malloc(estimated_size * sizeof(CATALA_TUPLE(_)));
   dc_make_period(&one_year, 1, 0, 0);
+  dc_make_period(&m_one_day, 0, 0, -1);
   idx = 0;
 
   while (1) {
@@ -177,7 +185,9 @@ PeriodInternal__split_by_year(CATALA_INT start_month, const CATALA_TUPLE(CATALA_
     dc_add_dates(next, dc_date_round_abort, &tmp, &one_year);
 
     if (dc_compare_dates(next, stop) < 0){
-      ret->elements[idx++] = mk_period(start, next);
+      next_end = catala_malloc(sizeof(dc_date));
+      dc_add_dates(next_end, dc_date_round_abort, next, &m_one_day);
+      ret->elements[idx++] = mk_period(start, next_end);
       start = next;
       continue;
     }

stdlib/java/period_internal.java

@@ -38,7 +38,7 @@ public static class Globals {
             };
 
         /**
-         * Splits the given period, returning one period per calendar month. 
+         * Splits the given period, returning one period per calendar month.
          * The first and last elements may be non-whole months.
          * Edge-case: if the given period is empty (begin >= end), an empty list
          * is returned.
@@ -52,16 +52,20 @@ public static class Globals {
 
                 while(cur.compareTo(end) < 0){
                    CatalaDate fdmNext = cur.getFirstDayOfMonth().addDurationAbortOnRound(null, CatalaDuration.of(0, 1, 0));
-                   int cmp = end.compareTo(fdmNext);
-                   CatalaDate cut = cmp <= 0 ? end : fdmNext;
-                   res.add(new CatalaTuple(cur, cut));
-                   cur = cut;
+                   CatalaDate fdmEndPeriod = fdmNext.addDurationAbortOnRound(null, CatalaDuration.of(0, 0, -1));
+                  if (end.compareTo(fdmNext) <= 0) {
+                    res.add(new CatalaTuple(cur, end));
+                    break;
+                  } else {
+                      res.add(new CatalaTuple(cur, fdmEndPeriod));
+                  }
+                  cur = fdmNext;
                 }
 
                 return new CatalaArray<>(res.toArray(CatalaTuple[]::new));
             };
 
-        /** 
+        /**
          * Splits the given period, returning one period per year, split on the first
          * of the given month. The first and last elements returned may be non-whole
          * years.
@@ -79,9 +83,14 @@ public static class Globals {
               while(cur.compareTo(end) < 0){
                 CatalaDate fdyNext =
                     new CatalaDate(firstDayOfNextRollingYear(startMonth.asBigInteger().intValueExact(), cur.date));
-                CatalaDate cut = end.compareTo(fdyNext) <= 0 ? end : fdyNext;
-                res.add(new CatalaTuple(cur, cut));
-                cur = cut;
+                CatalaDate fdyEndPeriod = fdyNext.addDurationAbortOnRound(null, CatalaDuration.of(0, 0, -1));
+                if (end.compareTo(fdyNext) <= 0) {
+                    res.add(new CatalaTuple(cur, end));
+                    break;
+                } else {
+                    res.add(new CatalaTuple(cur, fdyEndPeriod));
+                }
+                cur = fdyNext;
               }
 
               return new CatalaArray<>(res.toArray(CatalaTuple[]::new));

stdlib/ocaml/period_internal.ml

@@ -10,21 +10,22 @@ let sort : ((date * date) * 'a) array -> ((date * date) * 'a) array =
   Array.stable_sort (fun ((beg1, _), _) ((beg2, _), _) -> cmp beg1 beg2) ret;
   ret
 
+let one_day = Dates.make_period ~years:0 ~months:0 ~days:1
 let one_month = Dates.make_period ~years:0 ~months:1 ~days:0
+let one_year = Dates.make_period ~years:1 ~months:0 ~days:0
 
 (* Toplevel def split_by_month *)
 let split_by_month : date * date -> (date * date) array =
  fun (start, stop) ->
   let rec split start =
     let next = Dates.add_dates (Dates.first_day_of_month start) one_month in
-    if cmp next stop < 0 then (start, next) :: split next
+    let end_period = Dates.(add_dates next (neg_period one_day)) in
+    if cmp next stop < 0 then (start, end_period) :: split next
     else if cmp start stop < 0 then [start, stop]
     else []
   in
   split start |> Array.of_list
 
-let one_year = Dates.make_period ~years:1 ~months:0 ~days:0
-
 let first_day_of_rolling_year date start_month =
   let year, month, _ = Dates.date_to_ymd date in
   let year = if month < start_month then year - 1 else year in
@@ -39,7 +40,8 @@ let split_by_year : integer -> date * date -> (date * date) array =
     let next =
       Dates.add_dates (first_day_of_rolling_year start start_month) one_year
     in
-    if cmp next stop < 0 then (start, next) :: split next
+    let end_period = Dates.(add_dates next (neg_period one_day)) in
+    if cmp next stop < 0 then (start, end_period) :: split next
     else if cmp start stop < 0 then [start, stop]
     else []
   in