scirs2-core 0.4.2

Core utilities and common functionality for SciRS2 (scirs2-core)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use crate::error::{CoreError, CoreResult, ErrorContext, ErrorLocation};
use ::ndarray::{ArrayBase, Dimension};

/// Checks if an array is not empty
///
/// # Arguments
///
/// * `array` - The array to check
///
/// # Returns
///
/// * `Ok(())` if the array is not empty
/// * `Err(CoreError::ValidationError)` if the array is empty
#[allow(dead_code)]
pub fn check_not_empty<S, D>(array: &ArrayBase<S, D>) -> CoreResult<()>
where
    S: crate::ndarray::Data,
    D: Dimension,
{
    if array.is_empty() {
        return Err(CoreError::ValidationError(
            ErrorContext::new("Array is empty".to_string())
                .with_location(ErrorLocation::new(file!(), line!())),
        ));
    }
    Ok(())
}

/// Checks if two arrays have matching shapes
///
/// # Arguments
///
/// * `shape1` - The shape of the first array
/// * `shape2` - The shape of the second array
///
/// # Returns
///
/// * `Ok(())` if the shapes match
/// * `Err(CoreError::ValidationError)` if the shapes don't match
#[allow(dead_code)]
pub fn checkshapes_match<D1, D2>(shape1: D1, shape2: D2) -> CoreResult<()>
where
    D1: AsRef<[usize]>,
    D2: AsRef<[usize]>,
{
    let s1 = shape1.as_ref();
    let s2 = shape2.as_ref();

    if s1 != s2 {
        return Err(CoreError::ValidationError(
            ErrorContext::new(format!("{s1:?}, {s2:?}"))
                .with_location(ErrorLocation::new(file!(), line!())),
        ));
    }
    Ok(())
}

/// Checks if a matrix is square
///
/// # Arguments
///
/// * `array` - The array to check
///
/// # Returns
///
/// * `Ok(())` if the array is square (2D with same dimensions)
/// * `Err(CoreError::ValidationError)` if the array is not square
#[allow(dead_code)]
pub fn check_square<S, D>(array: &ArrayBase<S, D>) -> CoreResult<()>
where
    S: crate::ndarray::Data,
    D: Dimension,
{
    let shape = array.shape();

    if shape.len() != 2 {
        return Err(CoreError::ValidationError(
            ErrorContext::new(format!(
                "Array must be 2D for square check, got {}D",
                shape.len()
            ))
            .with_location(ErrorLocation::new(file!(), line!())),
        ));
    }

    if shape[0] != shape[1] {
        return Err(CoreError::ValidationError(
            ErrorContext::new(format!(
                "Array must be square, got shape {:?} ({}x{})",
                shape, shape[0], shape[1]
            ))
            .with_location(ErrorLocation::new(file!(), line!())),
        ));
    }

    Ok(())
}