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
132
133
134
135
136
137
138
139

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

pub trait CurrentTimeIndex: TimeIndexable {
    /// Get the current year index.
    ///
    /// # Returns
    ///
    /// The current year index as a `usize`.
    ///
    fn get_current_year_index(&self) -> Option<&usize> {
        let key = TimeScale::Year as usize;
        self.get_time_index(&key, true)
    }

    /// Get the current month index.
    ///
    /// # Returns
    ///
    /// The current month index as a `usize`.
    ///
    fn get_current_month_index(&self) -> Option<&usize> {
        let key = TimeScale::Month as usize;
        self.get_time_index(&key, true)
    }

    /// Get the current week index.
    ///
    /// # Returns
    ///
    /// The current week index as a `usize`.
    ///
    fn get_current_week_index(&self) -> Option<&usize> {
        let key = TimeScale::Week as usize;
        self.get_time_index(&key, true)
    }

    /// Get the current day index.
    ///
    /// # Returns
    ///
    /// The current day index as a `usize`.
    ///
    fn get_current_day_index(&self) -> Option<&usize> {
        let key = TimeScale::Day as usize;
        self.get_time_index(&key, true)
    }

    /// Get the current hour index.
    ///
    /// # Returns
    ///
    /// The current hour index as a `usize`.
    ///
    fn get_current_hour_index(&self) -> Option<&usize> {
        let key = TimeScale::Hour as usize;
        self.get_time_index(&key, true)
    }

    /// Get the current minute index.
    ///
    /// # Returns
    ///
    /// The current minute index as a `usize`.
    ///
    fn get_current_minute_index(&self) -> Option<&usize> {
        let key = TimeScale::Minute as usize;
        self.get_time_index(&key, true)
    }

    /// Set the current year index.
    ///
    /// # Parameters
    ///
    /// * `index` - The year index to set as a `usize`
    ///
    fn set_current_year_index(&mut self, index: usize) {
        let key = TimeScale::Year as usize;
        self.set_time_index(key, index, true)
    }

    /// Set the current month index.
    ///
    /// # Parameters
    ///
    /// * `index` - The month index to set as a `usize`
    ///
    fn set_current_month_index(&mut self, index: usize) {
        let key = TimeScale::Month as usize;
        self.set_time_index(key, index, true)
    }

    /// Set the current week index.
    ///
    /// # Parameters
    ///
    /// * `index` - The week index to set as a `usize`
    ///
    fn set_current_week_index(&mut self, index: usize) {
        let key = TimeScale::Week as usize;
        self.set_time_index(key, index, true)
    }

    /// Set the current day index.
    ///
    /// # Parameters
    ///
    /// * `index` - The day index to set as a `usize`
    ///
    fn set_current_day_index(&mut self, index: usize) {
        let key = TimeScale::Day as usize;
        self.set_time_index(key, index, true)
    }

    /// Set the current hour index.
    ///
    /// # Parameters
    ///
    /// * `index` - The hour index to set as a `usize`
    ///
    fn set_current_hour_index(&mut self, index: usize) {
        let key = TimeScale::Hour as usize;
        self.set_time_index(key, index, true)
    }

    /// Set the current minute index.
    ///
    /// # Parameters
    ///
    /// * `index` - The minute index to set as a `usize`
    ///
    fn set_current_minute_index(&mut self, index: usize) {
        let key = TimeScale::Minute as usize;
        self.set_time_index(key, index, true)
    }
}