Skip to content

Commit

Permalink
Add examples to docs for .first() and .first_mut()
Browse files Browse the repository at this point in the history
  • Loading branch information
jturner314 committed May 27, 2021
1 parent 516294b commit 68f258c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions src/impl_methods.rs
Expand Up @@ -256,6 +256,19 @@ where

/// Returns a reference to the first element of the array, or `None` if it
/// is empty.
///
/// # Example
///
/// ```rust
/// use ndarray::Array3;
///
/// let mut a = Array3::<f64>::zeros([3, 4, 2]);
/// a[[0, 0, 0]] = 42.;
/// assert_eq!(a.first(), Some(&42.));
///
/// let b = Array3::<f64>::zeros([3, 0, 5]);
/// assert_eq!(b.first(), None);
/// ```
pub fn first(&self) -> Option<&A>
where
S: Data,
Expand All @@ -269,6 +282,19 @@ where

/// Returns a mutable reference to the first element of the array, or
/// `None` if it is empty.
///
/// # Example
///
/// ```rust
/// use ndarray::Array3;
///
/// let mut a = Array3::<f64>::zeros([3, 4, 2]);
/// *a.first_mut().unwrap() = 42.;
/// assert_eq!(a[[0, 0, 0]], 42.);
///
/// let mut b = Array3::<f64>::zeros([3, 0, 5]);
/// assert_eq!(b.first_mut(), None);
/// ```
pub fn first_mut(&mut self) -> Option<&mut A>
where
S: DataMut,
Expand Down

0 comments on commit 68f258c

Please sign in to comment.