fekan 0.6.5

A library for building and training Kolmogorov-Arnold neural networks.
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
98
99
100
101
102
103
104
105
106
107
108
109

use super::{Edge, EdgeType, SymbolicFunction};
use std::fmt;

#[allow(private_interfaces)] // allow private interfaces for error types, since they just need to be displayed
#[derive(Debug, Clone, PartialEq)]
pub(crate) enum EdgeError {
    TooFewKnots {
        expected: usize,
        actual: usize,
    },
    BackwardBeforeForward,
    NansInControlPoints {
        offending_spline: Edge,
    },
    MergeMismatchedDegree {
        pos: usize,
        expected: usize,
        actual: usize,
    },
    MergeMismatchedControlPointCount {
        pos: usize,
        expected: usize,
        actual: usize,
    },
    MergeMismatchedKnotCount {
        pos: usize,
        expected: usize,
        actual: usize,
    },
    MergeNoEdges,
    MergeMismatchedEdgeTypes {
        pos: usize,
        expected: EdgeType,
        actual: EdgeType,
    },
    MergeMismatchedSymbolicFunctions {
        pos: usize,
        expected: SymbolicFunction,
        actual: SymbolicFunction,
    },
}

impl fmt::Display for EdgeError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            EdgeError::TooFewKnots { expected, actual } => {
                write!(
                    f,
                    "knot vector has length {}, but expected length at least {} (degree + |control points| + 1)",
                    actual, expected
                )
            }
            EdgeError::BackwardBeforeForward => {
                write!(f, "backward called before forward")
            }
            EdgeError::NansInControlPoints{offending_spline} => {
                write!(f, "updated control points contain NaN values - {:?}", offending_spline)
            }
            EdgeError::MergeMismatchedDegree {
                pos,
                expected,
                actual,
            } => write!(
                f,
                "unable to merge splines of different degree. spline at position {} has degree {}, but expected degree {}",
                pos, actual, expected
            ),
            EdgeError::MergeMismatchedControlPointCount {
                pos,
                expected,
                actual,
            } => write!(
                f,
                "unable to merge splines with different numbers of control points. spline at position {} has {} control points, but expected {}",
                pos, actual, expected
            ),
            EdgeError::MergeMismatchedKnotCount {
                pos,
                expected,
                actual,
            } => write!(
                f,
                "unable to merge splines with different numbers of knots. spline at position {} has {} knots, but expected {}",
                pos, actual, expected
            ),
            EdgeError::MergeNoEdges => write!(f, "no splines to merge"),
            EdgeError::MergeMismatchedEdgeTypes{pos, expected, actual} => write!(f, "unable to merge edges of different edge types. edge at position {} has edge type {:?}, but expected edge type {:?}", pos, actual, expected),
            EdgeError::MergeMismatchedSymbolicFunctions{pos, expected, actual} => write!(f, "unable to merge edges with different symbolic functions. edge at position {} has symbolic function {:?}, but expected symbolic function {:?}", pos, actual, expected),
        }
    }
}

impl std::error::Error for EdgeError {}

#[cfg(test)]
mod test {
    use super::*;
    #[test]
    fn test_spline_error_send() {
        fn assert_send<T: Send>() {}
        assert_send::<EdgeError>();
    }

    #[test]
    fn test_spline_error_sync() {
        fn assert_sync<T: Sync>() {}
        assert_sync::<EdgeError>();
    }
}