Struct net_ensembles::watts_strogatz::SmallWorldWS [−][src]
pub struct SmallWorldWS<T, R> { /* fields omitted */ }
Expand description
Implements small-world graph ensemble
- Note the implemented traits!
Implementations
Returns neigbor distance of the initial ring
A neighbor distance of 1 means, in the original ring structure every node is connected to its two nearest neigbors, a neighbor distance of 2 means, it is connected to its 4 nearest neigbors and so on
The graph will contain neighbor_distance * system size (i.e. graph.vertex_count()) connections
retunrs rewire probability the ensemble is set to
On average, a fraction of rewire_prob nodes should be rewired
pub fn new(
n: u32,
neighbor_distance: NonZeroU32,
rewire_probability: f64,
rng: R
) -> Result<Self, WSCreationError>
pub fn new(
n: u32,
neighbor_distance: NonZeroU32,
rewire_probability: f64,
rng: R
) -> Result<Self, WSCreationError>
Initialize a WS - a small-world ensemble
n
is the system size, i.e., how many nodes there should be in the created graphsneighbor_distance
is needed for the initial ring structure. See also WS::neigbor_distancerewire_probability
- each edge will be rewired with a probability ofrewire_probability
- see also WS::rewire_probrng
- random number generator
Trait Implementations
Returns a reference to the element stored in the specified node or None
if out of Bounds
Returns a mutable reference to the element stored in the specified node or None
if out of Bounds
For a save alternative see get_contained Read more
Returns a mutable reference to the element stored in the specified node Read more
impl<'de, T, R> Deserialize<'de> for SmallWorldWS<T, R> where
T: Deserialize<'de>,
R: Deserialize<'de>,
impl<'de, T, R> Deserialize<'de> for SmallWorldWS<T, R> where
T: Deserialize<'de>,
R: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl<T, R> GraphIterators<T, GenericGraph<T, WSContainer<T>>, WSContainer<T>> for SmallWorldWS<T, R> where
T: Node + SerdeStateConform,
R: Rng,
impl<T, R> GraphIterators<T, GenericGraph<T, WSContainer<T>>, WSContainer<T>> for SmallWorldWS<T, R> where
T: Node + SerdeStateConform,
R: Rng,
fn contained_iter(&self) -> ContainedIter<'_, T, WSContainer<T>>ⓘNotable traits for ContainedIter<'a, T, A>impl<'a, T, A> Iterator for ContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a T;
fn contained_iter(&self) -> ContainedIter<'_, T, WSContainer<T>>ⓘNotable traits for ContainedIter<'a, T, A>impl<'a, T, A> Iterator for ContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a T;
impl<'a, T, A> Iterator for ContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a T;
Node
(for example EmptyNode
or whatever you used)self.container_iter().map(|container| container.contained())
fn contained_iter_neighbors(
&self,
index: usize
) -> NContainedIter<'_, T, WSContainer<T>>ⓘNotable traits for NContainedIter<'a, T, A>impl<'a, T, A> Iterator for NContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a T;
fn contained_iter_neighbors(
&self,
index: usize
) -> NContainedIter<'_, T, WSContainer<T>>ⓘNotable traits for NContainedIter<'a, T, A>impl<'a, T, A> Iterator for NContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a T;
impl<'a, T, A> Iterator for NContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a T;
index
&T
sort_adj
will affect the orderfn contained_iter_neighbors_with_index(
&self,
index: usize
) -> NIContainedIter<'_, T, WSContainer<T>>ⓘNotable traits for NIContainedIter<'a, T, A>impl<'a, T, A> Iterator for NIContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = (usize, &'a T);
fn contained_iter_neighbors_with_index(
&self,
index: usize
) -> NIContainedIter<'_, T, WSContainer<T>>ⓘNotable traits for NIContainedIter<'a, T, A>impl<'a, T, A> Iterator for NIContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = (usize, &'a T);
impl<'a, T, A> Iterator for NIContainedIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = (usize, &'a T);
index
index_neighbor
,&T
)sort_adj
will affect the order
AdjContainer<Node>
, i.e., A
fn container_iter_neighbors(
&self,
index: usize
) -> NContainerIter<'_, T, WSContainer<T>>ⓘNotable traits for NContainerIter<'a, T, A>impl<'a, T, A> Iterator for NContainerIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a A;
fn container_iter_neighbors(
&self,
index: usize
) -> NContainerIter<'_, T, WSContainer<T>>ⓘNotable traits for NContainerIter<'a, T, A>impl<'a, T, A> Iterator for NContainerIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a A;
impl<'a, T, A> Iterator for NContainerIter<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a A;
index
&T
sort_adj
will affect the orderreturns Iterator
Read more
fn dfs_with_index(&self, index: usize) -> DfsWithIndex<'_, T, WSContainer<T>>ⓘNotable traits for DfsWithIndex<'a, T, A>impl<'a, T, A> Iterator for DfsWithIndex<'a, T, A> where
T: 'a,
A: AdjContainer<T>, type Item = (usize, &'a T);
fn dfs_with_index(&self, index: usize) -> DfsWithIndex<'_, T, WSContainer<T>>ⓘNotable traits for DfsWithIndex<'a, T, A>impl<'a, T, A> Iterator for DfsWithIndex<'a, T, A> where
T: 'a,
A: AdjContainer<T>, type Item = (usize, &'a T);
impl<'a, T, A> Iterator for DfsWithIndex<'a, T, A> where
T: 'a,
A: AdjContainer<T>, type Item = (usize, &'a T);
returns Iterator
Read more
impl<T, R> GraphIteratorsMut<T, GenericGraph<T, WSContainer<T>>, WSContainer<T>> for SmallWorldWS<T, R> where
T: Node + SerdeStateConform,
R: Rng,
impl<T, R> GraphIteratorsMut<T, GenericGraph<T, WSContainer<T>>, WSContainer<T>> for SmallWorldWS<T, R> where
T: Node + SerdeStateConform,
R: Rng,
fn contained_iter_neighbors_mut(
&mut self,
index: usize
) -> NContainedIterMut<'_, T, WSContainer<T>>ⓘNotable traits for NContainedIterMut<'a, T, A>impl<'a, T, A> Iterator for NContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a mut T;
fn contained_iter_neighbors_mut(
&mut self,
index: usize
) -> NContainedIterMut<'_, T, WSContainer<T>>ⓘNotable traits for NContainedIterMut<'a, T, A>impl<'a, T, A> Iterator for NContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a mut T;
impl<'a, T, A> Iterator for NContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a mut T;
index
&mut T
sort_adj
will affect the orderfn contained_iter_neighbors_mut_with_index(
&mut self,
index: usize
) -> INContainedIterMut<'_, T, WSContainer<T>>ⓘNotable traits for INContainedIterMut<'a, T, A>impl<'a, T, A> Iterator for INContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = (usize, &'a mut T);
fn contained_iter_neighbors_mut_with_index(
&mut self,
index: usize
) -> INContainedIterMut<'_, T, WSContainer<T>>ⓘNotable traits for INContainedIterMut<'a, T, A>impl<'a, T, A> Iterator for INContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = (usize, &'a mut T);
impl<'a, T, A> Iterator for INContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = (usize, &'a mut T);
index
(index_neighbor: usize, neighbor: &mut T)
sort_adj
will affect the orderfn contained_iter_mut(&mut self) -> ContainedIterMut<'_, T, WSContainer<T>>ⓘNotable traits for ContainedIterMut<'a, T, A>impl<'a, T, A> Iterator for ContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a mut T;
fn contained_iter_mut(&mut self) -> ContainedIterMut<'_, T, WSContainer<T>>ⓘNotable traits for ContainedIterMut<'a, T, A>impl<'a, T, A> Iterator for ContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a mut T;
impl<'a, T, A> Iterator for ContainedIterMut<'a, T, A> where
T: 'a + Node,
A: AdjContainer<T>, type Item = &'a mut T;
Node
(for example EmptyNode
or whatever you used)do the following times
times: Read more
GenericGraph
Auto Trait Implementations
impl<T, R> RefUnwindSafe for SmallWorldWS<T, R> where
R: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, R> Send for SmallWorldWS<T, R> where
R: Send,
T: Send,
impl<T, R> Sync for SmallWorldWS<T, R> where
R: Sync,
T: Sync,
impl<T, R> Unpin for SmallWorldWS<T, R> where
R: Unpin,
T: Unpin,
impl<T, R> UnwindSafe for SmallWorldWS<T, R> where
R: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn cast_trunc(self) -> T
pub fn cast_trunc(self) -> T
Cast to integer, truncating Read more
pub fn cast_nearest(self) -> T
pub fn cast_nearest(self) -> T
Cast to the nearest integer Read more
pub fn cast_floor(self) -> T
pub fn cast_floor(self) -> T
Cast the floor to an integer Read more
pub fn try_cast_trunc(self) -> Result<T, Error>
pub fn try_cast_trunc(self) -> Result<T, Error>
Try converting to integer with truncation Read more
pub fn try_cast_nearest(self) -> Result<T, Error>
pub fn try_cast_nearest(self) -> Result<T, Error>
Try converting to the nearest integer Read more
pub fn try_cast_floor(self) -> Result<T, Error>
pub fn try_cast_floor(self) -> Result<T, Error>
Try converting the floor to an integer Read more
pub fn try_cast_ceil(self) -> Result<T, Error>
pub fn try_cast_ceil(self) -> Result<T, Error>
Try convert the ceiling to an integer Read more