-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Alternative name component used for faster comparisons #1109
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
use bevy_reflect::{Reflect, ReflectComponent}; | ||
use bevy_utils::AHasher; | ||
use std::{ | ||
hash::{Hash, Hasher}, | ||
ops::Deref, | ||
}; | ||
|
||
/// Component used to identify a entity. Stores a hash for faster comparisons | ||
#[derive(Debug, Clone, Reflect)] | ||
#[reflect(Component)] | ||
pub struct Name { | ||
hash: u64, // TODO: Shouldn't be serialized | ||
name: String, | ||
} | ||
|
||
impl Default for Name { | ||
fn default() -> Self { | ||
Name::new("".to_string()) | ||
} | ||
} | ||
|
||
impl Name { | ||
pub fn new(name: String) -> Self { | ||
let mut name = Name { name, hash: 0 }; | ||
name.update_hash(); | ||
name | ||
} | ||
|
||
#[inline(always)] | ||
pub fn set(&mut self, name: String) { | ||
*self = Name::new(name); | ||
} | ||
|
||
#[inline(always)] | ||
pub fn mutate<F: FnOnce(&mut String)>(&mut self, f: F) { | ||
f(&mut self.name); | ||
self.update_hash(); | ||
} | ||
|
||
#[inline(always)] | ||
pub fn as_str(&self) -> &str { | ||
self.name.as_str() | ||
} | ||
|
||
fn update_hash(&mut self) { | ||
let mut hasher = AHasher::default(); | ||
self.name.hash(&mut hasher); | ||
self.hash = hasher.finish(); | ||
} | ||
} | ||
|
||
impl From<&str> for Name { | ||
#[inline(always)] | ||
fn from(name: &str) -> Self { | ||
Name::new(name.to_owned()) | ||
} | ||
} | ||
|
||
impl Hash for Name { | ||
fn hash<H: Hasher>(&self, state: &mut H) { | ||
self.name.hash(state); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It will be correct to use There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we could probably get away with that. Its effectively double-hashing, so our collision risk almost certainly goes up. But short of implementing a custom hasher for every Name use case, im not sure we have a better option. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Eh actually I'd rather be safe now and optimize later if we prove its not too risky. |
||
} | ||
} | ||
|
||
impl PartialEq for Name { | ||
fn eq(&self, other: &Self) -> bool { | ||
if self.hash != other.hash { | ||
// Makes the common case of two strings not been equal very fast | ||
return false; | ||
} | ||
|
||
self.name.eq(&other.name) | ||
} | ||
} | ||
|
||
impl Eq for Name {} | ||
|
||
impl PartialOrd for Name { | ||
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> { | ||
self.name.partial_cmp(&other.name) | ||
} | ||
} | ||
|
||
impl Ord for Name { | ||
fn cmp(&self, other: &Self) -> std::cmp::Ordering { | ||
self.name.cmp(&other.name) | ||
} | ||
} | ||
|
||
impl Deref for Name { | ||
type Target = String; | ||
|
||
fn deref(&self) -> &Self::Target { | ||
&self.name | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could this be
std::borrow::Cow<'static, str>
, or could this whole struct be more general then use:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah it could
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Im cool with making this less general for now to cut down on the amount of abstraction. If we find multiple use cases later and it seems worth it, we can always factor this out.