docs: Add documentation for in-place interpolation API #481
Conversation
This file contains hidden or 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
Add a new section "In-place Evaluation (Allocation-free)" to the interface documentation that explains how to use the in-place interpolation API `interp(out, t)` to avoid memory allocations. This addresses user feedback from issue SciML#478 where the in-place interface was discovered but found to be underdocumented. The new section includes: - Explanation of when to use in-place evaluation (ODE solvers, tight loops) - Code examples for 1D data with pre-allocated output arrays - Code examples for multi-dimensional data - Performance tip highlighting the allocation benefits Closes SciML#478 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Add documentation for in-place interpolation with vector-of-arrays data
(Vector{Vector}, Vector{Matrix}), showing how to pre-allocate the output
as a vector of arrays with the same structure.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
interp(out, t)API for allocation-free interpolationMotivation
This PR addresses feedback from #478 where a user discovered the in-place interpolation API by reading the source code. The API was functional but undocumented, making it difficult for users to discover this performance-critical feature.
Changes
Added documentation covering:
Test plan
Closes #478
🤖 Generated with Claude Code