SciML / SciML/JumpProcesses.jl
Check if wrapping affects to always return nothing has perf impact
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 150
- Forks
- 41
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 28
Description
We currently always wrap user affect function to ensure they return nothing, thereby making sure the affect functions all have the same return type. We should see if this has any performance impact, and if so, make a kwarg a user can set to disable this (i.e. by promising they have properly constructed their affect functions to return nothing).
We should also update the docs to always include the nothing return.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the code that wraps user affect functions and the documentation describing affect return values. Benchmark the current wrapping behavior, determine whether disabling it needs a user-facing kwarg, and update the docs to consistently require or describe a nothing return.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation, performance
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100