Skip to content

Implement Is between functionality #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elirehema wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Implement Is between functionality #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aaa9a02
Implement Is betweeen functionality
elirehema Jun 11, 2023
afac942
Merge branch 'master' into 1-add-implementation-for-is-between
elirehema Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions decimal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//
// To use Decimal as part of a struct:
//
// type StructName struct {
// type Struct struct {
// Number Decimal
// }
//
Expand Down Expand Up @@ -1013,6 +1013,13 @@ func (d Decimal) LessThanOrEqual(d2 Decimal) bool {
return cmp == -1 || cmp == 0
}

// Betwee (LTE) return true when d is between d1 and d2 inclusive
Copy link
Member

@mwoss mwoss Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Go doc should start with the method name, so I'd suggest:
IsBetween returns true when d is between (inclusive) d1 and d2, otherwise false.

func (d Decimal) IsBetween(d1 Decimal, d2 Decimal) bool {
cmp1 := d.Cmp(d1)
cmp2 := d.Cmp(d2)
return (cmp1 == 1 || cmp1 == 0) && (cmp2 == -1 || cmp2 == 0)
}

// Sign returns:
//
// -1 if d < 0
Expand Down Expand Up @@ -1215,7 +1222,7 @@ func (d Decimal) Round(places int32) Decimal {
// NewFromFloat(545).RoundCeil(-2).String() // output: "600"
// NewFromFloat(500).RoundCeil(-2).String() // output: "500"
// NewFromFloat(1.1001).RoundCeil(2).String() // output: "1.11"
// NewFromFloat(-1.454).RoundCeil(1).String() // output: "-1.4"
// NewFromFloat(-1.454).RoundCeil(1).String() // output: "-1.5"
func (d Decimal) RoundCeil(places int32) Decimal {
if d.exp >= -places {
return d
Expand All @@ -1240,7 +1247,7 @@ func (d Decimal) RoundCeil(places int32) Decimal {
// NewFromFloat(545).RoundFloor(-2).String() // output: "500"
// NewFromFloat(-500).RoundFloor(-2).String() // output: "-500"
// NewFromFloat(1.1001).RoundFloor(2).String() // output: "1.1"
// NewFromFloat(-1.454).RoundFloor(1).String() // output: "-1.5"
// NewFromFloat(-1.454).RoundFloor(1).String() // output: "-1.4"
func (d Decimal) RoundFloor(places int32) Decimal {
if d.exp >= -places {
return d
Expand All @@ -1265,7 +1272,7 @@ func (d Decimal) RoundFloor(places int32) Decimal {
// NewFromFloat(545).RoundUp(-2).String() // output: "600"
// NewFromFloat(500).RoundUp(-2).String() // output: "500"
// NewFromFloat(1.1001).RoundUp(2).String() // output: "1.11"
// NewFromFloat(-1.454).RoundUp(1).String() // output: "-1.5"
// NewFromFloat(-1.454).RoundUp(1).String() // output: "-1.4"
func (d Decimal) RoundUp(places int32) Decimal {
if d.exp >= -places {
return d
Expand All @@ -1292,7 +1299,7 @@ func (d Decimal) RoundUp(places int32) Decimal {
// NewFromFloat(545).RoundDown(-2).String() // output: "500"
// NewFromFloat(-500).RoundDown(-2).String() // output: "-500"
// NewFromFloat(1.1001).RoundDown(2).String() // output: "1.1"
// NewFromFloat(-1.454).RoundDown(1).String() // output: "-1.4"
// NewFromFloat(-1.454).RoundDown(1).String() // output: "-1.5"
func (d Decimal) RoundDown(places int32) Decimal {
if d.exp >= -places {
return d
Expand Down
7 changes: 7 additions & 0 deletions decimal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2548,6 +2548,13 @@ func TestDecimal_Equalities(t *testing.T) {
if c.LessThanOrEqual(b) {
t.Errorf("%q should not be less than or equal %q", a, b)
}

Copy link
Member

@mwoss mwoss Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a separate test case for IsBetween where you verify the correctness of left and right bound inclusiveness?

if !b.IsBetween(c, a) {
t.Errorf("%q should be less than or equal %q", a, b)
}
if b.IsBetween(a, c) {
t.Errorf("%q should not be less than or equal %q", a, b)
}
}

func TestDecimal_ScalesNotEqual(t *testing.T) {
Expand Down