Skip to main content

validate_axis

Function validate_axis 

Source
pub fn validate_axis(axis: u32, rank: u32) -> Result<()>
Expand description

Validates that axis is a valid axis index for a tensor of the given rank.

Per the spec, axis MUST satisfy axis < rank.

§Errors

§Examples

use hurray_core::validate_axis;

assert!(validate_axis(0, 3).is_ok());
assert!(validate_axis(2, 3).is_ok());
assert!(validate_axis(3, 3).is_err()); // axis == rank is out of bounds
assert!(validate_axis(0, 0).is_err()); // rank 0 means no valid axis