Skip to content

Document that Data.Ix.inRange is not a suitable default for isInRange #180

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

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Document that Data.Ix.inRange is not a suitable default for isInRange #180

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion src/System/Random/Internal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -950,7 +950,12 @@ class UniformRange a where
--
-- There is a default implementation of 'isInRange' via 'Generic'. Other helper function
-- that can be used for implementing this function are `isInRangeOrd` and
-- `isInRangeEnum`
-- `isInRangeEnum`.
--
-- Note that the @isRange@ method from @Data.Ix@ is /not/ a suitable default
-- implementation of 'isInRange'. Unlike 'isInRange', @isRange@ is not
-- required to be symmetric, and many @isRange@ implementations are not
-- symmetric in practice.
--
-- @since 1.3.0
isInRange :: (a, a) -> a -> Bool
Expand Down
Loading