conspire 0.6.0

The Rust interface to conspire.
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

#[cfg(test)]
mod test;

#[cfg(test)]
use super::test::ErrorTensor;

pub mod list;
pub mod list_2d;

use super::{Hessian, Jacobian, Solution, SquareMatrix, Tensor, TensorArray, Vector};
use std::ops::Sub;

/// A tensor of rank 0 (a scalar).
pub type TensorRank0 = f64;

#[cfg(test)]
impl ErrorTensor for TensorRank0 {
    fn error_fd(&self, comparator: &Self, epsilon: TensorRank0) -> Option<(bool, usize)> {
        if ((self / comparator - 1.0).abs() >= epsilon && (self - comparator).abs() >= epsilon)
            || self.is_nan()
            || comparator.is_nan()
        {
            Some((true, 1))
        } else {
            None
        }
    }
}

impl Solution for TensorRank0 {
    fn decrement_from(&mut self, _other: &Vector) {
        unimplemented!()
    }
    fn decrement_from_chained(&mut self, _other: &mut Vector, _vector: Vector) {
        unimplemented!()
    }
}

impl Jacobian for TensorRank0 {
    fn fill_into(self, _vector: &mut Vector) {
        unimplemented!()
    }
    fn fill_into_chained(self, _other: Vector, _vector: &mut Vector) {
        unimplemented!()
    }
}

impl Sub<Vector> for TensorRank0 {
    type Output = Self;
    fn sub(self, _vector: Vector) -> Self::Output {
        unimplemented!()
    }
}

impl Sub<&Vector> for TensorRank0 {
    type Output = Self;
    fn sub(self, _vector: &Vector) -> Self::Output {
        unimplemented!()
    }
}

impl Hessian for TensorRank0 {
    fn fill_into(self, _square_matrix: &mut SquareMatrix) {
        unimplemented!()
    }
}

impl Tensor for TensorRank0 {
    type Item = TensorRank0;
    fn error_count(
        &self,
        other: &Self,
        tol_abs: TensorRank0,
        tol_rel: TensorRank0,
    ) -> Option<usize> {
        if (self.sub_abs(other) < tol_abs || self.sub_rel(other) < tol_rel)
            && !self.is_nan()
            && !other.is_nan()
        {
            None
        } else {
            Some(1)
        }
    }
    fn full_contraction(&self, tensor_rank_0: &Self) -> TensorRank0 {
        self * tensor_rank_0
    }
    fn is_zero(&self) -> bool {
        self == &0.0
    }
    fn iter(&self) -> impl Iterator<Item = &Self::Item> {
        [0.0].iter()
    }
    fn iter_mut(&mut self) -> impl Iterator<Item = &mut Self::Item> {
        [self].into_iter()
    }
    fn len(&self) -> usize {
        1
    }
    fn norm_inf(&self) -> TensorRank0 {
        self.abs()
    }
    fn normalized(self) -> Self {
        1.0
    }
    fn size(&self) -> usize {
        1
    }
    fn sub_abs(&self, other: &Self) -> Self {
        (self - other).abs()
    }
    fn sub_rel(&self, other: &Self) -> Self {
        if other == &0.0 {
            if self == &0.0 { 0.0 } else { 1.0 }
        } else {
            (self / other - 1.0).abs()
        }
    }
}

impl TensorArray for TensorRank0 {
    type Array = Self;
    type Item = TensorRank0;
    fn as_array(&self) -> Self::Array {
        *self
    }
    fn identity() -> Self {
        1.0
    }
    fn zero() -> Self {
        0.0
    }
}

impl From<Vector> for TensorRank0 {
    fn from(_vector: Vector) -> Self {
        unimplemented!()
    }
}