deep_causality 0.13.5

Computational causality library. Provides causality graph, collections, context and causal reasoning.
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

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
 */
use crate::{TimeIndexable, TimeScale};

/// Trait for getting and setting the previous time index for various time scales.
///
/// This trait extends `TimeIndexable` and provides a convenient interface for interacting
/// with the "previous" time indices, as opposed to the "current" ones.
pub trait PreviousTimeIndex: TimeIndexable {
    /// Returns the previous year index, if it exists.
    ///
    /// # Returns
    ///
    /// An `Option` containing a reference to the index, or `None` if not set.
    fn get_previous_year_index(&self) -> Option<&usize> {
        let key = TimeScale::Year as usize;
        self.get_time_index(&key, false)
    }

    /// Returns the previous month index, if it exists.
    ///
    /// # Returns
    ///
    /// An `Option` containing a reference to the index, or `None` if not set.
    fn get_previous_month_index(&self) -> Option<&usize> {
        let key = TimeScale::Month as usize;
        self.get_time_index(&key, false)
    }

    /// Returns the previous week index, if it exists.
    ///
    /// # Returns
    ///
    /// An `Option` containing a reference to the index, or `None` if not set.
    fn get_previous_week_index(&self) -> Option<&usize> {
        let key = TimeScale::Week as usize;
        self.get_time_index(&key, false)
    }

    /// Returns the previous day index, if it exists.
    ///
    /// # Returns
    ///
    /// An `Option` containing a reference to the index, or `None` if not set.
    fn get_previous_day_index(&self) -> Option<&usize> {
        let key = TimeScale::Day as usize;
        self.get_time_index(&key, false)
    }

    /// Returns the previous hour index, if it exists.
    ///
    /// # Returns
    ///
    /// An `Option` containing a reference to the index, or `None` if not set.
    fn get_previous_hour_index(&self) -> Option<&usize> {
        let key = TimeScale::Hour as usize;
        self.get_time_index(&key, false)
    }

    /// Returns the previous minute index, if it exists.
    ///
    /// # Returns
    ///
    /// An `Option` containing a reference to the index, or `None` if not set.
    fn get_previous_minute_index(&self) -> Option<&usize> {
        let key = TimeScale::Minute as usize;
        self.get_time_index(&key, false)
    }

    /// Sets the previous year index.
    ///
    /// # Arguments
    ///
    /// * `index` - The index to set for the previous year.
    fn set_previous_year_index(&mut self, index: usize) {
        let key = TimeScale::Year as usize;
        self.set_time_index(key, index, false)
    }

    /// Sets the previous month index.
    ///
    /// # Arguments
    ///
    /// * `index` - The index to set for the previous month.
    fn set_previous_month_index(&mut self, index: usize) {
        let key = TimeScale::Month as usize;
        self.set_time_index(key, index, false)
    }

    /// Sets the previous week index.
    ///
    /// # Arguments
    ///
    /// * `index` - The index to set for the previous week.
    fn set_previous_week_index(&mut self, index: usize) {
        let key = TimeScale::Week as usize;
        self.set_time_index(key, index, false)
    }

    /// Sets the previous day index.
    ///
    /// # Arguments
    ///
    /// * `index` - The index to set for the previous day.
    fn set_previous_day_index(&mut self, index: usize) {
        let key = TimeScale::Day as usize;
        self.set_time_index(key, index, false)
    }

    /// Sets the previous hour index.
    ///
    /// # Arguments
    ///
    /// * `index` - The index to set for the previous hour.
    fn set_previous_hour_index(&mut self, index: usize) {
        let key = TimeScale::Hour as usize;
        self.set_time_index(key, index, false)
    }

    /// Sets the previous minute index.
    ///
    /// # Arguments
    ///
    /// * `index` - The index to set for the previous minute.
    fn set_previous_minute_index(&mut self, index: usize) {
        let key = TimeScale::Minute as usize;
        self.set_time_index(key, index, false)
    }
}