deep_causality_physics 0.6.1

Standard library of physics formulas and engineering primitives for DeepCausality.
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

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
 */

use crate::kernels::dynamics::estimation;
use crate::kernels::dynamics::kinematics;
use crate::kernels::dynamics::kinematics::PhysicalVector;
use crate::units::energy::Energy;
use crate::{Frequency, Mass, MomentOfInertia, Probability};
use core::fmt::Debug;
use deep_causality_core::{CausalityError, PropagatingEffect};
use deep_causality_multivector::CausalMultiVector;
use deep_causality_num::RealField;
use deep_causality_tensor::CausalTensor;

/// Causal wrapper for [`estimation::kalman_filter_linear_kernel`].
pub fn kalman_filter_linear<R>(
    x_pred: &CausalTensor<R>,
    p_pred: &CausalTensor<R>,
    measurement: &CausalTensor<R>,
    measurement_matrix: &CausalTensor<R>,
    measurement_noise: &CausalTensor<R>,
    process_noise: &CausalTensor<R>,
) -> PropagatingEffect<(CausalTensor<R>, CausalTensor<R>)>
where
    R: RealField + Default + Debug + core::iter::Sum,
{
    match estimation::kalman_filter_linear_kernel(
        x_pred,
        p_pred,
        measurement,
        measurement_matrix,
        measurement_noise,
        process_noise,
    ) {
        Ok(v) => PropagatingEffect::pure(v),
        Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
    }
}

/// Causal wrapper for [`kinematics::kinetic_energy_kernel`].
pub fn kinetic_energy<R>(
    mass: &Mass<R>,
    velocity: &CausalMultiVector<R>,
) -> PropagatingEffect<Energy<R>>
where
    R: RealField + deep_causality_num::FromPrimitive + Default + Debug,
{
    match kinematics::kinetic_energy_kernel(*mass, velocity) {
        Ok(v) => match Energy::new(v) {
            Ok(e) => PropagatingEffect::pure(e),
            Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
        },
        Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
    }
}

/// Causal wrapper for [`kinematics::rotational_kinetic_energy_kernel`].
pub fn rotational_kinetic_energy<R>(
    moment_of_inertia: &MomentOfInertia<R>,
    angular_velocity: &Frequency<R>,
) -> PropagatingEffect<Energy<R>>
where
    R: RealField + deep_causality_num::FromPrimitive + Default + Debug,
{
    match kinematics::rotational_kinetic_energy_kernel(*moment_of_inertia, *angular_velocity) {
        Ok(v) => match Energy::new(v) {
            Ok(e) => PropagatingEffect::pure(e),
            Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
        },
        Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
    }
}

/// Causal wrapper for [`kinematics::torque_kernel`].
pub fn torque<R>(
    radius: &CausalMultiVector<R>,
    force: &CausalMultiVector<R>,
) -> PropagatingEffect<PhysicalVector<R>>
where
    R: RealField + Debug,
{
    match kinematics::torque_kernel(radius, force) {
        Ok(v) => PropagatingEffect::pure(v),
        Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
    }
}

/// Causal wrapper for [`kinematics::angular_momentum_kernel`].
pub fn angular_momentum<R>(
    radius: &CausalMultiVector<R>,
    momentum: &CausalMultiVector<R>,
) -> PropagatingEffect<PhysicalVector<R>>
where
    R: RealField + Debug,
{
    match kinematics::angular_momentum_kernel(radius, momentum) {
        Ok(v) => PropagatingEffect::pure(v),
        Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
    }
}

/// Causal wrapper for [`estimation::generalized_master_equation_kernel`].
pub fn generalized_master_equation<R>(
    state: &[Probability<R>],
    history: &[Vec<Probability<R>>],
    markov_operator: Option<&CausalTensor<R>>,
    memory_kernel: &[CausalTensor<R>],
) -> PropagatingEffect<Vec<Probability<R>>>
where
    R: RealField + Default + Debug,
{
    match estimation::generalized_master_equation_kernel(
        state,
        history,
        markov_operator,
        memory_kernel,
    ) {
        Ok(v) => PropagatingEffect::pure(v),
        Err(e) => PropagatingEffect::from_error(CausalityError::from(e)),
    }
}