home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / qtawk / fin.exp < prev    next >
Text File  |  1990-05-16  |  28KB  |  955 lines
  1. # Financial Calculator
  2. # Copyright (C) 1990 Terry D. Boldt, All Rights Reserved
  3. #
  4. # This version for use WITH ANSI.SYS display driver
  5. #
  6. #  This is  a complete    financial computation  utility to  solve for  the five
  7. # standard financial values: n, %i, PV, PMT and FV
  8. #
  9. #    n     == number of payment periods
  10. #    %i  == nominal interest charged
  11. #    PV  == Present Value
  12. #    PMT == Periodic Payment
  13. #    FV  == Future Value
  14. #
  15. #  In addition, two additional parameters may be specified:
  16. #
  17. #    1) Compounding frequency, CF. The compounding frequency may be discrete
  18. #     or continuous and may be different from the Payment Frequency
  19. #
  20. #    2) Payment Frequency, PF.
  21. #
  22. #  Canadian  and  European  style  mortgages  can  be  handled    in  a simple,
  23. # straight-forward manner. Standard financial sign conventions are used:
  24. #
  25. #       "Money paid out is Negative, Money received is Positive"
  26. #
  27. #  Time value of money:
  28. #
  29. #  If you borrow money, you can expect    to pay rent or interest for its  use;
  30. # conversely you expect to receive rent interest on money you loan or invest.
  31. # When you rent property, equipment,  etc., rental payments are normal;  this
  32. # is  also  true  when    renting  or  borrowing    money.    Therefore,  money  is
  33. # considered to have a "time value". Money available now, has a greater value
  34. # than money available at some future date bacause of its rental value or the
  35. # interest that it can produce during the intervening period.
  36. #
  37. #  Simple Interest:
  38. #
  39. #  If you loaned $800 to  a friend with an agreement  that at the end of  one
  40. # year he would  would repay you  $896, the "time  value" you placed  on your
  41. # $800 (principal) was $96 (interest) for  the one year period (term) of  the
  42. # loan. This  relationship of  principal, interest,  and time  (trm) is  most
  43. # frequently expressed as an Annual  Percentage Rate (APR). In this  case the
  44. # APR  was  12.0%  [(96/800)*100].  This  example  illustrates the four basic
  45. # factors involved  in a  simple ineterst  case. The  time period (one year),
  46. # rate (12.0%  APR), present  value of    the principal  ($800) and  the future
  47. # value of the principal including interest ($896).
  48. #
  49. #  Compound Interest:
  50. #
  51. #  In many case the ineterst charge is computed periodically during the  term
  52. # of  the  agreement.  For  example,  money  left  is a savings account earns
  53. # interest that  is periodically  added to  the principal  and in  turn earns
  54. # additional interest during succeeding periods. The accumulation of interest
  55. # during  the  investment  period  represents  compound interest. If the loan
  56. # agreement you  made with  your friend  had specified    a "compound  interest
  57. # rate" of  12% (compounded  monthly) the  $800 principal  would have  earned
  58. # $101.46 interest for the  one year period. The  value of the original  $800
  59. # would be increased  by 1% the  first month to  $808 which in    turn would be
  60. # increased  by  1%  to  816.08  the  second month,reaching a future value of
  61. # $901.46 after the twlefth iteration. The monthly compounding of the nominal
  62. # annual rate (NAR) of 12% produces an effective Annual Percentage Rate (APR)
  63. # of 12.683% [(101.46/800)*100].  Interest may be  compounded at any  regular
  64. # interval; annually, semiannually, monthly, weekly, daily, even continuously
  65. # (a specification in some financial models).
  66. #
  67. #  Periodic Payments:
  68. #
  69. #  When money is loaned for longer  periods of time, it is customary  for the
  70. # agreement to require the borrower  to make periodic payments to  the lender
  71. # during the term of the loan. The payments may be only large enough to repay
  72. # the interest,  with the  principal due  at the  end of  the loan period (an
  73. # interest only loan), or large enough    to fully repay both the interest  and
  74. # principal during the term of the loan (a fully amoritized loan). Many loans
  75. # fall somewhere between, with payments that do not fully cover repayment  of
  76. # both the principal and interst. These loans require a larger final  payment
  77. # (balloon)  to  complete  their  amortization.  Payments  may    occur  at the
  78. # beginning or end of a payment period. If you and your friend had agreed  on
  79. # monthly repayment of    the $800 loan  at 12% NAR  compounded monthly, twelve
  80. # payments of $71.08 for a total of $852.96 would be required to amortize the
  81. # loan. The $101.46  interest from the    annual plan is    more than the  $52.96
  82. # under the monthly plan because under the monthly plan your friend would not
  83. # have had the use of $800 for a full year.
  84. #
  85. #  Finacial Transactions:
  86. #
  87. #  The    above  paragraphs  introduce  the  basic  factors  that  govern  most
  88. # financial  transactions;  the  time  period,    interest rate, present value,
  89. # payments and    the future  value. In  addition, certain  conventions must be
  90. # adhered to: the interest rate must be relative to the compounding frequency
  91. # and payment periods, and the term must be expressed as the total number  of
  92. # payments (or compounding periods if there are no payments). Loans,  leases,
  93. # mortgages, annuities, savings plans, appreciation, and compound growth  are
  94. # amoung the many financial problems that can be defined in these terms. Some
  95. # transactions do not involve payments, but  all of the other factors play  a
  96. # part in "time value of money" transactions. When any one of the five  *four
  97. # - if no payments are involved)  factors is unknown, it can be  derived from
  98. # formulas using the known factors.
  99. #
  100. # Standard Financial Conventions Are:
  101. #
  102. #  Money RECEIVED is a    POSITIVE value and is  represented by an arrow    above
  103. # the line
  104. #
  105. #  Money PAID OUT is  a NEGATIVE value and  is represented by an  arrow below
  106. # the line.
  107. #
  108. #  If payments are  a part of  the transaction, the  number of payments  must
  109. # equal the number of periods (n).
  110. #
  111. #  Payments may be  represented as occuring  at the end  or beginning of  the
  112. # periods.
  113. #
  114. #  Diagram  or    visualize  the    positive  and  negative cash flows (cash flow
  115. # diagrams):
  116. #
  117. #
  118. #                                  FV*
  119. #       1   2   3   4   .   .   .   .   .   .   .   .   .   n │
  120. # Period ┌───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┘
  121. #     │
  122. #     
  123. #     PV
  124. #
  125. #     Appreciation
  126. #     Depreciation
  127. #     Compound Growth
  128. #     Savings Account
  129. #
  130. ##############################################################################
  131. #
  132. #                                 FV
  133. #     PV = 0                             
  134. #                                 │
  135. # Period ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┘
  136. #     │ 1 │ 2 │ 3 │ 4 │ . │ . │ . │ . │ . │ . │ . │ . │ . │ n
  137. #                                                        
  138. #    PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT
  139. #
  140. #     Annuity (series of payments)
  141. #     Pension Fund
  142. #     Savings Plan
  143. #     Sinking Fund
  144. #
  145. ##############################################################################
  146. #
  147. #     PV 
  148. #     │                            FV=0
  149. # Period └───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐
  150. #       1 │ 2 │ 3 │ 4 │ . │ . │ . │ . │ . │ . │ . │ . │ . │ n │
  151. #                                                              
  152. #        PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT
  153. #
  154. #     Amortization
  155. #     Direct Reduction Loan
  156. #     Mortgage (fully amortized)
  157. #
  158. ##############################################################################
  159. #
  160. #                                  FV*
  161. #        PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT PMT  │ +
  162. #                                                               PMT
  163. #       1 │ 2 │ 3 │ 4 │ . │ . │ . │ . │ . │ . │ . │ . │ . │ n │
  164. # Period ┌───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┘
  165. #     │
  166. #     
  167. #     PV
  168. #
  169. #     Annuity
  170. #     Lease (with buy back or residual)*
  171. #     Loan or Mortgage (with balloon)*
  172. #
  173. ##############################################################################
  174. #
  175. # The basic financial equation used is:
  176. #
  177. #  1) PV*(1 + i)^n + PMT*[(1+i)^n - 1]/i + FV = 0
  178. #
  179. #  In  the  above  form,  equation  1)    is  suitable for the ordinary annuity
  180. # condition, when payments are made at    the end of each period. To  enable 1)
  181. # to solve the annuity due condition when payments are made at the  beginning
  182. # of each period, a small modification is required. When this modification is
  183. # added, equation 1) becomes:
  184. #
  185. #  2) PV*(1 + i)^n + PMT*(1+iX)*[(1+i)^n - 1]/i + FV = 0
  186. #
  187. #    where:  X = 0 for ordinary annuity condition
  188. #         X = 1 for annuity due condition
  189. #
  190. # With a simple alegebraic re-arrangement, 2) becomes:
  191. #
  192. #  3) [PV + PMT*(1 + iX)/i][(1 + i)^n - 1] + PV + FV = 0
  193. #
  194. # or
  195. #
  196. #  4) (PV + C)*A + PV + FV = 0
  197. #
  198. # where:
  199. #  5) A = (1 + i)^n - -1
  200. #
  201. #  6) B = (1 + iX)/i
  202. #
  203. #  7) C = PMT*B
  204. #
  205. # The form of equation 4) simplifies the calculation procedure for all five
  206. # variables, which are readily solved as follows:
  207. #
  208. #  8) n = ln[(C - FV)/(C + PV)]/ln((1 + i)
  209. #
  210. #  9) PV = -[FV + A*C]/(A + 1)
  211. #
  212. # 10) PMT = -[FV + PV*(A + 1)]/[A*B]
  213. #
  214. # 11) FV = -[PV + A*(PV + C)]
  215. #
  216. # Equations 5), 6) and 7) are computed by functions:
  217. #
  218. #  _A
  219. #  _B
  220. #  _C
  221. #
  222. # respectively. Equations 8), 9), 10) and 11) are computed by functions:
  223. #
  224. #  _N
  225. #  _PV
  226. #  _PMT
  227. #  _FV
  228. #
  229. # respectively.
  230. #
  231. # The solution for interest is broken into two cases:
  232. #
  233. #  PMT == 0
  234. #    i = [FV/PV]^(1/n) - 1
  235. #
  236. #  PMT != 0
  237. #    Since equation 3) cannot be solved explicitly for i in this case, an
  238. #    iterative technique must be employed. Newton's method, using exact
  239. #    expressions for the function of i and its derivative, are employed. The
  240. #    expressions are:
  241. #
  242. # 12) i[k+1] = i[k] - f(i[k])/f'(i[k])
  243. #    where: i[k+1] == (k+1)st iteration of i
  244. #           i[k]   == kth iteration of i
  245. #    and:
  246. #
  247. # 13) f(i) = A*(PV+C) + PV + FV
  248. #
  249. # 14) f'(i) = n*D*(PV+C) - (A*C)/i
  250. #
  251. # 15) D = (1 + i)^(n-1) = (A+1)/(1+i)
  252. #
  253. #    To start the iterative solution for i, an initial guess must be made
  254. #    for the value of i. The closer this guess is to the actual value,
  255. #    the fewer iterations will have to be made, and the greater the
  256. #    probability that the required solution will be obtained. The initial
  257. #    guess for i is obtained as follows:
  258. #
  259. #    if PMT*FV >= 0, then PV case
  260. #    if PMT*FV <  0, then FV case
  261. #
  262. #     PV case:
  263. #         | n*PMT + PV + FV |
  264. # 16)      i[0] = | ----------------|
  265. #         |    n*PV       |
  266. #
  267. #           = abs[(n*PMT + PV + FV)/(n*PV)]
  268. #
  269. #     FV case:
  270. #      a) PV != 0
  271. #
  272. #             |        FV - n*PMT         |
  273. # 17)          i[0] = |---------------------------|
  274. #             | 3*[PMT*(n-1)^2 + PV - FV] |
  275. #
  276. #           = abs[(FV-n*PMT)/(3*(PMT*(n-1)^2+PV-FV))]
  277. #      b) PV == 0
  278. #
  279. #             |        FV + n*PMT         |
  280. # 18)          i[0] = |---------------------------|
  281. #             | 3*[PMT*(n-1)^2 + PV - FV] |
  282. #
  283. #           = abs[(FV+n*PMT)/(3*(PMT*(n-1)^2+PV-FV))]
  284. #
  285. #  As well as being able to select either an ordinary annuity or annuity  due
  286. # situation, this utility also enables solutions to be obtained when:
  287. #
  288. #  a)  the  compounding  frequency,  CF,  is  not  identical  to  the payment
  289. # frequency, PF, and/or,
  290. #
  291. #  b) Interest is compounded in either discrete intervals or is  continuously
  292. # compounded.
  293. #
  294. #
  295. #  The Compounding Frequency  and Payment Frequency  are defaulted to  1. The
  296. # default is for discrete interest intervals.
  297. #
  298. #  When a solution  for n, PV,    PMT or FV  is required, the  nominal interest
  299. # rate, i, must first be converted to the effective interest rate per payment
  300. # period. This rate, ieff, is then used to compute the selected variable.  To
  301. # convert i to ieff, the following expressions are used:
  302. #
  303. #  Discrete interest periods:
  304. #
  305. # 19) ieff = (1 + i/CF)^(CF/PF) - 1
  306. #
  307. #  Continuous Interest
  308. #
  309. # 20) ieff = e^(i/PF) - 1 = exp(i/PF) - 1
  310. #
  311. #  When interest is computed, the computation produces the effective interest
  312. # rate, ieff. This value must then be converted to the nominal interest rate.
  313. # Function  _I    below  returns    the  nominal  interest rate NOT the effective
  314. # interest rate. ieff is converted to i using the following expressions:
  315. #
  316. #  Discrete Case:
  317. #
  318. #     i = CF*[(1+ieff)^(PF/CF) - 1]
  319. #
  320. #  Continuous Case:
  321. #
  322. #     i = ln[(1+ieff)^PF]
  323. #
  324. # Note: in the following examples, the user input is preceeded by the prompt
  325. # "<>". The result of evaluating the input expression is then displayed.
  326. # I have taken the liberty of including comments in the example
  327. # input/output sessions by preceeding with '#'. Thus, for the line:
  328. # <>n=5     #set number of periods
  329. # the comment that setting the number of periods is not really input.
  330. #
  331. # Example 1: Simple Interest
  332. # Find annual simple interest rate (%) for an $800 loan to be repayed at the
  333. # end of one year with a single payment of $896.
  334. # <>n=1
  335. # 1
  336. # <>pv=-800
  337. # -800
  338. # <>fv=896
  339. # 896
  340. # <>i=_I(n,pv,pmt,fv)
  341. # 12
  342. #
  343. # Example 2: Compound Interest
  344. # Find the future value of $800 after one year at a nominal rate of 12%
  345. # compounded monthly. No payments are specified, so the payment frequency is
  346. # set equal to the compounding frequency.
  347. # <>d
  348. # <>n=12
  349. # 12
  350. # <>CF=PF=12
  351. # 12
  352. # <>i=12
  353. # 12
  354. # <>pv=-800
  355. # -800
  356. # <>fv=_FV(n,i,pv,pmt)
  357. # 901.46
  358. #
  359. # Example 3: Periodic Payment:
  360. # Find the monthly end-of-period payment required to fully amortize the loan
  361. # in Example 2. A fully amortized loan has a future value of zero.
  362. # <>fv=0
  363. # 0
  364. # <>pmt=_PMT(n,i,pv,fv)
  365. # 71.08
  366. #
  367. # Example 4: Conventional Mortgage
  368. # Find the number of monthly payments necessary to fully amortize a loan of
  369. # $100,000 at a nominal rate of 13.25% compounded monthly, if end-of-period
  370. # payments of $1125.75 are made.
  371. # <>d
  372. # <>CF=PF=12
  373. # 12
  374. # <>i=13.25
  375. # 13.25
  376. # <>pv=100000
  377. # 100,000
  378. # <>pmt=-1125.75
  379. # -1,125.75
  380. # <>n=_N(i,pv,pmt,fv)
  381. # 360.1
  382. #
  383. # Example 5: Final Payment
  384. # Using the data in example 4, find the amount of the final payment if n is
  385. # changed to 360. The final payment will be equal to the regular payment plus
  386. # any balance, future value, remaining at the end of period number 360.
  387. # <>n=360
  388. # 360
  389. # <>fv=_FV(n,i,pv,pmt)
  390. # -108.87
  391. # <>pmt+fv
  392. # -1,234.62
  393. #
  394. # Example 6: Balloon Payment
  395. # On long term loans, small changes in the periodic payments can generate
  396. # large changes in the future value. If the monthly payment in example 5 is
  397. # rounded down to $1125, how much addtional (balloon) payment will be due
  398. # with the final regular payment.
  399. # <>pmt=-1125
  400. # -1,125
  401. # <>fv=_FV(n,i,pv,pmt)
  402. # -3,579.99
  403. #
  404. # Example 7: Canadian Mortgage
  405. # Find the monthly end-of-period payment necessary to fully amortize a 25 year
  406. # $85,000 loan at 11% compounded semi-annually.
  407. # <>d
  408. # <>CF=2
  409. # 2
  410. # <>PF=12
  411. # 12
  412. # <>n=300
  413. # 300
  414. # <>i=11
  415. # 11
  416. # <>pv=85000
  417. # 85,000
  418. # <>pmt=_PMT(n,i,pv,fv)
  419. # -818.15
  420. #
  421. # Example 8: European Mortgage
  422. # The "effective annual rate (EAR)" is used in some countries (especially
  423. # in Europe) in lieu of the nominal rate commonly used in the United States
  424. # and Canada. For a 30 year $90,000 mortgage at 14% (EAR), compute the monthly
  425. # end-of-period payments. When using an EAR, the compounding frequency is
  426. # set to 1.
  427. # <>d
  428. # <>PF=12
  429. # 12
  430. # <>n=30*12
  431. # 360
  432. # <>i=14
  433. # 14
  434. # <>pv=90000
  435. # 90,000
  436. # <>pmt=_PMT(n,i,pv,fv)
  437. # -1,007.88
  438. #
  439. # Example 9: Bi-weekly Savings
  440. # Compute the future value, fv, of bi-weekly savings of $100 for 3 years at a
  441. # nominal annual rate of 5.5% compounded daily. (Set payment to
  442. # beginning-of-period, bep = TRUE)
  443. # <>d
  444. # <>bep=TRUE
  445. # 1
  446. # <>CF=365
  447. # 365
  448. # <>PF=26
  449. # 26
  450. # <>n=3*26
  451. # 78
  452. # <>i=5.5
  453. # 5.5
  454. # <>pmt=-100
  455. # -100
  456. # <>fv=_FV(n,i,pv,pmt)
  457. # 8,489.32
  458. #
  459. # Example 10: Present Value - Annuit Due
  460. # What is the present value of $500 to be received at the beginning of each
  461. # quarter over a 10 year period if money is being discounted at 10% nominal
  462. # annual rate compounded monthly?
  463. # <>d
  464. # <>bep=TRUE
  465. # 1
  466. # <>CF=12
  467. # 12
  468. # <>PF=4
  469. # 4
  470. # <>n=4*10
  471. # 40
  472. # <>i=10
  473. # 10
  474. # <>pmt=500
  475. # 500
  476. # <>pv=_PV(n,i,pmt,fv)
  477. # -12,822.64
  478. #
  479. # Example 11: Effective Rate - 365/360 Basis
  480. # Compute the effective annual rate (%APR) for a nominal annual rate of 12%
  481. # compounded on a 365/360 basis used by some Savings & Loan Associations.
  482. # <>d
  483. # <>n=365
  484. # 365
  485. # <>CF=365
  486. # 365
  487. # <>PF=360
  488. # 360
  489. # <>i=12
  490. # 12
  491. # <>pv=-100
  492. # -100
  493. # <>fv=_FV(n,i,pv,pmt)
  494. # 112.94
  495. # <>fv+pv
  496. # 12.94
  497. #
  498. #
  499. # Example 12: Mortgage with "Points"
  500. # What is the true APR of a 30 year, $75,000 loan at a nominal rate of 13.25%
  501. # compounded monthly, with monthly end-of-period payments, if 3 "points"
  502. # are charged? The pv must be reduced by the dollar value of the points
  503. # and/or any lenders fees to establish an effective pv. Because payments remain
  504. # the same, the true APR will be higher than the nominal rate. Note, first
  505. # compute the payments on the pv of the loan amount.
  506. # <>d
  507. # <>n=30*12
  508. # 360
  509. # <>i=13.25/12
  510. # 1.1041666666667
  511. # <>pv=75000
  512. # 75,000
  513. # <>pmt=_PMT(n,i,pv,fv)
  514. # -844.33
  515. # <>pv -= pv * .03
  516. # 72,750
  517. # <>CF=PF=12
  518. # 12
  519. # <>i=_I(n,pv,pmt,fv)
  520. # 13.692689279058
  521. #
  522. #
  523. # Example 13: Equivalent Payments
  524. # Find the equivalent monthly payment required to amortize a 20 year $40,000
  525. # loan at 10.5% nominal annual rate compounded monthly, with 10 annual
  526. # payments of $5029.71 remaining. Compute the pv of the remaining annual
  527. # payments, then change n, the number of periods, and the payment frequency,
  528. # PF, to a monthly basis and compute the equivalent monthly pmt.
  529. # <>d
  530. # <>CF=12
  531. # 12
  532. # <>n=10
  533. # 10
  534. # <>i=10.5
  535. # 10.5
  536. # <>pmt=-5029.71
  537. # -5,029.71
  538. # <>pv=_PV(n,i,pmt,fv)
  539. # 29,595.88
  540. # <>PF=12
  541. # 12
  542. # <>n=120
  543. # 120
  544. # <>pmt=_PMT(n,i,pv,fv)
  545. # -399.35
  546. #
  547. # Example 14: Perpetuity - Continuous Compounding
  548. # If you can purchase a single payment annuity with an initial investment of
  549. # $60,000 that will be invested at 15% nominal annual rate compounded
  550. # continuously, what is the maximum monthly return you can receive without
  551. # reducing the $60,000 principal? If the principal is not disturbed, the
  552. # payments can go on indefinitely (a perpetuity). Note that the term,n, of
  553. # a perpetuity is immaterial. It can be any non-zero value.
  554. # <>d
  555. # <>disc = FALSE
  556. # 0
  557. # <>n=12
  558. # 12
  559. # <>PF=12
  560. # 12
  561. # <>i=15
  562. # 15
  563. # <>fv=60000
  564. # 60,000
  565. # <>pv=-60000
  566. # -60,000
  567. # <>pmt=_PMT(n,i,pv,fv)
  568. # 754.71
  569. #
  570. #
  571. # reference: PPC ROM User's Manual
  572. #         pages 148 - 164
  573. #
  574. BEGIN {
  575.     # ratio used in iterative solution for interest
  576.     ratio = 1e4;
  577.  
  578.     # precesion of roundoff for n, pv, pmt and fv
  579.     prec = 2;
  580.  
  581.     stderr = "stderr";
  582.  
  583.     # set display colors
  584.     # highlight
  585.     hl_color = "\x01b[0;32;40m";
  586.     # normal display
  587.     nl_color = "\x01b[1;31;44m";
  588.  
  589.     Yes  = /^{_w}*[Yy](es)?{_w}*$/;    # Yes answer
  590.     No     = /^{_w}*[Nn]o?{_w}*$/;    # No answer
  591.     Quit = /^{_w}*[Qq](uit)?({_w}+[Nn]o?)?{_w}*$/;    # define regular expression To  Quit
  592.     Status = /^{_w}*[Ss](tat(us)?)?{_w}*$/;
  593.     Default = /^{_w}*[Dd](efault)?{_w}*$/;
  594.     Help = /^{_w}*[Hh](elp)?{_w}*$/;
  595.     Cls  = /^{_w}*[Cc](ls)?{_w}*$/;
  596.  
  597.     quit_status = TRUE;
  598.  
  599.     # find number of variables defined in calculator progam
  600.     # any new variables defined by user will be in addition to this number
  601.     # the number, vcnt, is then used in displaying status
  602.     vcnt = var_number(FALSE);
  603.  
  604. #    display_cpyr;
  605.     set_default;
  606.     prt_instructions;
  607.     prompt;
  608. }
  609.  
  610. Quit {
  611.     if ( NF > 1 ) {
  612.     switch ( $2 ) {
  613.         case Yes:
  614.         quit_status = TRUE;
  615.         break;
  616.         case No:
  617.         quit_status = FALSE;
  618.         break;
  619.     }
  620.     }
  621.     exit 2;
  622. }
  623.  
  624. Status {
  625.     prt_status;
  626.     prompt;
  627.     next;
  628. }
  629.  
  630. Default {
  631.     set_default;
  632.     prompt;
  633.     next;
  634. }
  635.  
  636. Help {
  637.     prt_instructions;
  638.     prompt;
  639.     next;
  640. }
  641.  
  642. Cls  {
  643.     display_cpyr;
  644.     prompt;
  645.     next;
  646. }
  647.  
  648.     {
  649.     line = $0;
  650.     if ( $0 !~ /;$/ ) line ∩= ';'; #check for trailing ';'
  651.     print '\t' ∩ addcomma(execute(line,TRUE,TRUE));
  652.     prompt;
  653. }
  654.  
  655. END {
  656.     if ( quit_status ) display_cpyr;
  657. }
  658.  
  659. # function to clear screen and home cursor
  660. function cls() {
  661.     # clear screen and home cursor string
  662.     local _cls_ = "\x01b[2J";
  663.  
  664.     printf(_cls_);
  665. }
  666.  
  667. function display_cpyr() {
  668.     cls;
  669.     print "\nFinancial Calculator\n\x01b[0;32;40mCopyright (C) 1990 Terry D. Boldt, All Rights Reserved.\x01b[1;31;44m";
  670. }
  671.  
  672. function prt_status() {
  673.     local cd = disc ? "Discrete (disc = TRUE)" : "Continuous (disc = FALSE)";
  674.     local eb = bep ? "Beginning of Period (bep = TRUE)" : "End of Period (bep = FALSE)";
  675.     local j, jj, ostr;
  676.  
  677.     display_cpyr;
  678.     print "Current Financial Calculator Status:";
  679.     print "Compounding Frequency: (CF) " ∩ hl_color ∩ CF ∩ nl_color;
  680.     print "Payment     Frequency: (PF) " ∩ hl_color ∩ PF ∩ nl_color;
  681.     print "Compounding: " ∩ hl_color ∩ cd ∩ nl_color;
  682.     print "Payments: " ∩ hl_color ∩ eb ∩ nl_color;
  683.     print "Number of Payment Periods (n): " ∩ hl_color  ∩ addcomma(n) ∩ nl_color;
  684.     print "Interest per Payment Period (i): " ∩ hl_color  ∩ i ∩ nl_color;
  685.     print "Present Value (pv): " ∩ hl_color  ∩ addcomma(pv) ∩ nl_color;
  686.     print "Periodic Payment (pmt): " ∩ hl_color  ∩ addcomma(pmt) ∩ nl_color;
  687.     print "Future Value (fv): " ∩ hl_color ∩ addcomma(fv) ∩ nl_color;
  688.     print "User Defined Variables:";
  689.     j = vcnt;
  690.     for ( ostr = ud_sym(j++,jj) ; jj ; ostr = ud_sym(j++,jj) )
  691.     print hl_color ∩ jj ∩ nl_color ∩ " == " ∩ addcomma(ostr);
  692. }
  693.  
  694. function prt_instructions() {
  695.     display_cpyr;
  696.     print "To compute Loan Quantities:";
  697.     print hl_color ∩ "N " ∩ nl_color ∩ "==> to compute # payment periods from i, pv, pmt, fv";
  698.     print hl_color ∩ "_N(i,pv,pmt,fv) " ∩ nl_color ∩ "==> to compute # payment periods";
  699.     print hl_color ∩ "I" ∩ nl_color ∩ " ==> to compute interest from n, pv, pmt, fv";
  700.     print hl_color ∩ "_I(n,pv,pmt,fv)" ∩ nl_color ∩ " ==> to compute interest";
  701.     print hl_color ∩ "PV" ∩ nl_color ∩ " ==> to compute Present Value from n, i, pmt, fv";
  702.     print hl_color ∩ "_PV(n,i,pmt,fv)" ∩ nl_color ∩ " ==> to compute Present Value";
  703.     print hl_color ∩ "PMT" ∩ nl_color ∩ " ==> to compute Payment from n, i, pv, fv";
  704.     print hl_color ∩ "_PMT(n,i,pv,fv)" ∩ nl_color ∩ " ==> to compute Payment";
  705.     print hl_color ∩ "FV" ∩ nl_color ∩ " ==> to compute Future Value from n, i, pv, pmt";
  706.     print hl_color ∩ "_FV(n,i,pv,pmt)" ∩ nl_color ∩ " ==> to compute Future Value\n";
  707.     print hl_color ∩ "[Qq](uit)?" ∩ nl_color ∩ " to Quit";
  708.     print hl_color ∩ "[Ss](tatus)?" ∩ nl_color ∩ " to Display Status of Computations";
  709.     print hl_color ∩ "[Dd](efault)?" ∩ nl_color ∩ " to Re-Initialize";
  710.     print hl_color ∩ "[Cc](ls)?" ∩ nl_color ∩ " to Clear Screen";
  711.     print hl_color ∩ "[Hh](elp)" ∩ nl_color ∩ " to Display This Help";
  712. }
  713.  
  714. # Compute constant used in calculations
  715. function _A(nint,per) {
  716.     return (1.0 + nint) ^ per - 1;
  717. }
  718.  
  719. # Compute constant used in calculations
  720. function _B(nint,beg) {
  721.     if ( nint == 0 ) {
  722.     fprintf(stderr,"Zero Interest.\n");
  723.     next;
  724.     }
  725.     return (1.0 + nint * beg)/nint;
  726. }
  727.  
  728. # Compute constant used in calculations
  729. function _C(nint,pmt,beg) {
  730.     return pmt * _B(nint,beg);
  731. }
  732.  
  733. # compute Number of Periods from preset data
  734. function N() {
  735.     return n = _N(i,pv,pmt,fv);
  736. }
  737.  
  738. # Compute number of periods from:
  739. #   1. Nominal Interest
  740. #   2. Present Value
  741. #   3. Periodic Payment
  742. #   4. Future Value
  743. function _N(nint,pv,pmt,fv) {
  744.     local intn = eff_int(nint/100.0);
  745.     local CC = _C(intn,pmt,bep);
  746.  
  747.     return rnd(log((CC - fv)/(CC + pv))/log(1 + intn),prec);
  748. }
  749.  
  750. # compute Interest from preset data
  751. function I() {
  752.     return i = _I(n,pv,pmt,fv);
  753. }
  754.  
  755. # Compute Nominal Interest from:
  756. #   1. Number of periods
  757. #   2. Present Value
  758. #   3. Periodic Payment
  759. #   4. Future Value
  760. function _I(per,pv,pmt,fv) {
  761.     local inte;
  762.     local a, ik, dik;
  763.  
  764.     if ( pmt == 0 ) {
  765.     inte = ((abs(fv) + 0.0)/abs(pv))^(1/per) - 1;
  766.       } else {
  767.     if ( (pmt * fv) < 0 ) {
  768.         if ( pv ) a = -1.0; else a = 1.0;
  769.         inte = abs((fv + a * n * pmt)/(3 * ( (n-1)^2 * pmt + pv - fv) ));
  770.       } else {
  771.         if ( pv*pmt < 0 ) {
  772.         inte = abs((n * pmt + pv + fv + 0.0)/(n * pv));
  773.           } else {
  774.         a = abs((pmt + 0.0)/(abs(pv) + abs(fv)));
  775.         inte = a + 1/(a * per^3);
  776.         }
  777.     }
  778.     do {
  779.         dik = fi(per,inte,pv,pmt,fv)/fip(per,inte,pv,pmt,fv);
  780.         inte -= dik;
  781.     } while ( int(ratio * (dik/inte)) );
  782.     }
  783.     return 100.0 * nom_int(inte);
  784. }
  785.  
  786. # compute Present value from preset data
  787. function PV(n,i,pmt,fv) {
  788.     return pv = _PV(n,i,pmt,fv);
  789. }
  790.  
  791. # Compute Present Value from:
  792. #   1. Number of periods
  793. #   2. Nominal Interest
  794. #   3. Periodic Payment
  795. #   4. Future Value
  796. function _PV(per,nint,pmt,fv) {
  797.     local intn = eff_int(nint/100.0);
  798.     local AA = _A(intn,per);
  799.     local BB = _B(intn,bep);
  800.     local CC = _C(intn,pmt,bep);
  801.  
  802.     return rnd(-(fv + (AA * CC))/(AA + 1),prec);
  803. }
  804.  
  805. # compute Periodic Payment from preset data
  806. function PMT() {
  807.     return pmt = _PMT(n,i,pv,fv);
  808. }
  809.  
  810. # Compute Periodic Payment from:
  811. #   1. Number of periods
  812. #   2. Nominal Interest
  813. #   3. Present Value
  814. #   4. Future Value
  815. function _PMT(per,nint,pv,fv) {
  816.     local intn = eff_int(nint/100.0);
  817.     local AA = _A(intn,per);
  818.     local BB = _B(intn,bep);
  819.  
  820.     return rnd(-(fv + pv * (AA + 1))/(AA * BB),prec);
  821. }
  822.  
  823. # compute Future Value from preset data
  824. function FV() {
  825.     return fv = _FV(n,i,pv,pmt);
  826. }
  827.  
  828. # Compute Future Value from:
  829. #   1. Number of periods
  830. #   2. Nominal Interest
  831. #   3. Present Value
  832. #   4. Periodic Payments
  833. function _FV(per,nint,pv,pmt) {
  834.     local intn = eff_int(nint/100.0);
  835.     local AA = _A(intn,per);
  836.     local CC = _C(intn,pmt,bep);
  837.  
  838.     return rnd(-(pv + AA * (pv + CC)),prec);
  839. }
  840.  
  841. # compute Nominal Interest Rate from Effective Interest Rate
  842. function nom_int(inte) {
  843.     local nint;
  844.  
  845.     if ( disc ) nint = CF * ((1 + inte)^(PF/CF) - 1);
  846.       else nint = log((1 + inte)^PF);
  847.     return nint;
  848. }
  849.  
  850. # Compute Effective Interest Rate from Nominal Interest Rate
  851. function eff_int(nint) {
  852.     local inte;
  853.  
  854.     if ( disc ) inte = (1 + nint/CF)^(CF/PF) - 1;
  855.       else inte = exp(nint/PF) - 1;
  856.     return inte;
  857. }
  858.  
  859. # function to add commas to numbers
  860. function addcomma(x) {
  861.     local num;
  862.     local spat;
  863.     local bnum = /{_d}{3,3}([,.]|$)/;
  864.  
  865.     if ( x < 0 ) return "-" ∩ addcomma(-x);
  866.     num = sprintf("%.14g",x);        # num is dddddd.dd
  867.     spat = num ~~ /\./ ? /{_d}{4,4}[.,]/ : /{_d}{4,4}(,|$)/;
  868.     while ( num ~~ spat ) sub(bnum,",&",num);
  869.     return num;
  870. }
  871.  
  872. # return 'x' rounded to 'places' past decimal
  873. # if 'places' == 0, return 'x'
  874. function rnd(x,places) {
  875.     local pwr, r, inc;
  876.  
  877.     if ( places >= 0 ) {
  878.     pwr = 10 ^ places;
  879.     r = x * pwr;
  880.     inc = abs(int(10 * fract(r))) >= 5 ? signum(x) : 0;
  881.     r = int(r + inc) / pwr;
  882.     } else r = x;
  883.     return r;
  884. }
  885.  
  886. # return absolute value of 'x'
  887. function abs(x) {
  888.     return x > 0 ? x : -x;
  889. }
  890.  
  891. # return sign of 'x'
  892. #  returns:
  893. #   1  ==> x >    0
  894. #   0  ==> x == 0
  895. #  -1  ==> x <    0
  896. function signum(x) {
  897.     return x == 0 ? 0 : x > 0 ? 1 : -1;
  898. }
  899.  
  900. # calculation used in interest computation
  901. function fi(per,nint,pv,pmt,fv) {
  902.     return _A(nint,per) * (pv + _C(nint,pmt,bep)) + pv + fv;
  903. }
  904.  
  905. # calculation used in interest computation
  906. function fip(per,nint,pv,pmt,fv) {
  907.     local AA = _A(nint,per);
  908.     local CC = _C(nint,pmt,bep);
  909.     local D = (AA + 1.0)/(1.0 + nint);
  910.  
  911.     return per * (pv + CC) * D    - (AA * CC)/nint;
  912. }
  913.  
  914. function prompt() {
  915.     printf("<>");
  916. }
  917.  
  918. function set_default() {
  919.     # flag whether accrueing interest at beginning or end of period
  920.     # FALSE --> end
  921.     # TRUE  --> beginning
  922.     bep = FALSE;
  923.  
  924.     # flag for discrete or continuous interest
  925.     # TRUE  --> discrete
  926.     # FALSE --> continuous
  927.     disc = TRUE;
  928.  
  929.     # set compounding, CF, and payment, PF, frequency
  930.     CF = PF = 1;
  931.  
  932.     # standard loan quantities:
  933.     # number of periods: n
  934.     n = 0;
  935.     # annual interest: i
  936.     i = 0;
  937.     # Present Value: pv
  938.     pv = 0;
  939.     # Payment: pmt
  940.     pmt = 0;
  941.     # Future Value: fv
  942.     fv = 0;
  943. }
  944.  
  945. # function to return the current number of GLOBAL variables defined in utility
  946. function var_number(display) {
  947.     local cnt, j, jj;
  948.  
  949.     for ( jj = cnt = 1 ; jj ; cnt++ ) {
  950.     j = ud_sym(cnt,jj);
  951.     if ( display ) print cnt ∩ " : " ∩ jj ∩ " ==>" ∩ j ∩ "<==";
  952.     }
  953.     return cnt - 1;
  954. }
  955.