Add missing documentation for exponentiation methods#194
Closed
ChrisRackauckas-Claude wants to merge 2 commits intoSciML:masterfrom
Closed
Add missing documentation for exponentiation methods#194ChrisRackauckas-Claude wants to merge 2 commits intoSciML:masterfrom
ChrisRackauckas-Claude wants to merge 2 commits intoSciML:masterfrom
Conversation
This commit adds documentation for several previously undocumented functions:
- exponential!(A::GPUArraysCore.AbstractGPUArray): GPU-specific exponential function
- expv(t, Ks::KrylovSubspace): Compute exp(tA)b using precomputed Krylov subspace
- expv!(w::AbstractVector{Complex{Tw}}, ...): Complex version of expv!
- expv!(w::GPUArraysCore.AbstractGPUVector{Tw}, ...): GPU-optimized expv!
- phiv(t, Ks::KrylovSubspace, k): Compute phi functions using precomputed Krylov subspace
Also added clarifying comments for internal helper functions:
- exp_gen! functions: Internal Padé approximation implementations
- getmem, ldiv_for_generated!: Internal helper functions for generated code
- _expv_hb, _expv_ee: Internal helper functions for Krylov methods
All docstrings follow Julia documentation conventions with proper formatting.
Tests pass successfully after these documentation additions.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Added comprehensive docstring to exp_gen!(cache, A, ::Val{1}) explaining:
- Purpose: Internal Padé approximation implementation
- Parameters and their meanings
- Connection to Higham (2005) algorithm
- Note that these are internal functions
Added brief reference comments to exp_gen! functions for orders 2-13
pointing to the main documentation in order 1.
All exp_gen! functions now have proper documentation explaining their
role in the matrix exponential computation.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
I've added additional documentation for the
All 13 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
Details
This PR adds documentation for several previously undocumented functions:
Public API Functions
exponential!(A::GPUArraysCore.AbstractGPUArray): GPU-specific exponential functionexpv(t, Ks::KrylovSubspace): Compute exp(tA)b using precomputed Krylov subspaceexpv!(w::AbstractVector{Complex{Tw}}, ...): Complex version of expv!expv!(w::GPUArraysCore.AbstractGPUVector{Tw}, ...): GPU-optimized expv!phiv(t, Ks::KrylovSubspace, k): Compute phi functions using precomputed Krylov subspaceInternal Functions (comments added for clarity)
exp_gen!functions: Internal Padé approximation implementations (orders 1-13)getmem,ldiv_for_generated!: Internal helper functions for generated code_expv_hb,_expv_ee: Internal helper functions for Krylov methodsTest Results
All tests pass successfully:
Notes
🤖 Generated with Claude Code