validate_cluster_extraction_params

scirs2_cluster::hierarchy::validation

Function validate_cluster_extraction_params 

Source 
pub fn validate_cluster_extraction_params<F: Float + FromPrimitive + Debug + PartialOrd + Display>(
    linkage_matrix: ArrayView2<'_, F>,
    criterion: &str,
    threshold: F,
) -> Result<()>
Expand description

Validates cluster extraction parameters

Ensures that parameters for flat cluster extraction are valid.

§Arguments

  • linkage_matrix - The linkage matrix
  • criterion - Criterion type (“distance”, “maxclust”, “inconsistent”)
  • threshold - Threshold value for the criterion

§Returns

  • Result<()> - Ok if valid, error otherwise