UnitPeriod (FSharp.Finance.Personal) | FSharp.Finance.Personal

FSharp.Finance.Personal

UnitPeriod Module

Namespace: FSharp.Finance.Personal
Assembly: FSharp.Finance.Personal.dll

an unambiguous way to represent regular date intervals and generate schedules based on them

note: unit-period definitions are based on US federal legislation but the definitions are universally applicable

Types and nested modules

Type/Module	Description
Config (Module)	functions for creating and handling unit-period configs
Config (Type)	unit period combined with a start date and multiple where appropriate
Direction	direction in which to generate the schedule: forward works forwards from a given date and reverse works backwards
ScheduleLength	defines the length of a payment schedule, either by the number of payments or by the maximum duration
TransactionTerm	a transaction term is the length of a transaction (i.e. a financial product), from the start date to the final payment
UnitPeriod	interval between payments

Functions and values

Function or value	Description
`all` Full Usage: `all` Returns: `(int * UnitPeriod) array`	all unit-periods, excluding unlikely ones (opinionated!) Returns: `(int * UnitPeriod) array`
`commonLengths lengths` Full Usage: `commonLengths lengths` Parameters: lengths : `int array` Returns: `(int * int) array`	lengths that occur more than once lengths : `int array` Returns: `(int * int) array`
`detect direction interval transferDates` Full Usage: `detect direction interval transferDates` Parameters: direction : `Direction` interval : `UnitPeriod` transferDates : `Date array` Returns: `Config`	for a given interval and array of dates, devise the unit-period config direction : `Direction` interval : `UnitPeriod` transferDates : `Date array` Returns: `Config`
`generatePaymentSchedule scheduleLength direction unitPeriodConfig` Full Usage: `generatePaymentSchedule scheduleLength direction unitPeriodConfig` Parameters: scheduleLength : `ScheduleLength` direction : `Direction` unitPeriodConfig : `Config` Returns: `Date[]`	generate a payment schedule based on a unit-period config scheduleLength : `ScheduleLength` direction : `Direction` unitPeriodConfig : `Config` Returns: `Date[]`
`maxPaymentCount maxDuration config` Full Usage: `maxPaymentCount maxDuration config` Parameters: maxDuration : `int<MeasureProduct<DurationDay, MeasureOne>>` config : `Config` Returns: `int`	generates a suggested number of payments to constrain the loan within a certain duration maxDuration : `int<MeasureProduct<DurationDay, MeasureOne>>` config : `Config` Returns: `int`
`nearest term advanceDates paymentDates` Full Usage: `nearest term advanceDates paymentDates` Parameters: term : `TransactionTerm` advanceDates : `Date[]` paymentDates : `Date[]` Returns: `UnitPeriod`	find the nearest unit-period according to the transaction term and transfer dates term : `TransactionTerm` advanceDates : `Date[]` paymentDates : `Date[]` Returns: `UnitPeriod`
`numberPerYear _arg1` Full Usage: `numberPerYear _arg1` Parameters: _arg1 : `UnitPeriod` Returns: `decimal`	number of unit-periods in a year _arg1 : `UnitPeriod` Returns: `decimal`
`roughLength unitPeriod` Full Usage: `roughLength unitPeriod` Parameters: unitPeriod : `UnitPeriod` Returns: `int`	approximate length of unit period in days, used e.g. as the denominator in unit-period fractions unitPeriod : `UnitPeriod` Returns: `int`
`transactionTerm consummationDate firstFinanceChargeEarnedDate lastPaymentDueDate lastAdvanceScheduledDate` Full Usage: `transactionTerm consummationDate firstFinanceChargeEarnedDate lastPaymentDueDate lastAdvanceScheduledDate` Parameters: consummationDate : `Date` firstFinanceChargeEarnedDate : `Date` lastPaymentDueDate : `Date` lastAdvanceScheduledDate : `Date` Returns: `TransactionTerm`	calculate the transaction term based on specific events consummationDate : `Date` firstFinanceChargeEarnedDate : `Date` lastPaymentDueDate : `Date` lastAdvanceScheduledDate : `Date` Returns: `TransactionTerm`