-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Add type-safe VecMap for slices indexed by newtypes
#14910
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // This code is part of Qiskit. | ||
| // | ||
| // (C) Copyright IBM 2026 | ||
| // | ||
| // This code is licensed under the Apache License, Version 2.0. You may | ||
| // obtain a copy of this license in the LICENSE.txt file in the root directory | ||
| // of this source tree or at https://www.apache.org/licenses/LICENSE-2.0. | ||
| // | ||
| // Any modifications or derivative works of this code must retain this | ||
| // copyright notice, and modified files need to carry a notice indicating | ||
| // that they have been altered from the originals. | ||
|
|
||
| use std::marker::PhantomData; | ||
| use std::ops; | ||
|
|
||
| use rustworkx_core::petgraph::graph::IndexType; | ||
|
|
||
| /// Internal helper struct that represents a `Box<[T]>`, but is indexed by a petgraph-like indexer. | ||
| /// | ||
| /// The layer structures involve several flat arrays, each representing a map from an index to a | ||
| /// value, but the index types are often different, so it's less error-prone if we _enforce_ that | ||
| /// you index using the object, rather than calling its `.index` method and erasing the type. | ||
| #[derive(Clone, Debug)] | ||
| pub struct VecMap<Idx: IndexType, T> { | ||
| phantom: PhantomData<Idx>, | ||
| data: Box<[T]>, | ||
| } | ||
| impl<Idx: IndexType, T> VecMap<Idx, T> { | ||
| /// Swap the values of two indices. | ||
| #[inline] | ||
| pub fn swap(&mut self, a: Idx, b: Idx) { | ||
| self.data.swap(a.index(), b.index()) | ||
| } | ||
|
|
||
| /// Fill all entries in the slice with a given value. | ||
| #[inline] | ||
| pub fn fill(&mut self, val: T) | ||
| where | ||
| T: Clone, | ||
| { | ||
| self.data.fill(val) | ||
| } | ||
| } | ||
|
|
||
| impl<Idx: IndexType, T> ops::Index<Idx> for VecMap<Idx, T> { | ||
| type Output = <[T] as ops::Index<usize>>::Output; | ||
| fn index(&self, index: Idx) -> &Self::Output { | ||
| &self.data[index.index()] | ||
| } | ||
| } | ||
| impl<Idx: IndexType, T> ops::IndexMut<Idx> for VecMap<Idx, T> { | ||
| fn index_mut(&mut self, index: Idx) -> &mut Self::Output { | ||
| &mut self.data[index.index()] | ||
| } | ||
| } | ||
|
|
||
| impl<Idx: IndexType, T> From<Vec<T>> for VecMap<Idx, T> { | ||
| fn from(value: Vec<T>) -> Self { | ||
| Self { | ||
| phantom: PhantomData, | ||
| data: value.into_boxed_slice(), | ||
| } | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.