Skip to content

Add warning to documentation of fromPtrs #7

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
tomsmeding wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add warning to documentation of fromPtrs #7

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
9 changes: 7 additions & 2 deletions accelerate-io/src/Data/Array/Accelerate/IO/Foreign/Ptr.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,13 @@ type Ptrs e = GArrayDataR Ptr e
--
-- The data may not be modified through the 'Ptrs' afterwards.
--
-- You are responsible for ensuring that the data remains alive for the duration
-- of the Accelerate computation, and for freeing it afterwards.
-- **Note**: You are responsible for ensuring that the data remains alive for
-- the duration of the Accelerate computation, and for freeing it afterwards.
-- Be aware that @run@ combinators may already return results to Haskell lazily
-- once some computations have completed, while other Accelerate code is still
-- running and using arrays. In some cases, it is even possible that Accelerate
-- code is still running after /all/ results have been returned. Use the API in
-- "Data.Array.Accelerate.IO.Foreign.ForeignPtr" when in doubt.
--
-- You should make sure that the data is suitably aligned.
--
Expand Down
Loading