Hint to GHC that indices are to be used strictly #485
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bodigrim
force-pushed
the
indices-are-strict
branch
from
5de58ff
to
9f21834
Compare
Shimuuar
approved these changes
Mar 11, 2024
| @@ -700,21 +700,25 @@ exchange v i x = checkIndex Bounds i (length v) $ unsafeExchange v i x | |||
| -- | Yield the element at the given position. No bounds checks are performed. | |||
| unsafeRead :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m a | |||
| {-# INLINE unsafeRead #-} | |||
| unsafeRead v i = checkIndex Unsafe i (length v) | |||
| unsafeRead v !i = checkIndex Unsafe i (length v) | |||
| $ stToPrim | |||
There was a problem hiding this comment.
I 100% agree with this change, but unfortunately it means the following lines are no longer indented correctly with respect to the =. Is that something that can be fixed as part of this PR?
|
|
||
| -- | Replace the element at the given position. No bounds checks are performed. | ||
| unsafeWrite :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m () | ||
| {-# INLINE unsafeWrite #-} | ||
| unsafeWrite v i x = checkIndex Unsafe i (length v) | ||
| unsafeWrite v !i x = checkIndex Unsafe i (length v) | ||
| $ stToPrim |
| $ stToPrim | ||
| $ basicUnsafeWrite v i x | ||
|
|
||
| -- | Modify the element at the given position. No bounds checks are performed. | ||
| unsafeModify :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> a) -> Int -> m () | ||
| {-# INLINE unsafeModify #-} | ||
| unsafeModify v f i = checkIndex Unsafe i (length v) | ||
| unsafeModify v f !i = checkIndex Unsafe i (length v) | ||
| $ stToPrim |
| @@ -725,7 +729,7 @@ unsafeModify v f i = checkIndex Unsafe i (length v) | |||
| -- @since 0.12.3.0 | |||
| unsafeModifyM :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> m a) -> Int -> m () | |||
| {-# INLINE unsafeModifyM #-} | |||
| unsafeModifyM v f i = checkIndex Unsafe i (length v) | |||
| unsafeModifyM v f !i = checkIndex Unsafe i (length v) | |||
| $ stToPrim . basicUnsafeWrite v i =<< f =<< stToPrim (basicUnsafeRead v i) | |||
|
@Bodigrim I extended same treatment to If you're fine with this I'd like to merge this PR |
|
@Shimuuar sure, go ahead. |
'basicUnsafe{Read/Write/IndexM}' are class members and, unless a call site was
already specialised to a specific vector instance, GHC has no clue that the index
is most certainly to be used eagerly. Bang before the index provides
this vital for optimizer information.
We have longish comment which is referenced from multiple places in source code. GHC notes seems good option for that
Shimuuar
force-pushed
the
indices-are-strict
branch
from
96ee359
to
e13cb00
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
basicUnsafe{Read/Write/IndexM}are class members and, unless a call site was already specialised to a specific vector instance, GHC has no clue that the index is most certainly to be used eagerly. Bang before the index provides this vital for optimizer information.I've been recently looking at Core for programs, where vectors did not specialise to a specific instance for one reason or another. It's really horrible: even if a specific instance remains unknown, we should tell GHC that passing boxed indices around is not OK.