src/language/expressions/helpers.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2008, 2010, 2011 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include "language/expressions/helpers.h"
  20
  21 #include <gsl/gsl_roots.h>
  22 #include <gsl/gsl_sf.h>
  23
  24 #include "language/expressions/private.h"
  25 #include "libpspp/assertion.h"
  26 #include "libpspp/pool.h"
  27
  28 const struct substring empty_string = {NULL, 0};
  29
  30 double
  31 expr_ymd_to_ofs (double year, double month, double day)
  32 {
  33   int y = year;
  34   int m = month;
  35   int d = day;
  36   char *error;
  37   double ofs;
  38
  39   if (y != year || m != month || d != day)
  40     {
  41       msg (SE, _("One of the arguments to a DATE function is not an integer.  "
  42                  "The result will be system-missing."));
  43       return SYSMIS;
  44     }
  45
  46   ofs = calendar_gregorian_to_offset (y, m, d, &error);
  47   if (error != NULL)
  48     {
  49       msg (SE, "%s", error);
  50       free (error);
  51     }
  52   return ofs;
  53 }
  54
  55 double
  56 expr_ymd_to_date (double year, double month, double day)
  57 {
  58   double ofs = expr_ymd_to_ofs (year, month, day);
  59   return ofs != SYSMIS ? ofs * DAY_S : SYSMIS;
  60 }
  61
  62 double
  63 expr_wkyr_to_date (double week, double year)
  64 {
  65   int w = week;
  66
  67   if (w != week)
  68     {
  69       msg (SE, _("The week argument to DATE.WKYR is not an integer.  "
  70                  "The result will be system-missing."));
  71       return SYSMIS;
  72     }
  73   else if (w < 1 || w > 53)
  74     {
  75       msg (SE, _("The week argument to DATE.WKYR is outside the acceptable "
  76                  "range of 1 to 53.  "
  77                  "The result will be system-missing."));
  78       return SYSMIS;
  79     }
  80   else
  81     {
  82       double yr_1_1 = expr_ymd_to_ofs (year, 1, 1);
  83       if (yr_1_1 != SYSMIS)
  84         return DAY_S * (yr_1_1 + WEEK_DAY * (w - 1));
  85       else
  86         return SYSMIS;
  87     }
  88 }
  89
  90 double
  91 expr_yrday_to_date (double year, double yday)
  92 {
  93   int yd = yday;
  94
  95   if (yd != yday)
  96     {
  97       msg (SE, _("The day argument to DATE.YRDAY is not an integer.  "
  98                  "The result will be system-missing."));
  99       return SYSMIS;
 100     }
 101   else if (yd < 1 || yd > 366)
 102     {
 103       msg (SE, _("The day argument to DATE.YRDAY is outside the acceptable "
 104                  "range of 1 to 366.  "
 105                  "The result will be system-missing."));
 106       return SYSMIS;
 107     }
 108   else
 109     {
 110       double yr_1_1 = expr_ymd_to_ofs (year, 1, 1);
 111       if (yr_1_1 != SYSMIS)
 112         return DAY_S * (yr_1_1 + yd - 1.);
 113       else
 114         return SYSMIS;
 115     }
 116 }
 117
 118 double
 119 expr_yrmoda (double year, double month, double day)
 120 {
 121   if (year >= 0 && year <= 99)
 122     year += 1900;
 123   else if (year != (int) year && year > 47516)
 124     {
 125       msg (SE, _("The year argument to YRMODA is greater than 47516.  "
 126                  "The result will be system-missing."));
 127       return SYSMIS;
 128     }
 129
 130   return expr_ymd_to_ofs (year, month, day);
 131 }
 132 \f
 133 /* A date unit. */
 134 enum date_unit
 135   {
 136     DATE_YEARS,
 137     DATE_QUARTERS,
 138     DATE_MONTHS,
 139     DATE_WEEKS,
 140     DATE_DAYS,
 141     DATE_HOURS,
 142     DATE_MINUTES,
 143     DATE_SECONDS
 144   };
 145
 146 /* Stores in *UNIT the unit whose name is NAME.
 147    Return success. */
 148 static enum date_unit
 149 recognize_unit (struct substring name, enum date_unit *unit)
 150 {
 151   struct unit_name
 152     {
 153       enum date_unit unit;
 154       const struct substring name;
 155     };
 156   static const struct unit_name unit_names[] =
 157     {
 158       { DATE_YEARS, SS_LITERAL_INITIALIZER ("years") },
 159       { DATE_QUARTERS, SS_LITERAL_INITIALIZER ("quarters") },
 160       { DATE_MONTHS, SS_LITERAL_INITIALIZER ("months") },
 161       { DATE_WEEKS, SS_LITERAL_INITIALIZER ("weeks") },
 162       { DATE_DAYS, SS_LITERAL_INITIALIZER ("days") },
 163       { DATE_HOURS, SS_LITERAL_INITIALIZER ("hours") },
 164       { DATE_MINUTES, SS_LITERAL_INITIALIZER ("minutes") },
 165       { DATE_SECONDS, SS_LITERAL_INITIALIZER ("seconds") },
 166     };
 167   const int unit_name_cnt = sizeof unit_names / sizeof *unit_names;
 168
 169   const struct unit_name *un;
 170
 171   for (un = unit_names; un < &unit_names[unit_name_cnt]; un++)
 172     if (ss_equals_case (un->name, name))
 173       {
 174         *unit = un->unit;
 175         return true;
 176       }
 177
 178   /* TRANSLATORS: Don't translate the the actual unit names `weeks', `days' etc
 179         They must remain in their original English. */
 180   msg (SE, _("Unrecognized date unit `%.*s'.  "
 181              "Valid date units are `years', `quarters', `months', "
 182              "`weeks', `days', `hours', `minutes', and `seconds'."),
 183        (int) ss_length (name), ss_data (name));
 184   return false;
 185 }
 186
 187 /* Returns the number of whole years from DATE1 to DATE2,
 188    where a year is defined as the same or later month, day, and
 189    time of day. */
 190 static int
 191 year_diff (double date1, double date2)
 192 {
 193   int y1, m1, d1, yd1;
 194   int y2, m2, d2, yd2;
 195   int diff;
 196
 197   assert (date2 >= date1);
 198   calendar_offset_to_gregorian (date1 / DAY_S, &y1, &m1, &d1, &yd1);
 199   calendar_offset_to_gregorian (date2 / DAY_S, &y2, &m2, &d2, &yd2);
 200
 201   diff = y2 - y1;
 202   if (diff > 0)
 203     {
 204       int yd1 = 32 * m1 + d1;
 205       int yd2 = 32 * m2 + d2;
 206       if (yd2 < yd1
 207           || (yd2 == yd1 && fmod (date2, DAY_S) < fmod (date1, DAY_S)))
 208         diff--;
 209     }
 210   return diff;
 211 }
 212
 213 /* Returns the number of whole months from DATE1 to DATE2,
 214    where a month is defined as the same or later day and time of
 215    day. */
 216 static int
 217 month_diff (double date1, double date2)
 218 {
 219   int y1, m1, d1, yd1;
 220   int y2, m2, d2, yd2;
 221   int diff;
 222
 223   assert (date2 >= date1);
 224   calendar_offset_to_gregorian (date1 / DAY_S, &y1, &m1, &d1, &yd1);
 225   calendar_offset_to_gregorian (date2 / DAY_S, &y2, &m2, &d2, &yd2);
 226
 227   diff = ((y2 * 12) + m2) - ((y1 * 12) + m1);
 228   if (diff > 0
 229       && (d2 < d1
 230           || (d2 == d1 && fmod (date2, DAY_S) < fmod (date1, DAY_S))))
 231     diff--;
 232   return diff;
 233 }
 234
 235 /* Returns the number of whole quarter from DATE1 to DATE2,
 236    where a quarter is defined as three months. */
 237 static int
 238 quarter_diff (double date1, double date2)
 239 {
 240   return month_diff (date1, date2) / 3;
 241 }
 242
 243 /* Returns the number of seconds in the given UNIT. */
 244 static int
 245 date_unit_duration (enum date_unit unit)
 246 {
 247   switch (unit)
 248     {
 249     case DATE_WEEKS:
 250       return WEEK_S;
 251
 252     case DATE_DAYS:
 253       return DAY_S;
 254
 255     case DATE_HOURS:
 256       return H_S;
 257
 258     case DATE_MINUTES:
 259       return MIN_S;
 260
 261     case DATE_SECONDS:
 262       return 1;
 263
 264     default:
 265       NOT_REACHED ();
 266     }
 267 }
 268
 269 /* Returns the span from DATE1 to DATE2 in terms of UNIT_NAME. */
 270 double
 271 expr_date_difference (double date1, double date2, struct substring unit_name)
 272 {
 273   enum date_unit unit;
 274
 275   if (!recognize_unit (unit_name, &unit))
 276     return SYSMIS;
 277
 278   switch (unit)
 279     {
 280     case DATE_YEARS:
 281       return (date2 >= date1
 282               ? year_diff (date1, date2)
 283               : -year_diff (date2, date1));
 284
 285     case DATE_QUARTERS:
 286       return (date2 >= date1
 287               ? quarter_diff (date1, date2)
 288               : -quarter_diff (date2, date1));
 289
 290     case DATE_MONTHS:
 291       return (date2 >= date1
 292               ? month_diff (date1, date2)
 293               : -month_diff (date2, date1));
 294
 295     case DATE_WEEKS:
 296     case DATE_DAYS:
 297     case DATE_HOURS:
 298     case DATE_MINUTES:
 299     case DATE_SECONDS:
 300       return trunc ((date2 - date1) / date_unit_duration (unit));
 301     }
 302
 303   NOT_REACHED ();
 304 }
 305
 306 /* How to deal with days out of range for a given month. */
 307 enum date_sum_method
 308   {
 309     SUM_ROLLOVER,       /* Roll them over to the next month. */
 310     SUM_CLOSEST         /* Use the last day of the month. */
 311   };
 312
 313 /* Stores in *METHOD the method whose name is NAME.
 314    Return success. */
 315 static bool
 316 recognize_method (struct substring method_name, enum date_sum_method *method)
 317 {
 318   if (ss_equals_case (method_name, ss_cstr ("closest")))
 319     {
 320       *method = SUM_CLOSEST;
 321       return true;
 322     }
 323   else if (ss_equals_case (method_name, ss_cstr ("rollover")))
 324     {
 325       *method = SUM_ROLLOVER;
 326       return true;
 327     }
 328   else
 329     {
 330       msg (SE, _("Invalid DATESUM method.  "
 331                  "Valid choices are `closest' and `rollover'."));
 332       return false;
 333     }
 334 }
 335
 336 /* Returns DATE advanced by the given number of MONTHS, with
 337    day-of-month overflow resolved using METHOD. */
 338 static double
 339 add_months (double date, int months, enum date_sum_method method)
 340 {
 341   int y, m, d, yd;
 342   double output;
 343   char *error;
 344
 345   calendar_offset_to_gregorian (date / DAY_S, &y, &m, &d, &yd);
 346   y += months / 12;
 347   m += months % 12;
 348   if (m < 1)
 349     {
 350       m += 12;
 351       y--;
 352     }
 353   else if (m > 12)
 354     {
 355       m -= 12;
 356       y++;
 357     }
 358   assert (m >= 1 && m <= 12);
 359
 360   if (method == SUM_CLOSEST && d > calendar_days_in_month (y, m))
 361     d = calendar_days_in_month (y, m);
 362
 363   output = calendar_gregorian_to_offset (y, m, d, &error);
 364   if (output != SYSMIS)
 365     output = (output * DAY_S) + fmod (date, DAY_S);
 366   else
 367     {
 368       msg (SE, "%s", error);
 369       free (error);
 370     }
 371   return output;
 372 }
 373
 374 /* Returns DATE advanced by the given QUANTITY of units given in
 375    UNIT_NAME, with day-of-month overflow resolved using
 376    METHOD_NAME. */
 377 double
 378 expr_date_sum (double date, double quantity, struct substring unit_name,
 379                struct substring method_name)
 380 {
 381   enum date_unit unit;
 382   enum date_sum_method method;
 383
 384   if (!recognize_unit (unit_name, &unit)
 385       || !recognize_method (method_name, &method))
 386     return SYSMIS;
 387
 388   switch (unit)
 389     {
 390     case DATE_YEARS:
 391       return add_months (date, trunc (quantity) * 12, method);
 392
 393     case DATE_QUARTERS:
 394       return add_months (date, trunc (quantity) * 3, method);
 395
 396     case DATE_MONTHS:
 397       return add_months (date, trunc (quantity), method);
 398
 399     case DATE_WEEKS:
 400     case DATE_DAYS:
 401     case DATE_HOURS:
 402     case DATE_MINUTES:
 403     case DATE_SECONDS:
 404       return date + quantity * date_unit_duration (unit);
 405     }
 406
 407   NOT_REACHED ();
 408 }
 409
 410 int
 411 compare_string_3way (const struct substring *a, const struct substring *b)
 412 {
 413   size_t i;
 414
 415   for (i = 0; i < a->length && i < b->length; i++)
 416     if (a->string[i] != b->string[i])
 417       return a->string[i] < b->string[i] ? -1 : 1;
 418   for (; i < a->length; i++)
 419     if (a->string[i] != ' ')
 420       return 1;
 421   for (; i < b->length; i++)
 422     if (b->string[i] != ' ')
 423       return -1;
 424   return 0;
 425 }
 426
 427 size_t
 428 count_valid (double *d, size_t d_cnt)
 429 {
 430   size_t valid_cnt;
 431   size_t i;
 432
 433   valid_cnt = 0;
 434   for (i = 0; i < d_cnt; i++)
 435     valid_cnt += is_valid (d[i]);
 436   return valid_cnt;
 437 }
 438
 439 struct substring
 440 alloc_string (struct expression *e, size_t length)
 441 {
 442   struct substring s;
 443   s.length = length;
 444   s.string = pool_alloc (e->eval_pool, length);
 445   return s;
 446 }
 447
 448 struct substring
 449 copy_string (struct expression *e, const char *old, size_t length)
 450 {
 451   struct substring s = alloc_string (e, length);
 452   memcpy (s.string, old, length);
 453   return s;
 454 }
 455
 456 /* Returns the noncentral beta cumulative distribution function
 457    value for the given arguments.
 458
 459    FIXME: The accuracy of this function is not entirely
 460    satisfactory.  We only match the example values given in AS
 461    310 to the first 5 significant digits. */
 462 double
 463 ncdf_beta (double x, double a, double b, double lambda)
 464 {
 465   double c;
 466
 467   if (x <= 0. || x >= 1. || a <= 0. || b <= 0. || lambda <= 0.)
 468     return SYSMIS;
 469
 470   c = lambda / 2.;
 471   if (lambda < 54.)
 472     {
 473       /* Algorithm AS 226. */
 474       double x0, a0, beta, temp, gx, q, ax, sumq, sum;
 475       double err_max = 2 * DBL_EPSILON;
 476       double err_bound;
 477       int iter_max = 100;
 478       int iter;
 479
 480       x0 = floor (c - 5.0 * sqrt (c));
 481       if (x0 < 0.)
 482         x0 = 0.;
 483       a0 = a + x0;
 484       beta = (gsl_sf_lngamma (a0)
 485               + gsl_sf_lngamma (b)
 486               - gsl_sf_lngamma (a0 + b));
 487       temp = gsl_sf_beta_inc (a0, b, x);
 488       gx = exp (a0 * log (x) + b * log (1. - x) - beta - log (a0));
 489       if (a0 >= a)
 490         q = exp (-c + x0 * log (c)) - gsl_sf_lngamma (x0 + 1.);
 491       else
 492         q = exp (-c);
 493       ax = q * temp;
 494       sumq = 1. - q;
 495       sum = ax;
 496
 497       iter = 0;
 498       do
 499         {
 500           iter++;
 501           temp -= gx;
 502           gx = x * (a + b + iter - 1.) * gx / (a + iter);
 503           q *= c / iter;
 504           sumq -= q;
 505           ax = temp * q;
 506           sum += ax;
 507
 508           err_bound = (temp - gx) * sumq;
 509         }
 510       while (iter < iter_max && err_bound > err_max);
 511
 512       return sum;
 513     }
 514   else
 515     {
 516       /* Algorithm AS 310. */
 517       double m, m_sqrt;
 518       int iter, iter_lower, iter_upper, iter1, iter2, j;
 519       double t, q, r, psum, beta, s1, gx, fx, temp, ftemp, t0, s0, sum, s;
 520       double err_bound;
 521       double err_max = 2 * DBL_EPSILON;
 522
 523       iter = 0;
 524
 525       m = floor (c + .5);
 526       m_sqrt = sqrt (m);
 527       iter_lower = m - 5. * m_sqrt;
 528       iter_upper = m + 5. * m_sqrt;
 529
 530       t = -c + m * log (c) - gsl_sf_lngamma (m + 1.);
 531       q = exp (t);
 532       r = q;
 533       psum = q;
 534       beta = (gsl_sf_lngamma (a + m)
 535               + gsl_sf_lngamma (b)
 536               - gsl_sf_lngamma (a + m + b));
 537       s1 = (a + m) * log (x) + b * log (1. - x) - log (a + m) - beta;
 538       fx = gx = exp (s1);
 539       ftemp = temp = gsl_sf_beta_inc (a + m, b, x);
 540       iter++;
 541       sum = q * temp;
 542       iter1 = m;
 543
 544       while (iter1 >= iter_lower && q >= err_max)
 545         {
 546           q = q * iter1 / c;
 547           iter++;
 548           gx = (a + iter1) / (x * (a + b + iter1 - 1.)) * gx;
 549           iter1--;
 550           temp += gx;
 551           psum += q;
 552           sum += q * temp;
 553         }
 554
 555       t0 = (gsl_sf_lngamma (a + b)
 556             - gsl_sf_lngamma (a + 1.)
 557             - gsl_sf_lngamma (b));
 558       s0 = a * log (x) + b * log (1. - x);
 559
 560       s = 0.;
 561       for (j = 0; j < iter1; j++)
 562         {
 563           double t1;
 564           s += exp (t0 + s0 + j * log (x));
 565           t1 = log (a + b + j) - log (a + 1. + j) + t0;
 566           t0 = t1;
 567         }
 568
 569       err_bound = (1. - gsl_sf_gamma_inc_P (iter1, c)) * (temp + s);
 570       q = r;
 571       temp = ftemp;
 572       gx = fx;
 573       iter2 = m;
 574       for (;;)
 575         {
 576           double ebd = err_bound + (1. - psum) * temp;
 577           if (ebd < err_max || iter >= iter_upper)
 578             break;
 579
 580           iter2++;
 581           iter++;
 582           q = q * c / iter2;
 583           psum += q;
 584           temp -= gx;
 585           gx = x * (a + b + iter2 - 1.) / (a + iter2) * gx;
 586           sum += q * temp;
 587         }
 588
 589       return sum;
 590     }
 591 }
 592
 593 double
 594 cdf_bvnor (double x0, double x1, double r)
 595 {
 596   double z = pow2 (x0) - 2. * r * x0 * x1 + pow2 (x1);
 597   return exp (-z / (2. * (1 - r * r))) * (2. * M_PI * sqrt (1 - r * r));
 598 }
 599
 600 double
 601 idf_fdist (double P, double df1, double df2)
 602 {
 603   double temp = gsl_cdf_beta_Pinv (P, df1 / 2, df2 / 2);
 604   return temp * df2 / ((1. - temp) * df1);
 605 }
 606
 607 /*
 608  *  Mathlib : A C Library of Special Functions
 609  *  Copyright (C) 1998 Ross Ihaka
 610  *  Copyright (C) 2000 The R Development Core Team
 611  *
 612  *  This program is free software; you can redistribute it and/or
 613  *  modify
 614  *  it under the terms of the GNU General Public License as
 615  *  published by
 616  *  the Free Software Foundation; either version 2 of the
 617  *  License, or
 618  *  (at your option) any later version.
 619  *
 620  *  This program is distributed in the hope that it will be
 621  *  useful,
 622  *  but WITHOUT ANY WARRANTY; without even the implied warranty
 623  *  of
 624  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 625  *  GNU General Public License for more details.
 626  *
 627  *  You should have received a copy of the GNU General Public
 628  *  License
 629  *  along with this program; if not, write to the Free Software
 630  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 631  *  02110-1301 USA.
 632  */
 633
 634 /* Returns the density of the noncentral beta distribution with
 635    noncentrality parameter LAMBDA. */
 636 double
 637 npdf_beta (double x, double a, double b, double lambda)
 638 {
 639   if (lambda < 0. || a <= 0. || b <= 0.)
 640     return SYSMIS;
 641   else if (lambda == 0.)
 642     return gsl_ran_beta_pdf (x, a, b);
 643   else
 644     {
 645       double max_error = 2 * DBL_EPSILON;
 646       int max_iter = 200;
 647       double term = gsl_ran_beta_pdf (x, a, b);
 648       double lambda2 = 0.5 * lambda;
 649       double weight = exp (-lambda2);
 650       double sum = weight * term;
 651       double psum = weight;
 652       int k;
 653       for (k = 1; k <= max_iter && 1 - psum < max_error; k++) {
 654         weight *= lambda2 / k;
 655         term *= x * (a + b) / a;
 656         sum += weight * term;
 657         psum += weight;
 658         a += 1;
 659       }
 660       return sum;
 661     }
 662 }