octave_packages/financial-0.4.0/doc-cache

   1 # Created by Octave 3.6.1, Sat Apr 28 20:53:21 2012 UTC <root@brouzouf>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 57
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 7
  10 bolling
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 716
  17  -- Function File:  bolling (ASSET, SAMPLES)
  18  -- Function File:  bolling (ASSET, SAMPLES, ALPHA)
  19  -- Function File:  bolling (ASSET, SAMPLES, ALPHA, WIDTH)
  20  -- Function File: [MOVAVG, UPPERBAND, LOWERBAND] = bolling (ASSET,
  21           SAMPLES, ...)
  22      If no output is requested, plot the bollinger bands of the ASSET.
  23      If output is requested, return the values for the bollinger bands.
  24      If given, ALPHA is the weighting power of the moving average; 0
  25      (default) is the simple moving average, see `movavg' for the full
  26      definition.  WIDTH is the number of standard deviations to plot
  27      above and below the moving average (default: 2).
  28
  29      See also: movavg, candle, dateaxis, highlow, pointfig
  30
  31
  32
  33
  34
  35 # name: <cell-element>
  36 # type: sq_string
  37 # elements: 1
  38 # length: 65
  39 If no output is requested, plot the bollinger bands of the ASSET.
  40
  41
  42
  43 # name: <cell-element>
  44 # type: sq_string
  45 # elements: 1
  46 # length: 7
  47 busdate
  48
  49
  50 # name: <cell-element>
  51 # type: sq_string
  52 # elements: 1
  53 # length: 833
  54  -- Function File: b = busdate (refdate)
  55  -- Function File: b = busdate (refdate, direction)
  56  -- Function File: b = busdate (refdate, direction, holiday)
  57  -- Function File: b = busdate (refdate, direction, holiday, weekend)
  58      Return the datenum of the next or previous business day from
  59      REFDATE. DIRECTION indicates the next day (default) if 1 and the
  60      previous day if -1.  HOLIDAY is a vector of datenums that defines
  61      the holidays observed (the holidays function is used if not
  62      given).  WEEKEND defines the days of the week that should be
  63      considered weekends; [1 0 0 0 0 0 1] (default) indicates that
  64      Sunday and Saturday are holidays.
  65
  66      If any of the optional inputs (DIRECTION, HOLIDAY, WEEKEND) are
  67      empty, then the default is used.
  68
  69      See also: holidays, lbusdate, isbusday, fbusdate
  70
  71
  72
  73
  74
  75 # name: <cell-element>
  76 # type: sq_string
  77 # elements: 1
  78 # length: 69
  79 Return the datenum of the next or previous business day from REFDATE.
  80
  81
  82
  83 # name: <cell-element>
  84 # type: sq_string
  85 # elements: 1
  86 # length: 7
  87 busdays
  88
  89
  90 # name: <cell-element>
  91 # type: sq_string
  92 # elements: 1
  93 # length: 870
  94  -- Function File: BDATES = busdays (SDATE, EDATE)
  95  -- Function File: BDATES = busdays (SDATE, EDATE, BDMODE)
  96  -- Function File: BDATES = busdays (SDATE, EDATE, BDMODE, HOLVEC)
  97      Generate a list of business dates at the end of the periods defined
  98      between (including) SDATE and EDATE.
  99
 100      SDATE is the starting date, EDATE is the ending date, both are in
 101      serial date format (see datenum).  BDMODE is the business day
 102      frequency ("daily", "weekly", "monthly", "quarterly",
 103      "semiannual", or "annual"); these can be abbreviated by the first
 104      letter and they may also use an integer corresponding to the order
 105      in the above list (i.e. "daily" = 1).  HOLVEC is an optional list
 106      of holidays.  If the holidays are not given, then the holidays
 107      function is used.
 108
 109      See also: holidays, busdate, lbusdate, isbusday, fbusdate, datenum
 110
 111
 112
 113
 114
 115 # name: <cell-element>
 116 # type: sq_string
 117 # elements: 1
 118 # length: 80
 119 Generate a list of business dates at the end of the periods defined
 120 between (inc
 121
 122
 123
 124 # name: <cell-element>
 125 # type: sq_string
 126 # elements: 1
 127 # length: 6
 128 cfconv
 129
 130
 131 # name: <cell-element>
 132 # type: sq_string
 133 # elements: 1
 134 # length: 305
 135  -- Function File: CFCONV = cfconv (CF, YIELD)
 136      Calculate convexity CFCONV from given fixed-paid cash flow CF and
 137      period yield YIELD.
 138
 139      Reference:
 140
 141      [1] http://thismatter.com/money/bonds/duration-convexity.htm
 142
 143      [2] http://en.wikipedia.org/wiki/Bond_convexity
 144
 145      See also: cfdur
 146
 147
 148
 149
 150
 151 # name: <cell-element>
 152 # type: sq_string
 153 # elements: 1
 154 # length: 80
 155 Calculate convexity CFCONV from given fixed-paid cash flow CF and
 156 period yield Y
 157
 158
 159
 160 # name: <cell-element>
 161 # type: sq_string
 162 # elements: 1
 163 # length: 5
 164 cfdur
 165
 166
 167 # name: <cell-element>
 168 # type: sq_string
 169 # elements: 1
 170 # length: 329
 171  -- Function File: [DUR, MOD_DUR] = cfdur (CF, YIELD)
 172      Calculate duration DUR and modified duration MOD_DUR, from given
 173      fixed-paid cash flow CF and period yield YIELD.
 174
 175      Reference: http://en.wikipedia.org/wiki/Bond_duration Using
 176      periodic compounding instead of continuous compounding.
 177
 178      See also: cfconv
 179
 180
 181
 182
 183
 184 # name: <cell-element>
 185 # type: sq_string
 186 # elements: 1
 187 # length: 80
 188 Calculate duration DUR and modified duration MOD_DUR, from given
 189 fixed-paid cash
 190
 191
 192
 193 # name: <cell-element>
 194 # type: sq_string
 195 # elements: 1
 196 # length: 8
 197 corr2cov
 198
 199
 200 # name: <cell-element>
 201 # type: sq_string
 202 # elements: 1
 203 # length: 279
 204  -- Function File: COV = corr2cov (SIGMA, CORR)
 205      Convert standard deviation SIGMA and correlation coefficients CORR
 206      to covariance COV.
 207
 208      Note that the rate R is specified as a fraction (i.e., 0.05, not 5
 209      percent).
 210
 211      See also: corrcoef, cov, cov2corr, std
 212
 213
 214
 215
 216
 217 # name: <cell-element>
 218 # type: sq_string
 219 # elements: 1
 220 # length: 80
 221 Convert standard deviation SIGMA and correlation coefficients CORR to
 222 covariance
 223
 224
 225
 226 # name: <cell-element>
 227 # type: sq_string
 228 # elements: 1
 229 # length: 8
 230 cov2corr
 231
 232
 233 # name: <cell-element>
 234 # type: sq_string
 235 # elements: 1
 236 # length: 204
 237  -- Function File: [SIGMA, CORR] = cov2corr (COV)
 238      Convert covariance COV from input to standard deviation SIGMA and
 239      correlation coefficients CORR.
 240
 241      See also: corr2cov, corrcoef, cov, std
 242
 243
 244
 245
 246
 247 # name: <cell-element>
 248 # type: sq_string
 249 # elements: 1
 250 # length: 80
 251 Convert covariance COV from input to standard deviation SIGMA and
 252 correlation co
 253
 254
 255
 256 # name: <cell-element>
 257 # type: sq_string
 258 # elements: 1
 259 # length: 8
 260 dateaxis
 261
 262
 263 # name: <cell-element>
 264 # type: sq_string
 265 # elements: 1
 266 # length: 669
 267  -- Function File:  dateaxis ()
 268  -- Function File:  dateaxis (AX)
 269  -- Function File:  dateaxis (AX, DATEFORM)
 270  -- Function File:  dateaxis (AX, DATEFORM, STARTDATE)
 271  -- Function File:  dateaxis (H, ...)
 272      Convert the current axis tick labels (or the axis handle H) to a
 273      date format.  The axis given by AX ("x", "y", or "z") will be
 274      changed; the default is "x".  The date format, DATEFORM, used will
 275      be either auto-determined or an integer corresponding to the date
 276      formats in datestr. If STARTDATE is given, then the first tick
 277      value on the given axis is assumed to be that date.
 278
 279      See also: bolling, candle, highlow, movavg, pointfig
 280
 281
 282
 283
 284
 285 # name: <cell-element>
 286 # type: sq_string
 287 # elements: 1
 288 # length: 77
 289 Convert the current axis tick labels (or the axis handle H) to a date
 290 format.
 291
 292
 293
 294 # name: <cell-element>
 295 # type: sq_string
 296 # elements: 1
 297 # length: 8
 298 datefind
 299
 300
 301 # name: <cell-element>
 302 # type: sq_string
 303 # elements: 1
 304 # length: 203
 305  -- Function File: indices = datefind (subset, superset, tol)
 306      Find any instances of the `subset' in the `superset' with the
 307      `tol'erance.  `tol' is 0 by default.
 308
 309      See also: date, datenum
 310
 311
 312
 313
 314
 315 # name: <cell-element>
 316 # type: sq_string
 317 # elements: 1
 318 # length: 74
 319 Find any instances of the `subset' in the `superset' with the
 320 `tol'erance.
 321
 322
 323
 324 # name: <cell-element>
 325 # type: sq_string
 326 # elements: 1
 327 # length: 9
 328 datesplit
 329
 330
 331 # name: <cell-element>
 332 # type: sq_string
 333 # elements: 1
 334 # length: 3210
 335  -- Function File: Y = datesplit(date, P)
 336  -- Function File: [Y,M,D,h,m,s] = datesplit(date, P)
 337      Split a date string into the Year, Month, Day, hour, minute, and
 338      second.  This routine tries to be as forgiving as possible to the
 339      date input while requiring that the date is not ambiguous.
 340
 341      Anywhere possible where it would not be ambiguous, efforts were
 342      made to make times possible with seconds and AM/PM as optional.
 343      Also, along the same lines, where possible, commas were allowed
 344      with spaces, and the year/month/day separators were allowed as
 345      period (.), slash (/), and dash (-).  Not all format possibilities
 346      are shown in the following table, but a date like `dd-mmm-yyyy
 347      HH:MM:SS' is parsed just as well as `d/mmm.yyyy,  ,H:MM, AM'.
 348
 349      Supported `date' formats include (the same as datestr):
 350      *Code*  *Format*                       *Example*
 351      0       dd-mmm-yyyy HH:MM:SS           07-Sep-2000 15:38:09
 352      1       dd-mmm-yyyy                    07-Sep-2000
 353      2       mm/dd/yy                       09/07/00
 354      3       mmm                            Sep
 355      6       mm/dd                          09/13
 356      10      yyyy                           2000
 357      12      mmmyy                          Sep00
 358      13      HH:MM:SS                       15:38:09
 359      14      HH:MM:SS PM                    03:38:09 PM
 360      15      HH:MM                          15:38
 361      16      HH:MM PM                       03:38 PM
 362      17      QQ-YY                          Q3-00
 363      19      dd/mm                          13/03
 364      20      dd/mm/yy                       13/03/95
 365      21      mmm.dd.yyyy HH:MM:SS           Mar.03.1962 13:53:06
 366      22      mmm.dd.yyyy                    Mar.03.1962
 367      23      mm/dd/yyyy                     03/13/1962
 368      24      dd/mm/yyyy                     12/03/1962
 369      25      yy/mm/dd                       95/03/13
 370      26      yyyy/mm/dd                     1995/03/13
 371      27      QQ-YYYY                        Q4-2132
 372      28      mmmyyyy                        Mar2047
 373      29      yyyymmdd                       20470313
 374      30      yyyymmddTHHMMSS                20470313T132603
 375      31      yyyy-mm-dd HH:MM:SS            1047-03-13 13:26:03
 376
 377      The parameter `P' is needed to convert date strings with 2 digit
 378      years into dates with 4 digit years.  2 digit years are assumed to
 379      be between `P' and `P+99'. If `P' is not given then the current
 380      year - 50 is used, so that dates are centered on the present.  For
 381      birthdates, you would want `P' to be current year - 99.  For
 382      appointments, you would want `P' to be current year.
 383
 384      This function makes no strong attempt to verify the accuracy of the
 385      numbers that it returns in that it doesn't (currently) check to see
 386      that you're not trying to use the date Feb 30.  When applicable, it
 387      tries to make your input work, though.  It will try to determine if
 388      you're using the date "03/13/95" that the date is "March 13, 1995",
 389      but if there is doubt, datesplit will return an error instead of
 390      trying to guess the wrong value.
 391
 392      See also: date, clock, now, datestr, datenum, calendar, weekday
 393
 394
 395
 396
 397
 398 # name: <cell-element>
 399 # type: sq_string
 400 # elements: 1
 401 # length: 72
 402 Split a date string into the Year, Month, Day, hour, minute, and
 403 second.
 404
 405
 406
 407 # name: <cell-element>
 408 # type: sq_string
 409 # elements: 1
 410 # length: 3
 411 day
 412
 413
 414 # name: <cell-element>
 415 # type: sq_string
 416 # elements: 1
 417 # length: 169
 418  -- Function File: dom = day (Date)
 419      Returns the day of the month from a serial date number or a date
 420      string.
 421
 422      See also: date, datevec, now, month, year
 423
 424
 425
 426
 427
 428 # name: <cell-element>
 429 # type: sq_string
 430 # elements: 1
 431 # length: 72
 432 Returns the day of the month from a serial date number or a date string.
 433
 434
 435
 436 # name: <cell-element>
 437 # type: sq_string
 438 # elements: 1
 439 # length: 7
 440 daysact
 441
 442
 443 # name: <cell-element>
 444 # type: sq_string
 445 # elements: 1
 446 # length: 578
 447  -- Function File:  daysact (D1)
 448  -- Function File:  daysact (D1, D2)
 449      Calculates the number of days between two dates. If the second
 450      date is not given, calculate the number of days since 1-Jan-0000.
 451      The variables D1 and D2 can either be strings or an N-row string
 452      matrix. If both D1 and D2 are string matrices, then the number of
 453      rows must match. An example of the use of `daysact' is
 454
 455           daysact ("01-Jan-2007", ["10-Jan-2007"; "23-Feb-2007"; "23-Jul-2007"])
 456           =>      9
 457                  53
 458                 203
 459
 460      See also: datenum
 461
 462
 463
 464
 465
 466 # name: <cell-element>
 467 # type: sq_string
 468 # elements: 1
 469 # length: 48
 470 Calculates the number of days between two dates.
 471
 472
 473
 474 # name: <cell-element>
 475 # type: sq_string
 476 # elements: 1
 477 # length: 6
 478 easter
 479
 480
 481 # name: <cell-element>
 482 # type: sq_string
 483 # elements: 1
 484 # length: 211
 485  -- Function File: [m, d] = easter (y)
 486  -- Function File: datenum = easter (y)
 487      Return the month (M) and day (D) of Easter in the Gregorial
 488      calendar on a given year or years.
 489
 490      See also: holidays
 491
 492
 493
 494
 495
 496 # name: <cell-element>
 497 # type: sq_string
 498 # elements: 1
 499 # length: 80
 500 Return the month (M) and day (D) of Easter in the Gregorial calendar on
 501 a given
 502
 503
 504
 505 # name: <cell-element>
 506 # type: sq_string
 507 # elements: 1
 508 # length: 5
 509 effrr
 510
 511
 512 # name: <cell-element>
 513 # type: sq_string
 514 # elements: 1
 515 # length: 191
 516  -- Function File: RETURN = effrr (RATE, NUMPERIODS)
 517      Compute the effective rate of return based on a nominal RATE over
 518      a number of periods, NUMPERIODS.
 519
 520      See also: irr, nomrr
 521
 522
 523
 524
 525
 526 # name: <cell-element>
 527 # type: sq_string
 528 # elements: 1
 529 # length: 80
 530 Compute the effective rate of return based on a nominal RATE over a
 531 number of pe
 532
 533
 534
 535 # name: <cell-element>
 536 # type: sq_string
 537 # elements: 1
 538 # length: 7
 539 eomdate
 540
 541
 542 # name: <cell-element>
 543 # type: sq_string
 544 # elements: 1
 545 # length: 169
 546  -- Function File: E = eomdate (Y, M)
 547      Return the last day of the month M for the year Y in datenum
 548      format.
 549
 550      See also: datenum, datevec, weekday, eomday
 551
 552
 553
 554
 555
 556 # name: <cell-element>
 557 # type: sq_string
 558 # elements: 1
 559 # length: 68
 560 Return the last day of the month M for the year Y in datenum format.
 561
 562
 563
 564 # name: <cell-element>
 565 # type: sq_string
 566 # elements: 1
 567 # length: 8
 568 fbusdate
 569
 570
 571 # name: <cell-element>
 572 # type: sq_string
 573 # elements: 1
 574 # length: 679
 575  -- Function File: b = fbusdate (year, month)
 576  -- Function File: b = fbusdate (year, month, holiday)
 577  -- Function File: b = fbusdate (year, month, holiday, weekend)
 578      Return the datenum of the first business day of the YEAR and
 579      MONTH.  HOLIDAY is a vector of datenums that defines the holidays
 580      observed (the holidays function is used if not given).  WEEKEND
 581      defines the days of the week that should be considered weekends;
 582      [1 0 0 0 0 0 1] (default) indicates that Sunday and Saturday are
 583      holidays.
 584
 585      If any of the optional inputs (HOLIDAY, WEEKEND) are empty, then
 586      the default is used.
 587
 588      See also: holidays, lbusdate, isbusday, busdate
 589
 590
 591
 592
 593
 594 # name: <cell-element>
 595 # type: sq_string
 596 # elements: 1
 597 # length: 67
 598 Return the datenum of the first business day of the YEAR and MONTH.
 599
 600
 601
 602 # name: <cell-element>
 603 # type: sq_string
 604 # elements: 1
 605 # length: 5
 606 fetch
 607
 608
 609 # name: <cell-element>
 610 # type: sq_string
 611 # elements: 1
 612 # length: 1237
 613  -- DATA =: fetch (CONN, SYMBOL)
 614  -- DATA =: fetch (..., FIELDS)
 615  -- DATA =: fetch (..., DATE)
 616  -- DATA =: fetch (..., FROMDATE, TODATE)
 617  -- DATA =: fetch (..., PERIOD)
 618  -- [DATA, FIELDS] =: fetch (...)
 619      Download stock data from a connection.
 620
 621      FIELDS are the data fields to download and must come from the set
 622         * "Symbol"
 623
 624         * "Last"
 625
 626         * "Date"
 627
 628         * "Time"
 629
 630         * "Change"
 631
 632         * "Open"
 633
 634         * "High",
 635
 636         * "Low"
 637
 638         * "Volume"
 639
 640      As an output, FIELDS may be different than your request.  This is
 641      because there is mapping of field names from the data source to
 642      the output, and what is returned is the source mapping to allow
 643      validation.
 644
 645      DATE is the date string or datenum for the requested data.  If you
 646      enter today's date, you will get yesterday's data. FROMDATE and
 647      TODATE allow you to specify a date range for the data.
 648
 649      PERIOD (default: "d") allows you to select the period for the data
 650      which can be any of the below as long as they are supported by the
 651      associated backend.
 652         * 'd': daily
 653
 654         * 'w': weekly
 655
 656         * 'm': monthly (Yahoo only)
 657
 658         * 'v': dividends (Yahoo only)
 659
 660      See also: yahoo, google
 661
 662
 663
 664
 665
 666 # name: <cell-element>
 667 # type: sq_string
 668 # elements: 1
 669 # length: 38
 670 Download stock data from a connection.
 671
 672
 673
 674 # name: <cell-element>
 675 # type: sq_string
 676 # elements: 1
 677 # length: 2
 678 fv
 679
 680
 681 # name: <cell-element>
 682 # type: sq_string
 683 # elements: 1
 684 # length: 551
 685  -- Function File:  fv (R, N, P, L, METHOD)
 686      Return the future value at the end of period N of an investment
 687      which consists of N payments of P in each period, assuming an
 688      interest rate R.
 689
 690      The optional argument L may be used to specify an additional
 691      lump-sum payment.
 692
 693      The optional argument METHOD may be used to specify whether the
 694      payments are made at the end (`"e"', default) or at the beginning
 695      (`"b"') of each period.
 696
 697      Note that the rate R is specified as a fraction (i.e., 0.05, not 5
 698      percent).
 699
 700
 701
 702
 703 # name: <cell-element>
 704 # type: sq_string
 705 # elements: 1
 706 # length: 80
 707 Return the future value at the end of period N of an investment which
 708 consists o
 709
 710
 711
 712 # name: <cell-element>
 713 # type: sq_string
 714 # elements: 1
 715 # length: 3
 716 fvl
 717
 718
 719 # name: <cell-element>
 720 # type: sq_string
 721 # elements: 1
 722 # length: 254
 723  -- Function File:  fvl (R, N, L)
 724      Return the future value at the end of N periods of an initial lump
 725      sum investment L, given a per-period interest rate R.
 726
 727      Note that the rate R is specified as a fraction (i.e., 0.05, not 5
 728      percent).
 729
 730
 731
 732
 733 # name: <cell-element>
 734 # type: sq_string
 735 # elements: 1
 736 # length: 80
 737 Return the future value at the end of N periods of an initial lump sum
 738 investmen
 739
 740
 741
 742 # name: <cell-element>
 743 # type: sq_string
 744 # elements: 1
 745 # length: 6
 746 google
 747
 748
 749 # name: <cell-element>
 750 # type: sq_string
 751 # elements: 1
 752 # length: 414
 753  -- Function File: CONN = google ()
 754  -- Function File: CONN = google (URL, IPADDRESS, PORT)
 755      Prepare a Google connection for the fetch command to get Google
 756      historical quote data.
 757
 758      If given, the URL must be "http://finance.google.com".  The
 759      IPADDRESS and PORT is the proxy ipaddress and port. These
 760      parameters are currently ignored (with a warning if given).
 761
 762      See also: fetch, yahoo
 763
 764
 765
 766
 767
 768 # name: <cell-element>
 769 # type: sq_string
 770 # elements: 1
 771 # length: 80
 772 Prepare a Google connection for the fetch command to get Google
 773 historical quote
 774
 775
 776
 777 # name: <cell-element>
 778 # type: sq_string
 779 # elements: 1
 780 # length: 5
 781 hhigh
 782
 783
 784 # name: <cell-element>
 785 # type: sq_string
 786 # elements: 1
 787 # length: 287
 788  -- Function File: HHV = hhigh (DATA)
 789  -- Function File: HHV = hhigh (DATA, NPERIODS)
 790  -- Function File: HHV = hhigh (DATA, NPERIODS, DIM)
 791      Compute the highest high value of DATA for the past NPERIODS
 792      (default: 14) across the dimension, DIM (default: 1).
 793
 794      See also: llow
 795
 796
 797
 798
 799
 800 # name: <cell-element>
 801 # type: sq_string
 802 # elements: 1
 803 # length: 80
 804 Compute the highest high value of DATA for the past NPERIODS (default:
 805 14) acros
 806
 807
 808
 809 # name: <cell-element>
 810 # type: sq_string
 811 # elements: 1
 812 # length: 7
 813 highlow
 814
 815
 816 # name: <cell-element>
 817 # type: sq_string
 818 # elements: 1
 819 # length: 471
 820  -- Function File: H = highlow (HIGH, LOW, CLOSE)
 821  -- Function File: H = highlow (HIGH, LOW, CLOSE, OPEN)
 822  -- Function File: H = highlow (HIGH, LOW, CLOSE, OPEN, COLOR)
 823      Plot the HIGH, LOW, and CLOSE of a security.  The CLOSE is plotted
 824      as a tick to the right, and if OPEN is given and non-empty, it is
 825      plotted as a tick to the left.  The color can override the default
 826      color for the plot.
 827
 828      See also: bolling, candle, dateaxis, movavg, pointfig
 829
 830
 831
 832
 833
 834 # name: <cell-element>
 835 # type: sq_string
 836 # elements: 1
 837 # length: 44
 838 Plot the HIGH, LOW, and CLOSE of a security.
 839
 840
 841
 842 # name: <cell-element>
 843 # type: sq_string
 844 # elements: 1
 845 # length: 8
 846 holidays
 847
 848
 849 # name: <cell-element>
 850 # type: sq_string
 851 # elements: 1
 852 # length: 586
 853  -- Function File: h = holidays (startdate, enddate)
 854      Return a vector of datenums that were holidays between STARTDATE
 855      and ENDDATE, inclusive.  These holidays are trading holidays
 856      observed by the NYSE according to its rule 51.10. It does not take
 857      into account the exceptions for "unusual business conditions" or
 858      for additional days that have been called as holidays for one-time
 859      purposes.
 860
 861      The complete list can be found at
 862      http://www.chronos-st.org/NYSE_Observed_Holidays-1885-Present.html
 863
 864      See also: busdate, lbusdate, isbusday, fbusdate
 865
 866
 867
 868
 869
 870 # name: <cell-element>
 871 # type: sq_string
 872 # elements: 1
 873 # length: 80
 874 Return a vector of datenums that were holidays between STARTDATE and
 875 ENDDATE, in
 876
 877
 878
 879 # name: <cell-element>
 880 # type: sq_string
 881 # elements: 1
 882 # length: 4
 883 hour
 884
 885
 886 # name: <cell-element>
 887 # type: sq_string
 888 # elements: 1
 889 # length: 154
 890  -- Function File: h = hour (Date)
 891      Returns the hour from a serial date number or a date string.
 892
 893      See also: date, datevec, now, minute, second
 894
 895
 896
 897
 898
 899 # name: <cell-element>
 900 # type: sq_string
 901 # elements: 1
 902 # length: 60
 903 Returns the hour from a serial date number or a date string.
 904
 905
 906
 907 # name: <cell-element>
 908 # type: sq_string
 909 # elements: 1
 910 # length: 3
 911 irr
 912
 913
 914 # name: <cell-element>
 915 # type: sq_string
 916 # elements: 1
 917 # length: 266
 918  -- Function File:  irr (P, I)
 919      Return the internal rate of return of a series of payments P from
 920      an initial investment I (i.e., the solution of `npv (r, p) = i'.
 921      If the second argument is omitted, a value of 0 is used.
 922
 923      See also: npv, pv, rate
 924
 925
 926
 927
 928
 929 # name: <cell-element>
 930 # type: sq_string
 931 # elements: 1
 932 # length: 80
 933 Return the internal rate of return of a series of payments P from an
 934 initial inv
 935
 936
 937
 938 # name: <cell-element>
 939 # type: sq_string
 940 # elements: 1
 941 # length: 8
 942 isbusday
 943
 944
 945 # name: <cell-element>
 946 # type: sq_string
 947 # elements: 1
 948 # length: 551
 949  -- Function File: r = isbusday (refdate)
 950  -- Function File: r = isbusday (refdate, holiday)
 951  -- Function File: r = isbusday (refdate, holiday, weekend)
 952      Return true if the REFDATE is a business date REFDATE.  HOLIDAY is
 953      a vector of datenums that defines the holidays observed (the
 954      holidays function is used if not given). WEEKEND defines the days
 955      of the week that should be considered weekends; [1 0 0 0 0 0 1]
 956      (default) indicates that Sunday and Saturday are weekends.
 957
 958      See also: holidays, lbusdate, busdate, fbusdate
 959
 960
 961
 962
 963
 964 # name: <cell-element>
 965 # type: sq_string
 966 # elements: 1
 967 # length: 54
 968 Return true if the REFDATE is a business date REFDATE.
 969
 970
 971
 972 # name: <cell-element>
 973 # type: sq_string
 974 # elements: 1
 975 # length: 8
 976 lbusdate
 977
 978
 979 # name: <cell-element>
 980 # type: sq_string
 981 # elements: 1
 982 # length: 672
 983  -- Function File: b = lbusdate (year, month)
 984  -- Function File: b = lbusdate (year, month, holiday)
 985  -- Function File: b = lbusdate (year, month, holiday, weekend)
 986      Return the datenum of the last business day of the YEAR and MONTH.
 987      HOLIDAY is a vector of datenums that defines the holidays observed
 988      (the holidays function is used if not given).  WEEKEND defines the
 989      days of the week that should be considered weekends; [1 0 0 0 0 0
 990      1] (default) indicates that Sunday and Saturday are holidays.
 991
 992      If any of the optional inputs (HOLIDAY, WEEKEND) are empty, then
 993      the default is used.
 994
 995      See also: holidays, fbusdate, isbusday, busdate
 996
 997
 998
 999
1000
1001 # name: <cell-element>
1002 # type: sq_string
1003 # elements: 1
1004 # length: 66
1005 Return the datenum of the last business day of the YEAR and MONTH.
1006
1007
1008
1009 # name: <cell-element>
1010 # type: sq_string
1011 # elements: 1
1012 # length: 4
1013 llow
1014
1015
1016 # name: <cell-element>
1017 # type: sq_string
1018 # elements: 1
1019 # length: 283
1020  -- Function File: LLV = llow (DATA)
1021  -- Function File: LLV = llow (DATA, NPERIODS)
1022  -- Function File: LLV = llow (DATA, NPERIODS, DIM)
1023      Compute the lowest low value of DATA for the past NPERIODS
1024      (default: 14) across the dimension, DIM (default: 1).
1025
1026      See also: hhigh
1027
1028
1029
1030
1031
1032 # name: <cell-element>
1033 # type: sq_string
1034 # elements: 1
1035 # length: 80
1036 Compute the lowest low value of DATA for the past NPERIODS (default:
1037 14) across
1038
1039
1040
1041 # name: <cell-element>
1042 # type: sq_string
1043 # elements: 1
1044 # length: 9
1045 lweekdate
1046
1047
1048 # name: <cell-element>
1049 # type: sq_string
1050 # elements: 1
1051 # length: 277
1052  -- Function File: last = lweekdate (weekday, year, month, nextday)
1053      Returns the last occurrence of WEEKDAY from the MONTH and YEAR.
1054      If the optional NEXTDAY argument is given, then the week must also
1055      contain NEXTDAY.
1056
1057      See also: eomdate, nweekdate, weekday
1058
1059
1060
1061
1062
1063 # name: <cell-element>
1064 # type: sq_string
1065 # elements: 1
1066 # length: 63
1067 Returns the last occurrence of WEEKDAY from the MONTH and YEAR.
1068
1069
1070
1071 # name: <cell-element>
1072 # type: sq_string
1073 # elements: 1
1074 # length: 7
1075 m2xdate
1076
1077
1078 # name: <cell-element>
1079 # type: sq_string
1080 # elements: 1
1081 # length: 966
1082  -- Function File: exceldatenums = m2xdate (datenums)
1083  -- Function File: exceldatenums = m2xdate (datenums, convention)
1084  -- Function File: exceldatenums = m2xdate (datenums, convention,
1085           "ExcelBug")
1086      Convert DATENUMS from the internal date format to the format used
1087      by Microsoft Excel.  If set to 0 (default, Excel for Windows),
1088      CONVENTION specifies to use the Excel 1900 convention where Jan 1,
1089      1900 corresponds to Excel serial date number 1.  If set to 1
1090      (Excel for Mac), CONVENTION specifies to use the Excel 1904
1091      convention where Jan 1, 1904 corresponds to Excel serial date
1092      number 0.
1093
1094      Note that this does not take into account the Excel bug where 1900
1095      is considered to be a leap year unless you give the "ExcelBug"
1096      option.
1097
1098      Excel does not represent dates prior to 1 January 1900 using this
1099      format, so a warning will be issued if any dates preceed this date.
1100
1101      See also: datenum, x2mdate
1102
1103
1104
1105
1106
1107 # name: <cell-element>
1108 # type: sq_string
1109 # elements: 1
1110 # length: 80
1111 Convert DATENUMS from the internal date format to the format used by
1112 Microsoft E
1113
1114
1115
1116 # name: <cell-element>
1117 # type: sq_string
1118 # elements: 1
1119 # length: 6
1120 minute
1121
1122
1123 # name: <cell-element>
1124 # type: sq_string
1125 # elements: 1
1126 # length: 156
1127  -- Function File: m = minute (Date)
1128      Returns the minute from a serial date number or a date string.
1129
1130      See also: date, datevec, now, hour, second
1131
1132
1133
1134
1135
1136 # name: <cell-element>
1137 # type: sq_string
1138 # elements: 1
1139 # length: 62
1140 Returns the minute from a serial date number or a date string.
1141
1142
1143
1144 # name: <cell-element>
1145 # type: sq_string
1146 # elements: 1
1147 # length: 4
1148 mirr
1149
1150
1151 # name: <cell-element>
1152 # type: sq_string
1153 # elements: 1
1154 # length: 338
1155  -- Function File: RETURN = mirr (CASHFLOW, FINRATE, REINVESTRATE)
1156      Compute the modified internal rate of return.  Take periodic
1157      CASHFLOWs as a vector and the finance rate, FINRATE, for negative
1158      cash flows and a reinvestment rate, REINVESTRATE, for positive
1159      cash flows.
1160
1161      See also: irr, effrr, nomrr, pvvar, xirr
1162
1163
1164
1165
1166
1167 # name: <cell-element>
1168 # type: sq_string
1169 # elements: 1
1170 # length: 45
1171 Compute the modified internal rate of return.
1172
1173
1174
1175 # name: <cell-element>
1176 # type: sq_string
1177 # elements: 1
1178 # length: 5
1179 month
1180
1181
1182 # name: <cell-element>
1183 # type: sq_string
1184 # elements: 1
1185 # length: 169
1186  -- Function File: mon = month (Date)
1187      Returns the day of the month from a serial date number or a date
1188      string.
1189
1190      See also: date, datevec, now, day, year
1191
1192
1193
1194
1195
1196 # name: <cell-element>
1197 # type: sq_string
1198 # elements: 1
1199 # length: 72
1200 Returns the day of the month from a serial date number or a date string.
1201
1202
1203
1204 # name: <cell-element>
1205 # type: sq_string
1206 # elements: 1
1207 # length: 6
1208 months
1209
1210
1211 # name: <cell-element>
1212 # type: sq_string
1213 # elements: 1
1214 # length: 514
1215  -- Function File: mos = months (startdate, enddate)
1216  -- Function File: mos = months (startdate, enddate, endmonthflag)
1217      Return the number of whole months between STARTDATE and ENDDATE.
1218      ENDMONTHFLAG defaults to 1.
1219
1220      If ENDMONTHFLAG is true, then if both the STARTDATE and the
1221      ENDDATE are end of month dates and ENDDATE has fewer days in the
1222      month than STARTDATE, ENDMONTHFLAG = 1 treats ENDDATE as the end
1223      of a month, but ENDMONTHFLAG = 0 does not.
1224
1225      See also: yeardays, yearfrac
1226
1227
1228
1229
1230
1231 # name: <cell-element>
1232 # type: sq_string
1233 # elements: 1
1234 # length: 64
1235 Return the number of whole months between STARTDATE and ENDDATE.
1236
1237
1238
1239 # name: <cell-element>
1240 # type: sq_string
1241 # elements: 1
1242 # length: 6
1243 movavg
1244
1245
1246 # name: <cell-element>
1247 # type: sq_string
1248 # elements: 1
1249 # length: 726
1250  -- Function File:  movavg (ASSET, LEAD, LAG)
1251  -- Function File:  movavg (ASSET, LEAD, LAG, ALPHA)
1252  -- Function File: [SHORT, LONG] = movavg (ASSET, LEAD, LAG, ALPHA)
1253      Calculate the LEADing and LAGging moving average of an ASSET. If
1254      given, ALPHA is the weighting power of the delay; 0 (default) is
1255      the simple moving average, 0.5 would be the square root weighted
1256      moving average, 1 would be linear, 2 would be squared, ..., and
1257      'e' is the exponential moving average.
1258
1259      If no output is requested the data is plotted.  The plots are drawn
1260      in the following order: asset, lag, lead.  If output is requested,
1261      no plot is generated.
1262
1263      See also: bolling, candle, dateaxis, highlow, pointfig
1264
1265
1266
1267
1268
1269 # name: <cell-element>
1270 # type: sq_string
1271 # elements: 1
1272 # length: 61
1273 Calculate the LEADing and LAGging moving average of an ASSET.
1274
1275
1276
1277 # name: <cell-element>
1278 # type: sq_string
1279 # elements: 1
1280 # length: 9
1281 negvolidx
1282
1283
1284 # name: <cell-element>
1285 # type: sq_string
1286 # elements: 1
1287 # length: 570
1288  -- Function File: NVI = negvolidx (CLOSEPRICE, VOL)
1289  -- Function File: NVI = negvolidx ([CLOSEPRICE VOL])
1290  -- Function File: NVI = negvolidx (CLOSEPRICE, VOL, INITNVI)
1291  -- Function File: NVI = negvolidx ([CLOSEPRICE VOL], INITNVI)
1292      Compute the negative volume index of a security based on its
1293      closing price (CLOSEPRICE) and VOLume.  They may be given as
1294      separate arguments or as an nx2 matrix.  If given, the INITNVI is
1295      the starting value of the nvi (default: 100).
1296
1297      The NVI will always be a column vector.
1298
1299      See also: onbalvol, posvolidx
1300
1301
1302
1303
1304
1305 # name: <cell-element>
1306 # type: sq_string
1307 # elements: 1
1308 # length: 80
1309 Compute the negative volume index of a security based on its closing
1310 price (CLOS
1311
1312
1313
1314 # name: <cell-element>
1315 # type: sq_string
1316 # elements: 1
1317 # length: 5
1318 nomrr
1319
1320
1321 # name: <cell-element>
1322 # type: sq_string
1323 # elements: 1
1324 # length: 191
1325  -- Function File: RETURN = nomrr (RATE, NUMPERIODS)
1326      Compute the nominal rate of return based on a effective RATE over
1327      a number of periods, NUMPERIODS.
1328
1329      See also: irr, effrr
1330
1331
1332
1333
1334
1335 # name: <cell-element>
1336 # type: sq_string
1337 # elements: 1
1338 # length: 80
1339 Compute the nominal rate of return based on a effective RATE over a
1340 number of pe
1341
1342
1343
1344 # name: <cell-element>
1345 # type: sq_string
1346 # elements: 1
1347 # length: 4
1348 nper
1349
1350
1351 # name: <cell-element>
1352 # type: sq_string
1353 # elements: 1
1354 # length: 579
1355  -- Function File:  nper (R, P, A, L, METHOD)
1356      Return the number of regular payments of P necessary to amortize A
1357      loan of amount A and interest R.
1358
1359      The optional argument L may be used to specify an additional
1360      lump-sum payment of L made at the end of the amortization time.
1361
1362      The optional argument METHOD may be used to specify whether
1363      payments are made at the end ("E", default) or at the beginning
1364      ("B") of each period.
1365
1366      Note that the rate R is specified as a fraction (i.e., 0.05, not 5
1367      percent).
1368
1369      See also: pv, pmt, rate, npv
1370
1371
1372
1373
1374
1375 # name: <cell-element>
1376 # type: sq_string
1377 # elements: 1
1378 # length: 80
1379 Return the number of regular payments of P necessary to amortize A loan
1380 of amoun
1381
1382
1383
1384 # name: <cell-element>
1385 # type: sq_string
1386 # elements: 1
1387 # length: 3
1388 npv
1389
1390
1391 # name: <cell-element>
1392 # type: sq_string
1393 # elements: 1
1394 # length: 577
1395  -- Function File:  npv (R, P, I)
1396      Net present value of a series of payments.
1397
1398      Returns the net present value of a series of irregular (i.e., not
1399      necessarily identical) payments P which occur at the ends of N
1400      consecutive periods.  R specifies the one-period interest rates and
1401      can either be a scalar (constant rates) or a vector of the same
1402      length as P.
1403
1404      The optional argument I may be used to specify an initial
1405      investment.
1406
1407      Note that the rate R is specified as a fraction (i.e., 0.05, not 5
1408      percent).
1409
1410      See also: irr, pv
1411
1412
1413
1414
1415
1416 # name: <cell-element>
1417 # type: sq_string
1418 # elements: 1
1419 # length: 42
1420 Net present value of a series of payments.
1421
1422
1423
1424 # name: <cell-element>
1425 # type: sq_string
1426 # elements: 1
1427 # length: 9
1428 nweekdate
1429
1430
1431 # name: <cell-element>
1432 # type: sq_string
1433 # elements: 1
1434 # length: 374
1435  -- Function File: last = nweekdate (n, weekday, year, month, nextday)
1436      Returns the Nth occurrence of WEEKDAY from the MONTH and YEAR.  If
1437      the optional NEXTDAY argument is given, then the week must also
1438      contain NEXTDAY.  If N is greater than the number of occurrences
1439      of that day in the month, 0 is returned.
1440
1441      See also: eomdate, lweekdate, weekday
1442
1443
1444
1445
1446
1447 # name: <cell-element>
1448 # type: sq_string
1449 # elements: 1
1450 # length: 62
1451 Returns the Nth occurrence of WEEKDAY from the MONTH and YEAR.
1452
1453
1454
1455 # name: <cell-element>
1456 # type: sq_string
1457 # elements: 1
1458 # length: 8
1459 onbalvol
1460
1461
1462 # name: <cell-element>
1463 # type: sq_string
1464 # elements: 1
1465 # length: 412
1466  -- Function File: OBV = onbalvol (CLOSEPRICE, VOL)
1467  -- Function File: OBV = onbalvol ([CLOSEPRICE VOL])
1468      Compute the on balance volume of a security based on its closing
1469      price (CLOSEPRICE) and VOLume.  They may be given as separate
1470      arguments or as an nx2 matrix.
1471
1472      The output will be a column vector, and the first number in the
1473      output is always 0.
1474
1475      See also: negvolidx, posvolidx
1476
1477
1478
1479
1480
1481 # name: <cell-element>
1482 # type: sq_string
1483 # elements: 1
1484 # length: 80
1485 Compute the on balance volume of a security based on its closing price
1486 (CLOSEPRI
1487
1488
1489
1490 # name: <cell-element>
1491 # type: sq_string
1492 # elements: 1
1493 # length: 3
1494 pmt
1495
1496
1497 # name: <cell-element>
1498 # type: sq_string
1499 # elements: 1
1500 # length: 451
1501  -- Function File:  pmt (R, N, A, L, METHOD)
1502      Return the amount of periodic payment necessary to amortize a loan
1503      of amount a with interest rate R in N periods.
1504
1505      The optional argument L may be used to specify a terminal lump-sum
1506      payment.
1507
1508      The optional argument METHOD may be used to specify whether
1509      payments are made at the end ("E", default) or at the beginning
1510      ("B") of each period.
1511
1512      See also: pv, nper, rate
1513
1514
1515
1516
1517
1518 # name: <cell-element>
1519 # type: sq_string
1520 # elements: 1
1521 # length: 80
1522 Return the amount of periodic payment necessary to amortize a loan of
1523 amount a w
1524
1525
1526
1527 # name: <cell-element>
1528 # type: sq_string
1529 # elements: 1
1530 # length: 8
1531 pointfig
1532
1533
1534 # name: <cell-element>
1535 # type: sq_string
1536 # elements: 1
1537 # length: 233
1538  -- Function File:  pointfig (ASSET)
1539      Plot the point figure chart of an ASSET.  Upward price movements
1540      are plotted as Xs and downward movements are plotted as Os.
1541
1542      See also: bolling, candle, dateaxis, highlow, movavg
1543
1544
1545
1546
1547
1548 # name: <cell-element>
1549 # type: sq_string
1550 # elements: 1
1551 # length: 40
1552 Plot the point figure chart of an ASSET.
1553
1554
1555
1556 # name: <cell-element>
1557 # type: sq_string
1558 # elements: 1
1559 # length: 9
1560 posvolidx
1561
1562
1563 # name: <cell-element>
1564 # type: sq_string
1565 # elements: 1
1566 # length: 570
1567  -- Function File: PVI = posvolidx (CLOSEPRICE, VOL)
1568  -- Function File: PVI = posvolidx ([CLOSEPRICE VOL])
1569  -- Function File: PVI = posvolidx (CLOSEPRICE, VOL, INITPVI)
1570  -- Function File: PVI = posvolidx ([CLOSEPRICE VOL], INITPVI)
1571      Compute the positive volume index of a security based on its
1572      closing price (CLOSEPRICE) and VOLume.  They may be given as
1573      separate arguments or as an nx2 matrix.  If given, the INITPVI is
1574      the starting value of the pvi (default: 100).
1575
1576      The PVI will always be a column vector.
1577
1578      See also: onbalvol, negvolidx
1579
1580
1581
1582
1583
1584 # name: <cell-element>
1585 # type: sq_string
1586 # elements: 1
1587 # length: 80
1588 Compute the positive volume index of a security based on its closing
1589 price (CLOS
1590
1591
1592
1593 # name: <cell-element>
1594 # type: sq_string
1595 # elements: 1
1596 # length: 2
1597 pv
1598
1599
1600 # name: <cell-element>
1601 # type: sq_string
1602 # elements: 1
1603 # length: 580
1604  -- Function File:  pv (R, N, P, L, METHOD)
1605      Returns the present value of an investment that will pay off P for
1606      N consecutive periods, assuming an interest R.
1607
1608      The optional argument L may be used to specify an additional
1609      lump-sum payment made at the end of N periods.
1610
1611      The optional argument METHOD may be used to specify whether
1612      payments are made at the end (`"e"', default) or at the beginning
1613      (`"b"') of each period.
1614
1615      Note that the rate R is specified as a fraction (i.e., 0.05, not 5
1616      percent).
1617
1618      See also: pmt, nper, rate, npv
1619
1620
1621
1622
1623
1624 # name: <cell-element>
1625 # type: sq_string
1626 # elements: 1
1627 # length: 80
1628 Returns the present value of an investment that will pay off P for N
1629 consecutive
1630
1631
1632
1633 # name: <cell-element>
1634 # type: sq_string
1635 # elements: 1
1636 # length: 3
1637 pvl
1638
1639
1640 # name: <cell-element>
1641 # type: sq_string
1642 # elements: 1
1643 # length: 268
1644  -- Function File: V = pvl (R, N, P)
1645      Return the present value V of an investment that will pay off P in
1646      one lump sum at the end of N periods, given the interest rate R.
1647
1648      Note that the rate R is specified as a fraction (i.e., 0.05, not 5
1649      percent).
1650
1651
1652
1653
1654 # name: <cell-element>
1655 # type: sq_string
1656 # elements: 1
1657 # length: 80
1658 Return the present value V of an investment that will pay off P in one
1659 lump sum
1660
1661
1662
1663 # name: <cell-element>
1664 # type: sq_string
1665 # elements: 1
1666 # length: 4
1667 rate
1668
1669
1670 # name: <cell-element>
1671 # type: sq_string
1672 # elements: 1
1673 # length: 616
1674  -- Function File: R = rate (N, P, V)
1675  -- Function File: R = rate (N, P, V, L)
1676  -- Function File: R = rate (N, P, V, L, METHOD)
1677  -- Function File: R = rate (N, P, V, METHOD)
1678      Return the rate of return R on an investment of present value V
1679      which pays P in N consecutive periods.
1680
1681      The optional argument L may be used to specify an additional
1682      lump-sum payment made at the end of N periods.
1683
1684      The optional string argument METHOD may be used to specify whether
1685      payments are made at the end (`"e"', default) or at the beginning
1686      (`"b"') of each period.
1687
1688      See also: pv, pmt, nper, npv
1689
1690
1691
1692
1693
1694 # name: <cell-element>
1695 # type: sq_string
1696 # elements: 1
1697 # length: 80
1698 Return the rate of return R on an investment of present value V which
1699 pays P in
1700
1701
1702
1703 # name: <cell-element>
1704 # type: sq_string
1705 # elements: 1
1706 # length: 7
1707 rsindex
1708
1709
1710 # name: <cell-element>
1711 # type: sq_string
1712 # elements: 1
1713 # length: 408
1714  -- Function File: RSI = rsindex (CLOSEPRICE)
1715  -- Function File: RSI = rsindex (CLOSEPRICE, NPERIODS)
1716      Compute the relative strength index (RSI) of an asset from the
1717      vector of closing prices (CLOSEPRICE).  NPERIODS defines the
1718      number of periods that the rsi should be calculated for (default:
1719      14).
1720
1721      The beginning of the RSI is padded with nans to match the size of
1722      CLOSEPRICE.
1723
1724
1725
1726
1727
1728 # name: <cell-element>
1729 # type: sq_string
1730 # elements: 1
1731 # length: 80
1732 Compute the relative strength index (RSI) of an asset from the vector
1733 of closing
1734
1735
1736
1737 # name: <cell-element>
1738 # type: sq_string
1739 # elements: 1
1740 # length: 6
1741 second
1742
1743
1744 # name: <cell-element>
1745 # type: sq_string
1746 # elements: 1
1747 # length: 156
1748  -- Function File: s = second (Date)
1749      Returns the second from a serial date number or a date string.
1750
1751      See also: date, datevec, now, hour, minute
1752
1753
1754
1755
1756
1757 # name: <cell-element>
1758 # type: sq_string
1759 # elements: 1
1760 # length: 62
1761 Returns the second from a serial date number or a date string.
1762
1763
1764
1765 # name: <cell-element>
1766 # type: sq_string
1767 # elements: 1
1768 # length: 7
1769 taxedrr
1770
1771
1772 # name: <cell-element>
1773 # type: sq_string
1774 # elements: 1
1775 # length: 196
1776  -- Function File: RETURN = taxedrr (PRETAXRETURN, TAXRATE)
1777      Compute the taxed rate of RETURN based on a PRETAXRETURN rate and
1778      a TAXRATE.
1779
1780      See also: irr, effrr, nomrr, pvvar, xirr
1781
1782
1783
1784
1785
1786 # name: <cell-element>
1787 # type: sq_string
1788 # elements: 1
1789 # length: 76
1790 Compute the taxed rate of RETURN based on a PRETAXRETURN rate and a
1791 TAXRATE.
1792
1793
1794
1795 # name: <cell-element>
1796 # type: sq_string
1797 # elements: 1
1798 # length: 14
1799 thirdwednesday
1800
1801
1802 # name: <cell-element>
1803 # type: sq_string
1804 # elements: 1
1805 # length: 391
1806  -- Function File: [begindate, enddate] = thirdwednesday (month, year)
1807      Find the third Wednesday of the month specified by the MONTH and
1808      YEAR.  The BEGINDATE is the third Wednesday of the month, and the
1809      ENDDATE is three months after that.  Outputs are in the form of
1810      datenums.
1811
1812      The third Wednesday is used for Eurodollar futures.
1813
1814      See also: nweekdate, datenum
1815
1816
1817
1818
1819
1820 # name: <cell-element>
1821 # type: sq_string
1822 # elements: 1
1823 # length: 70
1824 Find the third Wednesday of the month specified by the MONTH and YEAR.
1825
1826
1827
1828 # name: <cell-element>
1829 # type: sq_string
1830 # elements: 1
1831 # length: 5
1832 today
1833
1834
1835 # name: <cell-element>
1836 # type: sq_string
1837 # elements: 1
1838 # length: 360
1839  -- Function File: datenum = today ()
1840      Returns the current local date as the number of days since Jan 1,
1841      0000.  By this reckoning, Jan 1, 1970 is day number 719529.
1842
1843      The returned number corresponds to 00:00:00 today.
1844
1845      The returned value is also called a "serial date number" (see
1846      `datenum').
1847
1848      See also: clock, date, datenum, now
1849
1850
1851
1852
1853
1854 # name: <cell-element>
1855 # type: sq_string
1856 # elements: 1
1857 # length: 71
1858 Returns the current local date as the number of days since Jan 1, 0000.
1859
1860
1861
1862 # name: <cell-element>
1863 # type: sq_string
1864 # elements: 1
1865 # length: 3
1866 vol
1867
1868
1869 # name: <cell-element>
1870 # type: sq_string
1871 # elements: 1
1872 # length: 477
1873  -- Function File: VOLAT = vol (X, M, N)
1874      Return the volatility VOLAT of each column of the input matrix X.
1875
1876      The number of data sets per period is given by M (e.g. the number
1877      of data per year if you want to compute the volatility per year).
1878      The optional parameter N gives the number of past periods used for
1879      computation, if it is omitted, a value of 1 is used.
1880
1881      If T is the number of rows of X, `vol' returns the volatility from
1882      `n*m' to T.
1883
1884
1885
1886
1887
1888 # name: <cell-element>
1889 # type: sq_string
1890 # elements: 1
1891 # length: 65
1892 Return the volatility VOLAT of each column of the input matrix X.
1893
1894
1895
1896 # name: <cell-element>
1897 # type: sq_string
1898 # elements: 1
1899 # length: 7
1900 x2mdate
1901
1902
1903 # name: <cell-element>
1904 # type: sq_string
1905 # elements: 1
1906 # length: 967
1907  -- Function File: datenums = x2mdate (exceldatenums)
1908  -- Function File: datenums = x2mdate (exceldatenums, convention)
1909  -- Function File: datenums = x2mdate (exceldatenums, convention,
1910           "ExcelBug")
1911      Convert DATENUMS from the Microsoft Excel date format to the
1912      format used by `datenum'.  If set to 0 (default, Excel for
1913      Windows), CONVENTION specifies to use the Excel 1900 convention
1914      where Jan 1, 1900 corresponds to Excel serial date number 1.  If
1915      set to 1 (Excel for Mac), CONVENTION specifies to use the Excel
1916      1904 convention where Jan 1, 1904 corresponds to Excel serial date
1917      number 0.
1918
1919      Note that this does not take into account the Excel bug where 1900
1920      is considered to be a leap year unless you give the "ExcelBug"
1921      option.
1922
1923      Excel does not represent dates prior to 1 January 1900 using this
1924      format, so a warning will be issued if any dates preceed this date.
1925
1926      See also: datenum, x2mdate
1927
1928
1929
1930
1931
1932 # name: <cell-element>
1933 # type: sq_string
1934 # elements: 1
1935 # length: 80
1936 Convert DATENUMS from the Microsoft Excel date format to the format
1937 used by `dat
1938
1939
1940
1941 # name: <cell-element>
1942 # type: sq_string
1943 # elements: 1
1944 # length: 5
1945 yahoo
1946
1947
1948 # name: <cell-element>
1949 # type: sq_string
1950 # elements: 1
1951 # length: 408
1952  -- Function File: CONN = yahoo ()
1953  -- Function File: CONN = yahoo (URL, IPADDRESS, PORT)
1954      Prepare a Yahoo connection for the fetch command to get Yahoo
1955      historical quote data.
1956
1957      If given, the URL must be "http://quote.yahoo.com".  The IPADDRESS
1958      and PORT is the proxy ipaddress and port. These parameters are
1959      currently ignored (with a warning if given).
1960
1961      See also: fetch, google
1962
1963
1964
1965
1966
1967 # name: <cell-element>
1968 # type: sq_string
1969 # elements: 1
1970 # length: 80
1971 Prepare a Yahoo connection for the fetch command to get Yahoo
1972 historical quote d
1973
1974
1975
1976 # name: <cell-element>
1977 # type: sq_string
1978 # elements: 1
1979 # length: 4
1980 year
1981
1982
1983 # name: <cell-element>
1984 # type: sq_string
1985 # elements: 1
1986 # length: 150
1987  -- Function File: y = year (Date)
1988      Returns the year from a serial date number or a date string.
1989
1990      See also: date, datevec, now, day, month
1991
1992
1993
1994
1995
1996 # name: <cell-element>
1997 # type: sq_string
1998 # elements: 1
1999 # length: 60
2000 Returns the year from a serial date number or a date string.
2001
2002
2003
2004 # name: <cell-element>
2005 # type: sq_string
2006 # elements: 1
2007 # length: 8
2008 yeardays
2009
2010
2011 # name: <cell-element>
2012 # type: sq_string
2013 # elements: 1
2014 # length: 596
2015  -- Function File: D = yeardays (Y)
2016  -- Function File: D = yeardays (Y, B)
2017      Return the number of days in the year Y with an optional basis B.
2018
2019      Valid bases
2020         * 0   actual/actual (default)
2021
2022         * 1   30/360 (SIA)
2023
2024         * 2   actual/360
2025
2026         * 3   actual/365
2027
2028         * 4   30/360 (PSA)
2029
2030         * 5   30/360 (IDSA)
2031
2032         * 6   30/360 (European)
2033
2034         * 7   actual/365 (Japanese)
2035
2036         * 8   actual/actual (ISMA)
2037
2038         * 9   actual/360 (ISMA)
2039
2040         * 10   actual/365 (ISMA)
2041
2042         * 11   30/360E (ISMA)
2043
2044      See also: days365, days360, daysact, daysdif
2045
2046
2047
2048
2049
2050 # name: <cell-element>
2051 # type: sq_string
2052 # elements: 1
2053 # length: 65
2054 Return the number of days in the year Y with an optional basis B.
2055
2056
2057
2058
2059