extra/math/finance/finance-docs.factor

   1 ! Copyright (C) 2008 John Benediktsson, Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license
   3 USING: help.markup help.syntax math ;
   4 IN: math.finance
   5
   6 HELP: sma
   7 { $values { "seq" "a sequence" } { "n" "number of periods" } { "newseq" "a sequence" } }
   8 { $description "Returns the Simple Moving Average with the specified periodicity." } ;
   9
  10 HELP: ema
  11 { $values { "seq" "a sequence" } { "n" "number of periods" } { "newseq" "a sequence" } }
  12 { $description
  13     "Returns the Exponential Moving Average with the specified periodicity, calculated by:\n"
  14     { $list
  15         "A = 2.0 / (N + 1)"
  16         "EMA[t] = (A * SEQ[t]) + ((1-A) * EMA[t-1])" }
  17 } ;
  18
  19 HELP: macd
  20 { $values { "seq" "a sequence" } { "n1" "short number of periods" } { "n2" "long number of periods" } { "newseq" "a sequence" } }
  21 { $description
  22     "Returns the Moving Average Converge of the sequence, calculated by:\n"
  23     { $list "MACD[t] = EMA2[t] - EMA1[t]" }
  24 } ;
  25
  26 HELP: momentum
  27 { $values { "seq" "a sequence" } { "n" "number of periods" } { "newseq" "a sequence" } }
  28 { $description
  29     "Returns the Momentum of the sequence, calculated by:\n"
  30     { $list "MOM[t] = SEQ[t] - SEQ[t-n]" }
  31 } ;
  32
  33 HELP: biweekly
  34 { $values
  35      { "x" number }
  36      { "y" number }
  37 }
  38 { $description "Divides a number by the number of two week periods in a year." } ;
  39
  40 HELP: daily-360
  41 { $values
  42      { "x" number }
  43      { "y" number }
  44 }
  45 { $description "Divides a number by the number of days in a 360-day year." } ;
  46
  47 HELP: daily-365
  48 { $values
  49      { "x" number }
  50      { "y" number }
  51 }
  52 { $description "Divides a number by the number of days in a 365-day year." } ;
  53
  54 HELP: monthly
  55 { $values
  56      { "x" number }
  57      { "y" number }
  58 }
  59 { $description "Divides a number by the number of months in a year." } ;
  60
  61 HELP: semimonthly
  62 { $values
  63      { "x" number }
  64      { "y" number }
  65 }
  66 { $description "Divides a number by the number of half-months in a year. Note that biweekly has two more periods than semimonthly." } ;
  67
  68 HELP: weekly
  69 { $values
  70      { "x" number }
  71      { "y" number }
  72 }
  73 { $description "Divides a number by the number of weeks in a year." } ;
  74
  75 ARTICLE: "time-period-calculations" "Calculations over periods of time"
  76 { $subsection monthly }
  77 { $subsection semimonthly }
  78 { $subsection biweekly }
  79 { $subsection weekly }
  80 { $subsection daily-360 }
  81 { $subsection daily-365 } ;
  82
  83 ARTICLE: "math.finance" "Financial math"
  84 "The " { $vocab-link "math.finance" } " vocabulary contains financial calculation words." $nl
  85 "Calculating payroll over periods of time:"
  86 { $subsection "time-period-calculations" } ;
  87
  88 ABOUT: "math.finance"