SharedMemory and NDArray implementation #5
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
This was referenced May 16, 2024
ctrueden
reviewed
Jul 9, 2024
There was a problem hiding this comment.
Thank you so much @tpietzsch for bringing this to completion. It's great. I am only going to make some small adjustments, which I will list here as part of my review, in case you have any concerns about any of them:
- Reformat Java code to use tabs in line with the existing code.
- Add class Javadoc to all classes, including proper
@authorattribution, as well as references to analogous Python API for comparison. - Rewrite the main commit adding the implementation to have a
Co-authored-byline crediting @carlosuc3m. - Rename
ShmImplto justShm, because theImplsuffix in Java classes is traditionally used to indicate an implementation of an interface, not the interface itself. - To avoid the
org.apposed.apposebase package referencing theorg.apposed.appose.shmsubpackage: move theShmImpl/Shminterface out of theShmsubpackage, and alter itscreatestatic method to useServiceLoaderinstead with platform-specificShmobject factories. Details TBD.
I'll also look into adding a SharedMemoryTest to the unit tests, and broadening the GitHub Actions CI to run on all supported platforms, since this is critical foundational logic.
ctrueden
force-pushed
the
schmarrn
branch
3 times, most recently
from
c1a1194
to
40ce610
Compare
SharedMemory implementation is lifted from JDLL. NDArray wraps SharedMemory, and adds shape and data-type information. Co-authored-by: Carlos Garcia Lopez de Haro <100329787@alumnos.uc3m.es>
(requires branch 'schmarrn' in appose-python to work)
Co-authored-by: Carlos Garcia Lopez de Haro <100329787@alumnos.uc3m.es>
This makes the SharedMemory class into an interface with three implementations, one per supported platform, but leaves the door open for additional platforms to add support by implementing their own ShmFactory that produces appropriate SharedMemory objects. The plugins are discovered using Java's ServiceLoader mechanism.
There are only two cases: create or attach.
The DType and Shape classes define the two major pieces of metadata needed by NDArray. One was an inner class of NDArray and the other was not. This change makes it consistent: now both are inner classes.
ctrueden
force-pushed
the
schmarrn
branch
2 times, most recently
from
0331a70
to
20fa4af
Compare
So that it matches the Python implementation of Appose. The reason it's third in Python is so that it can have the default parameter value of None, to provide feature parity with the Java version's two-argument NDAray constructor that creates the SharedMemory. And create the memory even if the three-argument constructor is used.
Thanks, license-maven-plugin!
ctrueden
force-pushed
the
schmarrn
branch
3 times, most recently
from
3b4c83c
to
b228089
Compare
And decouple the close and unlink functions. There was a lot of duplicate code between ShmLinux, ShmMacOS, and ShmWindows, which is now in the internal ShmBase class. This made it easier to have consistent logic around the close vs. unlink behavior across platforms, with less copy/pasted code.
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.
This PR adds
1)
SharedMemorywhich is adapted from @carlosuc3m code in JDLL.The Linux implementation has been tested only superficially, the Windows implementation not at all ...
2)
NDArraywhich annotatesSharedMemorywith data type and shape, similar to NumPyndarray.This is independent of ImgLib2, adapters for ImgLib2 data structures are in https://github.com/imglib/imglib2-appose.
3) JSON de/serialization for
SharedMemoryandNDArray. Basically: put aNDArrayinto aTask'sinputson the Java side and aNDArraycomes out in theGroovyWorkerinputs, or a NumPyndarrayin the python worker inputs.(The python side requires the corresponding apposed/appose-python#1 PR)