Struct hwlocality::object::distance::DistancesKind
source · pub struct DistancesKind(/* private fields */);
Expand description
Kinds of distance matrices
A kind with a name starting with “FROM_” specifies where the distance information comes from, if known.
A kind with a name starting with “MEANS_” specifies whether values are latencies or bandwidths, if applicable.
Only one of the “FROM_” and “MEANS_” kinds should be present.
Implementations§
source§impl DistancesKind
impl DistancesKind
sourcepub const FROM_OS: Self = _
pub const FROM_OS: Self = _
These distances were obtained from the operating system or hardware
sourcepub const MEANS_LATENCY: Self = _
pub const MEANS_LATENCY: Self = _
Distance values are similar to latencies between objects
Values are smaller for closer objects, hence minimal on the diagonal of the matrix (distance between an object and itself).
It could also be the number of network hops between objects, etc.
sourcepub const MEANS_BANDWIDTH: Self = _
pub const MEANS_BANDWIDTH: Self = _
Distance values are similar to bandwidths between objects
Values are higher for closer objects, hence maximal on the diagonal of the matrix (distance between an object and itself).
Such values are currently ignored for distance-based grouping.
sourcepub const HETEROGENEOUS_TYPES: Self = _
Available on crate feature hwloc-2_1_0
only.
pub const HETEROGENEOUS_TYPES: Self = _
hwloc-2_1_0
only.This distances structure covers objects of different types
This may apply to the “NVLinkBandwidth” structure in presence of a NVSwitch or POWER processor NVLink port.
source§impl DistancesKind
impl DistancesKind
sourcepub const fn bits(&self) -> hwloc_distances_kind_e
pub const fn bits(&self) -> hwloc_distances_kind_e
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: hwloc_distances_kind_e) -> Option<Self>
pub const fn from_bits(bits: hwloc_distances_kind_e) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: hwloc_distances_kind_e) -> Self
pub const fn from_bits_truncate(bits: hwloc_distances_kind_e) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: hwloc_distances_kind_e) -> Self
pub const fn from_bits_retain(bits: hwloc_distances_kind_e) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl DistancesKind
impl DistancesKind
sourcepub const fn iter(&self) -> Iter<DistancesKind>
pub const fn iter(&self) -> Iter<DistancesKind>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<DistancesKind>
pub const fn iter_names(&self) -> IterNames<DistancesKind>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl Arbitrary for DistancesKind
Available on crate feature proptest
only.
impl Arbitrary for DistancesKind
proptest
only.§type Parameters = ()
type Parameters = ()
arbitrary_with
accepts for configuration
of the generated Strategy
. Parameters must implement Default
.§type Strategy = Map<Subsequence<DistancesKind>, fn(_: Vec<DistancesKind>) -> DistancesKind>
type Strategy = Map<Subsequence<DistancesKind>, fn(_: Vec<DistancesKind>) -> DistancesKind>
Strategy
used to generate values of type Self
.source§fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy
fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy
source§impl Binary for DistancesKind
impl Binary for DistancesKind
source§impl BitAnd for DistancesKind
impl BitAnd for DistancesKind
source§impl BitAndAssign for DistancesKind
impl BitAndAssign for DistancesKind
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for DistancesKind
impl BitOr for DistancesKind
source§fn bitor(self, other: DistancesKind) -> Self
fn bitor(self, other: DistancesKind) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = DistancesKind
type Output = DistancesKind
|
operator.source§impl BitOrAssign for DistancesKind
impl BitOrAssign for DistancesKind
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for DistancesKind
impl BitXor for DistancesKind
source§impl BitXorAssign for DistancesKind
impl BitXorAssign for DistancesKind
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for DistancesKind
impl Clone for DistancesKind
source§fn clone(&self) -> DistancesKind
fn clone(&self) -> DistancesKind
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DistancesKind
impl Debug for DistancesKind
source§impl Extend<DistancesKind> for DistancesKind
impl Extend<DistancesKind> for DistancesKind
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for DistancesKind
impl Flags for DistancesKind
source§const FLAGS: &'static [Flag<DistancesKind>] = _
const FLAGS: &'static [Flag<DistancesKind>] = _
source§fn bits(&self) -> hwloc_distances_kind_e
fn bits(&self) -> hwloc_distances_kind_e
source§fn from_bits_retain(bits: hwloc_distances_kind_e) -> DistancesKind
fn from_bits_retain(bits: hwloc_distances_kind_e) -> DistancesKind
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl From<DistancesKind> for AddDistancesError
Available on crate feature hwloc-2_5_0
only.
impl From<DistancesKind> for AddDistancesError
hwloc-2_5_0
only.source§fn from(value: DistancesKind) -> Self
fn from(value: DistancesKind) -> Self
source§impl FromIterator<DistancesKind> for DistancesKind
impl FromIterator<DistancesKind> for DistancesKind
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for DistancesKind
impl Hash for DistancesKind
source§impl IntoIterator for DistancesKind
impl IntoIterator for DistancesKind
source§impl LowerHex for DistancesKind
impl LowerHex for DistancesKind
source§impl Not for DistancesKind
impl Not for DistancesKind
source§impl Octal for DistancesKind
impl Octal for DistancesKind
source§impl PartialEq for DistancesKind
impl PartialEq for DistancesKind
source§fn eq(&self, other: &DistancesKind) -> bool
fn eq(&self, other: &DistancesKind) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for DistancesKind
impl PublicFlags for DistancesKind
source§impl Sub for DistancesKind
impl Sub for DistancesKind
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = DistancesKind
type Output = DistancesKind
-
operator.source§impl SubAssign for DistancesKind
impl SubAssign for DistancesKind
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.