Skip to main content

roll

Function roll 

Source
pub fn roll<T, D>(
    a: &Array<T, D>,
    shift: isize,
    axis: Option<usize>,
) -> Result<Array<T, IxDyn>, FerrayError>
where T: Element, D: Dimension,
Expand description

Roll elements along an axis. Elements that roll past the end are re-introduced at the beginning.

If axis is None, the array is flattened first, then rolled.

Analogous to numpy.roll().

§Errors

Returns FerrayError::AxisOutOfBounds if axis is out of bounds.