feat: add dict-style hierarchy access and ambient clock domains - #22
Merged
Merged
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
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.
Summary
Two related additions to how signals are located and loaded.
Dict-style hierarchy access
reader[path]returns theSignalorScopeat an exact path; nestedlookups (
scope["a.b"]) resolve relative paths, andsig[7:4]bit-selectslike
Waveformindexing.Ambient clock domains
ClockDomainbundles a clock signal with a sampling recipe (edge, time orcycle window), so it doesn't need to be repeated on every call:
Signal.w/Signal.m/Signal.waveform()/Signal.unknown_mask()read the ambient domain.load_waveform,load_unknown_mask,load_matched_waveforms, andload_matched_unknown_masksdefaultclock/clock_pathtoNoneand fall back to the same ambient domain when omitted.Docs
Rewrote the reader, signal-query, and waveform-analysis guides (EN + ZH) to lead with dict-style access and ambient clock domains, and added
ClockDomainto the API reference.Examples
Rewrote the six existing examples to use dict-style access and ambient clock domains throughout, and added a new
multi_cluster_occupancyexample demonstrating batch scope matching (get_matched_scopeswith brace, recursive wildcard, and regex captures combined) across a bank of clusters.Testing
Tests, lint, type-check, and doc build all pass, including the FSDB suite.