[][src]Struct numpy::npyiter::NpySingleIter

pub struct NpySingleIter<'py, T, I> { /* fields omitted */ }

An iterator over a single array, construced by NpySingleIterBuilder. This iterator iterates all elements in the array as &mut T (in case readwrite is used) or &T (in case readonly is used).

Example

You can use NpySingleIterBuilder::readwrite to get a mutable iterator.

use numpy::NpySingleIterBuilder;
pyo3::Python::with_gil(|py| {
    let array = numpy::PyArray::arange(py, 0, 10, 1);
    let iter = NpySingleIterBuilder::readwrite(array).build().unwrap();
    for (i, elem) in iter.enumerate() {
        assert_eq!(*elem, i as i64);
        *elem = *elem * 2;  // elements are mutable
    }
});

Or, as a shorthand, PyArray::iter can be also used.

    for (i, elem) in array.iter().unwrap().enumerate() {
        assert_eq!(*elem, i as i64);
        *elem = *elem * 2;  // elements are mutable
    }
});

On the other hand, immutable iterator requires readonly array.

use numpy::NpySingleIterBuilder;
pyo3::Python::with_gil(|py| {
    let array = numpy::PyArray::arange(py, 0, 1, 10);
    let iter = NpySingleIterBuilder::readonly(array.readonly()).build().unwrap();
    for (i, elem) in iter.enumerate() {
        assert_eq!(*elem, i as i64);
    }
});

Trait Implementations

impl<'py, T, I> Drop for NpySingleIter<'py, T, I>[src]

impl<'py, T: 'py> Iterator for NpySingleIter<'py, T, Readonly>[src]

type Item = &'py T

The type of the elements being iterated over.

impl<'py, T: 'py> Iterator for NpySingleIter<'py, T, ReadWrite>[src]

type Item = &'py mut T

The type of the elements being iterated over.

Auto Trait Implementations

impl<'py, T, I> !RefUnwindSafe for NpySingleIter<'py, T, I>

impl<'py, T, I> !Send for NpySingleIter<'py, T, I>

impl<'py, T, I> !Sync for NpySingleIter<'py, T, I>

impl<'py, T, I> Unpin for NpySingleIter<'py, T, I> where
    I: Unpin,
    T: Unpin

impl<'py, T, I> !UnwindSafe for NpySingleIter<'py, T, I>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

impl<T, I> IntoPyDict for I where
    I: IntoIterator<Item = T>,
    T: PyDictItem, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.