indicate feature gating

This commit is contained in:
geo-ant 2022-11-13 17:20:21 +01:00 committed by Sébastien Crozet
parent 66dfaf824a
commit 296320bb74

View File

@ -1,6 +1,6 @@
//! Parallel iterators for matrices compatible with rayon. //! Parallel iterators for matrices compatible with rayon.
//only enables the `doc_cfg` feature when // only enables the `doc_cfg` feature when
// the `docsrs` configuration attribute is defined // the `docsrs` configuration attribute is defined
#![cfg_attr(docsrs, feature(doc_cfg))] #![cfg_attr(docsrs, feature(doc_cfg))]
@ -13,6 +13,7 @@ use rayon::{iter::plumbing::bridge, prelude::*};
/// A rayon parallel iterator over the colums of a matrix. It is created /// A rayon parallel iterator over the colums of a matrix. It is created
/// using the [`par_column_iter`] method of [`Matrix`]. /// using the [`par_column_iter`] method of [`Matrix`].
/// ///
/// *only availabe if compiled with the feature `par-iter`*
/// [`par_column_iter`]: crate::Matrix::par_column_iter /// [`par_column_iter`]: crate::Matrix::par_column_iter
/// [`Matrix`]: crate::Matrix /// [`Matrix`]: crate::Matrix
#[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))] #[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))]
@ -49,6 +50,7 @@ where
} }
#[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))] #[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))]
/// *only availabe if compiled with the feature `par-iter`*
impl<'a, T, R: Dim, Cols: Dim, S: RawStorage<T, R, Cols>> IndexedParallelIterator impl<'a, T, R: Dim, Cols: Dim, S: RawStorage<T, R, Cols>> IndexedParallelIterator
for ParColumnIter<'a, T, R, Cols, S> for ParColumnIter<'a, T, R, Cols, S>
where where
@ -74,6 +76,7 @@ where
#[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))] #[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))]
/// A rayon parallel iterator through the mutable columns of a matrix /// A rayon parallel iterator through the mutable columns of a matrix
/// *only availabe if compiled with the feature `par-iter`*
pub struct ParColumnIterMut< pub struct ParColumnIterMut<
'a, 'a,
T, T,
@ -85,6 +88,7 @@ pub struct ParColumnIterMut<
} }
#[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))] #[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))]
/// *only availabe if compiled with the feature `par-iter`*
impl<'a, T, R, Cols, S> ParColumnIterMut<'a, T, R, Cols, S> impl<'a, T, R, Cols, S> ParColumnIterMut<'a, T, R, Cols, S>
where where
R: Dim, R: Dim,
@ -98,6 +102,7 @@ where
} }
#[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))] #[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))]
/// *only availabe if compiled with the feature `par-iter`*
impl<'a, T, R, Cols, S> ParallelIterator for ParColumnIterMut<'a, T, R, Cols, S> impl<'a, T, R, Cols, S> ParallelIterator for ParColumnIterMut<'a, T, R, Cols, S>
where where
R: Dim, R: Dim,
@ -120,6 +125,7 @@ where
} }
#[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))] #[cfg_attr(doc_cfg, doc(cfg(feature = "par-iter")))]
/// *only availabe if compiled with the feature `par-iter`*
impl<'a, T, R, Cols, S> IndexedParallelIterator for ParColumnIterMut<'a, T, R, Cols, S> impl<'a, T, R, Cols, S> IndexedParallelIterator for ParColumnIterMut<'a, T, R, Cols, S>
where where
R: Dim, R: Dim,