Skip to main content

validate_unique_axes

Function validate_unique_axes 

Source
pub fn validate_unique_axes(
    op: &'static str,
    role: &'static str,
    rank: usize,
    axes: &[usize],
) -> Result<()>
Expand description

Validate a subset of axes for a tensor rank.

§Examples

use tenferro_tensor::validate::validate_unique_axes;

validate_unique_axes("reduce_sum", "axes", 3, &[0, 2])?;
assert!(validate_unique_axes("reduce_sum", "axes", 2, &[2]).is_err());
assert!(validate_unique_axes("reduce_sum", "axes", 2, &[0, 0]).is_err());

§Errors

Returns crate::Error::Validation with AxisOutOfBounds for an invalid axis or DuplicateAxis when an axis occurs more than once.

role names the argument family and is the same for every surface that validates the same list: "axes" for a reduction or reverse axis list, "dim" for a linalg dimension list. A permutation list is validated by validate_permutation_axes instead.