Config (FSharp.Finance.Personal) | FSharp.Finance.Personal

FSharp.Finance.Personal

Config Module

Namespace: FSharp.Finance.Personal
Assembly: FSharp.Finance.Personal.dll
Parent Module: UnitPeriod

functions for creating and handling unit-period configs

Functions and values

Function or value	Description
`constrain unitPeriodConfig` Full Usage: `constrain unitPeriodConfig` Parameters: unitPeriodConfig : `Config` Returns: `Config`	constrains the freqencies to valid values unitPeriodConfig : `Config` Returns: `Config`
`defaultMonthly multiple startDate` Full Usage: `defaultMonthly multiple startDate` Parameters: multiple : `int` startDate : `Date` Returns: `Config`	creates a monthly config, using month-end tracking where appropriate multiple : `int` startDate : `Date` Returns: `Config`
`defaultSemiMonthly startDate` Full Usage: `defaultSemiMonthly startDate` Parameters: startDate : `Date` Returns: `Config`	creates a semi-monthly config specifying the first day only, using month-end tracking where appropriate startDate : `Date` Returns: `Config`
`from startDate unitPeriod` Full Usage: `from startDate unitPeriod` Parameters: startDate : `Date` unitPeriod : `UnitPeriod` Returns: `Config`	create a unit-period config from a unit period (using month-end tracking for semi-monthly and monthly unit periods) startDate : `Date` unitPeriod : `UnitPeriod` Returns: `Config`
`roughLength unitPeriodConfig` Full Usage: `roughLength unitPeriodConfig` Parameters: unitPeriodConfig : `Config` Returns: `decimal`	approximate length of unit period in days, used e.g. for generating rescheduling iterations unitPeriodConfig : `Config` Returns: `decimal`
`serialise unitPeriodConfig` Full Usage: `serialise unitPeriodConfig` Parameters: unitPeriodConfig : `Config` Returns: `string`	pretty-print the unit-period config, useful for debugging unitPeriodConfig : `Config` Returns: `string`
`startDate unitPeriodConfig` Full Usage: `startDate unitPeriodConfig` Parameters: unitPeriodConfig : `Config` Returns: `Date`	gets the start date based on a unit-period config unitPeriodConfig : `Config` Returns: `Date`