Add final factorial state to filtering output#259
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the factorial offline filtering API to also return the final factorial state when output_factorial=False, and updates tests/docs accordingly.
Changes:
- Extend
cuthbert.factorial.filter(..., output_factorial=False)to return(init_state, local_states, final_state). - Update factorial test suites to unpack the new 3-tuple return and add assertions for
final_state. - Update the factorial README example to reflect the new return shape.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
cuthbert/factorial/filtering.py |
Returns final_factorial_state in the non-factorial output path; updates docstring/typing accordingly. |
cuthbert/factorial/README.md |
Adjusts example usage to unpack the additional final_factorial_state. |
tests/cuthbert/factorial/test_kalman.py |
Unpacks the additional return value and validates final_state matches reference. |
tests/cuthbert/factorial/test_discrete.py |
Unpacks the additional return value and validates final_state matches reference. |
tests/cuthbert/factorial/test_smc.py |
Updates unpacking for the non-factorial output path. |
tests/cuthbert/factorial/test_taylor.py |
Updates JIT’d call site to unpack the additional return value. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sahel13
approved these changes
Jun 9, 2026
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
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.
Lots of places this will be handy I think