Calculation (FSharp.Finance.Personal)

Calculation Module

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

convenience functions and options to help with calculations

Types and nested modules

Type/Module	Description
Amount (Module)	an amount specified either as a simple amount or as a percentage of another amount, optionally restricted to lower and/or upper limits
Array	functions for working with arrays
Cent (Module)	utility functions for base currency unit values
Fraction (Module)	a fraction expressed as a numerator and denominator
Map	functions for working with maps
Percent (Module)	utility functions for percent values
Restriction (Module)	the type of restriction placed on a possible value
Rounding (Module)	the type of rounding, specifying midpoint-rounding where necessary
ToleranceSteps (Module)	lower and upper bounds, as well as a step value, for tolerance when using the solver
Amount (Type)	an amount specified either as a simple amount or as a percentage of another amount, optionally restricted to lower and/or upper limits
Cent (Type)	the base unit of a currency (cent, penny, øre etc.)
DateRange	a holiday, i.e. a period when no interest and/or charges are accrued
DivisionResult	holds the result of a division, separated into quotient and remainder
Fraction (Type)	a fraction
Percent (Type)	a percentage, e.g. 42%, as opposed to its decimal representation 0.42m
Restriction (Type)	the type of restriction placed on a possible value
Rounding (Type)	the type of rounding, specifying midpoint-rounding where necessary
Solution	the result obtained from the array solver
TargetTolerance	what range of values the solver should aim for
ToleranceSteps (Type)	lower and upper bounds, as well as a step value, for tolerance when using the solver

Functions and values

Function or value	Description
`divRem left right` Full Usage: `divRem left right` Parameters: left : `decimal` right : `decimal` Returns: `DivisionResult`	computes the quotient and remainder of two decimal values left : `decimal` right : `decimal` Returns: `DivisionResult`
`getAprOr defaultValue _arg1` Full Usage: `getAprOr defaultValue _arg1` Parameters: defaultValue : `decimal` _arg1 : `Solution` Returns: `decimal`	wrapper to extract APR value from solution defaultValue : `decimal` _arg1 : `Solution` Returns: `decimal`
`isTimedOut paymentTimeout evaluationDay paymentDay` Full Usage: `isTimedOut paymentTimeout evaluationDay paymentDay` Parameters: paymentTimeout : `int<MeasureProduct<DurationDay, MeasureOne>>` evaluationDay : `int<MeasureProduct<OffsetDay, MeasureOne>>` paymentDay : `int<MeasureProduct<OffsetDay, MeasureOne>>` Returns: `bool`	determines whether a pending payment has timed out paymentTimeout : `int<MeasureProduct<DurationDay, MeasureOne>>` evaluationDay : `int<MeasureProduct<OffsetDay, MeasureOne>>` paymentDay : `int<MeasureProduct<OffsetDay, MeasureOne>>` Returns: `bool`
`libraryVersion` Full Usage: `libraryVersion` Returns: `string`	the version of the library Returns: `string`
`roundMidpointTowardsZero m` Full Usage: `roundMidpointTowardsZero m` Parameters: m : `decimal` Returns: `int`	rounds to the nearest number, and when a number is halfway between two others, it's rounded toward the nearest number that's towards 0L m : `decimal` Returns: `int`