wneessen/decimal
1
1
Fork 0
mirror of https://github.com/shopspring/decimal.git synced 2024-11-22 20:40:48 +01:00
Code Issues Projects Releases Packages Wiki Activity

better method comments

Browse source 
use the godoc format for the method comments
This commit is contained in:
Roland Averkamp 2015-09-03 16:31:44 +02:00
parent 5a16ac0c8f
commit 87964935d0
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
decimal.go
View file

@ -287,12 +287,12 @@ func (d Decimal) Div(d2 Decimal) Decimal {
return ret return ret
} }
// return quotient q and remainder r such that // QuoRem does divsion with remainder
// scale := -precision // d.QuoRem(d2,precision) returns quotient q and remainder r such that
// d = d2 * q + r such that q an integral multiple of 10^scale // d = d2 * q + r, q an integer multiple of 10^(-precision)
// and 0 <= r < abs(d2) * 10 ^scale // 0 <= r < abs(d2) * 10 ^(-precision) if d>=0
// this holds if d>=0 // 0 >= r > -abs(d2) * 10 ^(-precision) if d<0
// if d <0 then r =<0 with r>= -abs(d2) * 10 ^ scale // Note that precision<0 is allowed as input.
func (d Decimal) QuoRem(d2 Decimal, precision int32) (Decimal, Decimal) { func (d Decimal) QuoRem(d2 Decimal, precision int32) (Decimal, Decimal) {
scale := -precision scale := -precision
e := int64(d.exp - d2.exp - scale) e := int64(d.exp - d2.exp - scale)
@ -324,10 +324,11 @@ func (d Decimal) QuoRem(d2 Decimal, precision int32) (Decimal, Decimal) {
return dq, dr return dq, dr
} }
// divide by d by d2 and round to precision digits after . // DivRound divides and rounds to a given precision
// i.e. to an integer multiple of 10^(-precision) // i.e. to an integer multiple of 10^(-precision)
// for positive numbers normal rounding, 5 is rounded up, // for a positive quotient digit 5 is rounded up, away from 0
// if the quotient is negative then 5 is rounded down // if the quotient is negative then digit 5 is rounded down, away from 0
// Note that precision<0 is allowed as input.
func (d Decimal) DivRound(d2 Decimal, precision int32) Decimal { func (d Decimal) DivRound(d2 Decimal, precision int32) Decimal {
q, r := d.QuoRem(d2, precision) q, r := d.QuoRem(d2, precision)
// the actual rounding decision is based on comparing r*10^precision and d2/2 // the actual rounding decision is based on comparing r*10^precision and d2/2