Modern Finance Apportion

Home › Finance › Finance › Apportion

Apportion

Splits a Currency total by weights into parts that add up to it exactly.

Syntax

Apportion( total, weights( ), result( ) )

Examples

#import "std/money"
using money

'' Splits a total so the parts sum EXACTLY to it -- the rounding
'' remainder is distributed rather than dropped, which is what makes
'' three-way splits of a penny add up
dim as Currency total_ = CurrencyFromDouble( 10.0 )
dim as int64 weights( 0 to 2 ) = { 1, 1, 1 }
dim parts( 0 to 2 ) as Currency

Apportion( total_, weights( ), parts( ) )

dim as Currency sum_ = CurrencyFromInt( 0 )
for i as int32 = 0 to 2
    print parts( i ).ToString( )
    sum_ = sum_ + parts( i )
next
print sum_.ToString( )       '' 10.0000 -- exactly the input

---

Library: Finance
Category: Finance
Documented under: Nothing Becomes A Keyword