Skip to main content

normalize_axis

Function normalize_axis 

Source
pub fn normalize_axis(
    axis: isize,
    rank: usize,
) -> Result<usize, ValidationError>
Expand description

Normalize one signed axis against rank.

axis in 0..rank is returned unchanged; axis in -rank..0 counts from the end.

§Errors

Returns ValidationError::AxisOutOfBounds carrying the caller’s original signed axis when it is outside -rank..rank.

§Examples

use tenferro_tensor_core::{normalize_axis, ValidationError};

assert_eq!(normalize_axis(1, 3).unwrap(), 1);
assert_eq!(normalize_axis(-1, 3).unwrap(), 2);
assert_eq!(
    normalize_axis(-4, 3),
    Err(ValidationError::AxisOutOfBounds { axis: -4, rank: 3 })
);