Skip to content

Add note about floating point weights in update_weights docs #1280

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.

Sign up for GitHub

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 4 commits into from
Feb 2, 2023
Merged

Add note about floating point weights in update_weights docs #1280

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0879a99
Adds floating point note in update_weights docs
arya2 Jan 26, 2023
6bb6eb6
Update src/distributions/weighted_index.rs
arya2 Feb 2, 2023
4151835
Update src/distributions/weighted_index.rs
arya2 Feb 2, 2023
13a26a1
Update src/distributions/weighted_index.rs
arya2 Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/distributions/weighted_index.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ impl<X: SampleUniform + PartialOrd> WeightedIndex<X> {
/// allocation internally.
///
/// In case of error, `self` is not modified.
///
/// Note: Updating floating-point weights may cause slight inaccuracies in the total weight.
/// This method will not always return `WeightedError::AllWeightsZero` when all weights
/// are zero if using floating-point weights.
pub fn update_weights(&mut self, new_weights: &[(usize, &X)]) -> Result<(), WeightedError>
where X: for<'a> ::core::ops::AddAssign<&'a X>
+ for<'a> ::core::ops::SubAssign<&'a X>
Expand Down