Skip to content

Commit f19b400

Browse files
Optimized the documentation
1 parent 3a9e93f commit f19b400

1 file changed

Lines changed: 38 additions & 44 deletions

File tree

WindowsForms/Calculation-Engine/Supported-Formulas/Financial-Formulas.md

Lines changed: 38 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1103,11 +1103,11 @@ _COUPNUM(settlement, maturity, frequency, [basis])_
11031103

11041104
## AMORLINC
11051105

1106-
The function `AMORLINC` returns the depreciation for each accounting period, specifically designed for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is considered.
1106+
The `AMORLINC` function returns the depreciation for each accounting period, specifically designed for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is considered.
11071107

11081108
**Syntax**
11091109

1110-
_AMORLINC(cost, date_purchased, first_period, salvage, period, rate, [basis])_
1110+
*AMORLINC(cost, date_purchased, first_period, salvage, period, rate, [basis])*
11111111

11121112
**Where:**
11131113

@@ -1123,9 +1123,9 @@ _AMORLINC(cost, date_purchased, first_period, salvage, period, rate, [basis])_
11231123

11241124
* rate: The depreciation rate for the asset.
11251125

1126-
* basis (Optional): The day count basis to use (default is 0: US (NASD) 30/360):
1126+
* basis (Optional): The day count basis to use:
11271127

1128-
* 0 or omitted: US (NASD) 30/360
1128+
* 0 or omitted: US (NASD) 30/360 (default)
11291129

11301130
* 1: Actual/actual
11311131

@@ -1171,9 +1171,9 @@ _TBILLEQ(settlement, maturity, discount)_
11711171

11721172
* If settlement or maturity is not a valid date, `TBILLEQ` returns the `#VALUE!` error value.
11731173

1174-
* If discount 0, `TBILLEQ` returns the `#NUM!` error value.
1174+
* If discount is less than or equal to 0, `TBILLEQ` returns the `#NUM!` error value.
11751175

1176-
* If settlement > maturity, or if maturity is more than one year after settlement, `TBILLEQ` returns the `#NUM!` error value.
1176+
* If settlement is greater than maturity, or if maturity is more than one year after settlement, `TBILLEQ` returns the `#NUM!` error value.
11771177

11781178

11791179

@@ -1187,9 +1187,9 @@ _PRICEDISC(settlement, maturity, discount, redemption, [basis])_
11871187

11881188
**Where:**
11891189

1190-
* settlement: The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
1190+
* settlement: The security's settlement date. It is the date after the issue date when the security is traded to the buyer.
11911191

1192-
* maturity: The security's maturity date. The maturity date is the date when the security expires.
1192+
* maturity: The security's maturity date. It is the date when the security expires.
11931193

11941194
* discount: The security's discount rate.
11951195

@@ -1215,41 +1215,35 @@ _PRICEDISC(settlement, maturity, discount, redemption, [basis])_
12151215

12161216
* If settlement or maturity is not a valid date, `PRICEDISC` returns the `#VALUE!` error value.
12171217

1218-
* If discount ≤ 0 or if redemption ≤ 0, `PRICEDISC` returns the `#NUM!` error value.
1218+
* If discount or redemption is less than or equal to 0, `PRICEDISC` returns the `#NUM!` error value.
12191219

1220-
* If basis < 0 or if basis > 4, `PRICEDISC` returns the `#NUM!` error value.
1220+
* If basis is less than 0 or greater than 4, `PRICEDISC` returns the `#NUM!` error value.
12211221

1222-
* If settlement maturity, `PRICEDISC` returns the `#NUM!` error value.
1222+
* If settlement is greater than or equal to maturity, `PRICEDISC` returns the `#NUM!` error value.
12231223

12241224

12251225

12261226
## YIELD
12271227

1228-
The function `YIELD` returns the yield on a security that pays periodic interest. Use `YIELD` to calculate bond yield.
1228+
The `YIELD` function returns the yield on a security that pays periodic interest.
12291229

12301230
**Syntax**
12311231

12321232
_YIELD(settlement, maturity, rate, pr, redemption, frequency, [basis])_
12331233

12341234
**Where:**
12351235

1236-
* settlement: The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
1236+
* settlement: The security's settlement date. It is the date after the issue date when the security is traded to the buyer.
12371237

1238-
* maturity: The security's maturity date. The maturity date is the date when the security expires.
1238+
* maturity: The security's maturity date. It is the date when the security expires.
12391239

12401240
* rate: The security's annual coupon rate.
12411241

12421242
* pr: The security's price per $100 face value.
12431243

12441244
* redemption: The security's redemption value per $100 face value.
12451245

1246-
* frequency: The number of coupon payments per year.
1247-
1248-
* For annual payments, frequency = 1.
1249-
1250-
* For semiannual payments, frequency = 2.
1251-
1252-
* For quarterly payments, frequency = 4.
1246+
* frequency: The number of coupon payments per year (1 for annual, 2 for semiannual, 4 for quarterly).
12531247

12541248
* basis (Optional): The type of day count basis to use:
12551249

@@ -1271,17 +1265,17 @@ _YIELD(settlement, maturity, rate, pr, redemption, frequency, [basis])_
12711265

12721266
* If settlement or maturity is not a valid date, `YIELD` returns the `#VALUE!` error value.
12731267

1274-
* If rate < 0, `YIELD` returns the `#NUM!` error value.
1268+
* If rate is less than 0, `YIELD` returns the `#NUM!` error value.
12751269

1276-
* If pr ≤ 0 or if redemption ≤ 0, `YIELD` returns the `#NUM!` error value.
1270+
* If pr or redemption is less than or equal to 0, `YIELD` returns the `#NUM!` error value.
12771271

12781272
* If frequency is any number other than 1, 2, or 4, `YIELD` returns the `#NUM!` error value.
12791273

1280-
* If basis < 0 or if basis > 4, `YIELD` returns the `#NUM!` error value.
1274+
* If basis is less than 0 or greater than 4, `YIELD` returns the `#NUM!` error value.
12811275

1282-
* If settlement maturity, `YIELD` returns the `#NUM!` error value.
1276+
* If settlement is less than or equal to maturity, `YIELD` returns the `#NUM!` error value.
12831277

1284-
* If there is more than one coupon period until redemption, `YIELD` is calculated through a hundred iterations. The resolution uses the Newton method, based on the formula used for the function `PRICE`. The yield is changed until the estimated price given the yield is close to price.
1278+
* If there is more than one coupon period until redemption, `YIELD` is calculated using the Newton method, based on the formula used for the function `PRICE`. The yield is changed until the estimated price given the yield is close to price.
12851279

12861280

12871281

@@ -1295,9 +1289,9 @@ _YIELDMAT(settlement, maturity, issue, rate, pr, [basis])_
12951289

12961290
**Where:**
12971291

1298-
* settlement: The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
1292+
* settlement: The security's settlement date. It is the date after the issue date when the security is traded to the buyer.
12991293

1300-
* maturity: The security's maturity date. The maturity date is the date when the security expires.
1294+
* maturity: The security's maturity date. It is the date when the security expires.
13011295

13021296
* issue: The security's issue date.
13031297

@@ -1325,11 +1319,11 @@ _YIELDMAT(settlement, maturity, issue, rate, pr, [basis])_
13251319

13261320
* If settlement, maturity, or issue is not a valid date, `YIELDMAT` returns the `#VALUE!` error value.
13271321

1328-
* If rate < 0 or if pr 0, `YIELDMAT` returns the `#NUM!` error value.
1322+
* If rate is less than 0 or if pr is less than or equal to 0, `YIELDMAT` returns the `#NUM!` error value.
13291323

1330-
* If basis < 0 or if basis > 4, `YIELDMAT` returns the `#NUM!` error value.
1324+
* If basis is less than 0 or greater than 4, `YIELDMAT` returns the `#NUM!` error value.
13311325

1332-
* If settlement maturity, `YIELDMAT` returns the `#NUM!` error value.
1326+
* If settlement is greater than or equal to maturity, `YIELDMAT` returns the `#NUM!` error value.
13331327

13341328

13351329

@@ -1343,9 +1337,9 @@ _YIELDDISC(settlement, maturity, pr, redemption, [basis])_
13431337

13441338
**Where:**
13451339

1346-
* settlement: The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
1340+
* settlement: The security's settlement date. It is the date after the issue date when the security is traded to the buyer.
13471341

1348-
* maturity: The security's maturity date. The maturity date is the date when the security expires.
1342+
* maturity: The security's maturity date. It is the date when the security expires.
13491343

13501344
* pr: The security's price per $100 face value.
13511345

@@ -1371,11 +1365,11 @@ _YIELDDISC(settlement, maturity, pr, redemption, [basis])_
13711365

13721366
* If settlement or maturity is not a valid date, `YIELDDISC` returns the `#VALUE!` error value.
13731367

1374-
* If pr ≤ 0 or if redemption ≤ 0, `YIELDDISC` returns the `#NUM!` error value.
1368+
* If pr or redemption is less than or equal to 0, `YIELDDISC` returns the `#NUM!` error value.
13751369

1376-
* If basis < 0 or if basis > 4, `YIELDDISC` returns the `#NUM!` error value.
1370+
* If basis is less than 0 or greater than 4, `YIELDDISC` returns the `#NUM!` error value.
13771371

1378-
* If settlement maturity, `YIELDDISC` returns the `#NUM!` error value.
1372+
* If settlement is greater than equal to maturity, `YIELDDISC` returns the `#NUM!` error value.
13791373

13801374

13811375

@@ -1389,9 +1383,9 @@ _PRICEMAT(settlement, maturity, issue, rate, yld, [basis])_
13891383

13901384
**Where:**
13911385

1392-
* settlement: The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
1386+
* settlement: The security's settlement date. It is the date after the issue date when the security is traded to the buyer.
13931387

1394-
* maturity: The security's maturity date. The maturity date is the date when the security expires.
1388+
* maturity: The security's maturity date. It is the date when the security expires.
13951389

13961390
* issue: The security's issue date.
13971391

@@ -1419,17 +1413,17 @@ _PRICEMAT(settlement, maturity, issue, rate, yld, [basis])_
14191413

14201414
* If settlement, maturity, or issue is not a valid date, `PRICEMAT` returns the `#VALUE!` error value.
14211415

1422-
* If rate < 0 or if yld < 0, `PRICEMAT` returns the `#NUM!` error value.
1416+
* If rate or yld is less than 0, `PRICEMAT` returns the `#NUM!` error value.
14231417

1424-
* If basis < 0 or if basis > 4, `PRICEMAT` returns the `#NUM!` error value.
1418+
* If basis is less than 0 or greater than 4, `PRICEMAT` returns the `#NUM!` error value.
14251419

1426-
* If settlement maturity, `PRICEMAT` returns the `#NUM!` error value.
1420+
* If settlement is greater than equal to maturity, `PRICEMAT` returns the `#NUM!` error value.
14271421

14281422

14291423

14301424
## AMORDEGRC
14311425

1432-
The function `AMORDEGRC` returns the depreciation for each accounting period under the French accounting system. If an asset is purchased in the middle of an accounting period, prorated depreciation is calculated. The function applies a depreciation coefficient based on the asset's lifespan.
1426+
The `AMORDEGRC` function returns the depreciation for each accounting period under the French accounting system. If an asset is purchased in the middle of an accounting period, prorated depreciation is calculated. The function applies a depreciation coefficient based on the asset's lifespan.
14331427

14341428
**Syntax**
14351429

@@ -1475,7 +1469,7 @@ The function `AMORDEGRC` returns the depreciation for each accounting period und
14751469

14761470
* The depreciation rate increases to 50% for the period preceding the last and to 100% for the final period.
14771471

1478-
* The function returns `#NUM!` if the life of the asset is less than 1 year or falls into invalid ranges (e.g., between 0 and 1, 1 and 2, etc.).
1472+
* `AMORDEGRC` returns `#NUM!` if the life of the asset is less than 1 year or falls into invalid ranges (e.g., between 0 and 1, 1 and 2, etc.).
14791473

14801474
* Depreciation is calculated until the last period of the asset's life or until the cumulative depreciation equals the cost minus the salvage value.
14811475

@@ -1637,7 +1631,7 @@ The function `ODDLPRICE` returns the price per $100 face value of a security hav
16371631

16381632
* `#VALUE!` if any of the date arguments are invalid.
16391633

1640-
* `#NUM!` if `rate < 0`, `yld < 0`, `basis < 0`, or `basis > 4`.
1634+
* `#NUM!` if rate is less than 0, yld is less than 0, basis is less than 0, or basis greater than 4.
16411635

16421636
* `#NUM!` if the condition `maturity > settlement > last_interest` is not satisfied.
16431637

0 commit comments

Comments
 (0)