Skip to main content

validate_ncomp

Function validate_ncomp 

Source
pub fn validate_ncomp(
    ncomp: usize,
    n: usize,
    m: usize,
) -> Result<usize, FdarError>
Expand description

Validate and clamp the ncomp parameter.

Returns min(ncomp, n, m) after ensuring ncomp >= 1.

§Errors

Returns FdarError::InvalidParameter if ncomp == 0.

§Examples

use fdars_core::validation::validate_ncomp;

assert_eq!(validate_ncomp(5, 10, 20).unwrap(), 5);
assert_eq!(validate_ncomp(100, 10, 20).unwrap(), 10);
assert!(validate_ncomp(0, 10, 20).is_err());