logisheets_controller 1.16.1

Core spreadsheet engine for LogiSheets: formula evaluation, dependency tracking, and undo/redo.
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
#![allow(dead_code)]
use logisheets_base::datetime::{EasyDate, get_serial_num_by_date_1900};

pub trait DayCountTools {
    fn coup_days(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32;
    fn coup_days_bs(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32;
    fn coup_days_nc(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32;
    fn days_between(issue: EasyDate, settlement: EasyDate, position: NumDenumPosition) -> i32;
    fn days_in_year(issue: EasyDate, settlement: EasyDate) -> f64;
}

pub struct UsPsa30_360();
pub struct Europe30_360();
pub struct Actual360();
pub struct Actual365();
pub struct ActualActual();

impl DayCountTools for UsPsa30_360 {
    fn coup_days(_: EasyDate, _: EasyDate, freq: u8) -> u32 {
        360 / freq as u32
    }

    fn coup_days_bs(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let pcd = find_previous_coupon_date(settlement, maturity, freq);
        days_diff_360_us(pcd, settlement, Method360Us::ModifyStartDate) as u32
    }

    fn coup_days_nc(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let pcd = find_previous_coupon_date(settlement, maturity, freq);
        let ncd = find_next_coupon_date(settlement, maturity, freq);
        let tot_days_in_coup = days_diff_360_us(pcd, ncd, Method360Us::ModifyBothDates);
        let days_to_settl = days_diff_360_us(pcd, settlement, Method360Us::ModifyStartDate);

        (tot_days_in_coup - days_to_settl) as u32
    }

    fn days_between(issue: EasyDate, settlement: EasyDate, _: NumDenumPosition) -> i32 {
        days_diff_360_us(issue, settlement, Method360Us::ModifyStartDate)
    }

    fn days_in_year(_issue: EasyDate, _settlement: EasyDate) -> f64 {
        360.
    }
}

impl DayCountTools for Europe30_360 {
    fn coup_days(_: EasyDate, _: EasyDate, freq: u8) -> u32 {
        360 / freq as u32
    }

    fn coup_days_bs(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let pcd = find_previous_coupon_date(settlement, maturity, freq);
        days_diff_360_eu(pcd, settlement) as u32
    }

    fn coup_days_nc(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let ncd = find_next_coupon_date(settlement, maturity, freq);
        days_diff_360_eu(settlement, ncd) as u32
    }

    fn days_between(issue: EasyDate, settlement: EasyDate, _: NumDenumPosition) -> i32 {
        days_diff_360_eu(issue, settlement)
    }

    fn days_in_year(_: EasyDate, _: EasyDate) -> f64 {
        360.
    }
}

impl DayCountTools for Actual360 {
    fn coup_days(_: EasyDate, _: EasyDate, freq: u8) -> u32 {
        360 / freq as u32
    }

    fn coup_days_bs(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let pcd = find_previous_coupon_date(settlement, maturity, freq);
        u32::from(settlement) - u32::from(pcd)
    }

    fn coup_days_nc(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let ncd = find_next_coupon_date(settlement, maturity, freq);
        u32::from(ncd) - u32::from(settlement)
    }

    fn days_between(issue: EasyDate, settlement: EasyDate, pos: NumDenumPosition) -> i32 {
        if matches!(pos, NumDenumPosition::Numerator) {
            (u32::from(settlement) - u32::from(issue)) as i32
        } else {
            days_diff_360_eu(issue, settlement)
        }
    }

    fn days_in_year(_: EasyDate, _: EasyDate) -> f64 {
        360.
    }
}

impl DayCountTools for Actual365 {
    fn coup_days(_: EasyDate, _: EasyDate, freq: u8) -> u32 {
        365 / freq as u32
    }

    fn coup_days_bs(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let pcd = find_previous_coupon_date(settlement, maturity, freq);
        u32::from(settlement) - u32::from(pcd)
    }

    fn coup_days_nc(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let ncd = find_next_coupon_date(settlement, maturity, freq);
        u32::from(ncd) - u32::from(settlement)
    }

    fn days_between(issue: EasyDate, settlement: EasyDate, position: NumDenumPosition) -> i32 {
        if matches!(position, NumDenumPosition::Numerator) {
            (u32::from(settlement) - u32::from(issue)) as i32
        } else {
            days_diff_365(issue, settlement)
        }
    }

    fn days_in_year(_: EasyDate, _: EasyDate) -> f64 {
        365.
    }
}

impl DayCountTools for ActualActual {
    fn coup_days(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let pcd = find_previous_coupon_date(settlement, maturity, freq);
        let ncd = find_next_coupon_date(settlement, maturity, freq);
        u32::from(ncd) - u32::from(pcd)
    }

    fn coup_days_bs(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let pcd = find_previous_coupon_date(settlement, maturity, freq);
        u32::from(settlement) - u32::from(pcd)
    }

    fn coup_days_nc(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
        let ncd = find_next_coupon_date(settlement, maturity, freq);
        u32::from(ncd) - u32::from(settlement)
    }

    fn days_between(issue: EasyDate, settlement: EasyDate, _: NumDenumPosition) -> i32 {
        (u32::from(settlement) - u32::from(issue)) as i32
    }

    fn days_in_year(issue: EasyDate, settlement: EasyDate) -> f64 {
        if issue.year == settlement.year {
            if issue.year % 100 == 0 && issue.year % 400 == 0 {
                return 366.;
            } else if issue.year % 4 == 0 {
                return 366.;
            } else {
                return 365.;
            }
        }
        let s_days: u32 = issue.into();
        let e_days: u32 = settlement.into();
        let actual_days = (e_days - s_days) as f64;
        let sy_first_day: u32 = EasyDate {
            year: issue.year,
            month: 1,
            day: 1,
        }
        .into();
        let ey_first_day: u32 = EasyDate {
            year: (settlement.year + 1) as u32,
            month: 1,
            day: 1,
        }
        .into();
        let average =
            ((ey_first_day - sy_first_day) as f64) / ((settlement.year - issue.year + 1) as f64);
        actual_days / average
    }
}

pub fn find_previous_coupon_date(settlement: EasyDate, maturity: EasyDate, freq: u8) -> EasyDate {
    let delta_month = -12 / freq as i32;

    let mut idx = 1;

    loop {
        let mut curr = maturity.clone();
        curr.add_delta_months(idx * delta_month);
        if curr < settlement {
            if maturity.is_last_date_of_this_month() {
                curr = curr.last_day_of_this_month();
            }
            return curr;
        } else {
            idx += 1;
        }
    }
}

pub fn find_next_coupon_date(settlement: EasyDate, maturity: EasyDate, freq: u8) -> EasyDate {
    let delta_month = -12 / freq as i32;

    let mut idx = 1;

    loop {
        let mut curr = maturity.clone();
        curr.add_delta_months(idx * delta_month);
        if curr < settlement {
            if maturity.is_last_date_of_this_month() {
                curr = curr.last_day_of_this_month();
            }

            curr.add_delta_months(-delta_month);

            if curr > maturity {
                curr = maturity
            }
            return curr;
        } else {
            idx += 1;
        }
    }
}

pub fn get_coupon_num(settlement: EasyDate, maturity: EasyDate, freq: u8) -> u32 {
    let pcd = find_previous_coupon_date(settlement, maturity, freq);
    let mut months = (maturity.year - pcd.year) * 12;
    if maturity.month >= pcd.month {
        months += (maturity.month - pcd.month) as u32;
    } else {
        months -= (pcd.month - maturity.month) as u32;
    }
    months * freq as u32 / 12
}

pub fn days_diff_360(start: EasyDate, end: EasyDate) -> i32 {
    let end_year = end.year as i32;
    let start_year = start.year as i32;
    let end_month = end.month as i32;
    let start_month = start.month as i32;
    let end_day = end.day as i32;
    let start_day = start.day as i32;
    (end_year - start_year) * 360 + (end_month - start_month) * 30 + end_day - start_day
}

// Use this function should assert the year of date is after 1900.
pub fn days_diff_365(start: EasyDate, end: EasyDate) -> i32 {
    let start_num =
        get_serial_num_by_date_1900(start.year, start.month as u32, start.day as u32).unwrap();
    let end_num = get_serial_num_by_date_1900(end.year, end.month as u32, end.day as u32).unwrap();
    let days = (end_num - start_num) as i32;
    let leap_days = (start.year..end.year).into_iter().fold(0, |prev, y| {
        if (y % 100 == 0 && y % 4 == 0) || (y % 100 != 0 && y % 4 == 0) {
            prev + 1
        } else {
            prev
        }
    });
    if end.year >= start.year {
        days - leap_days
    } else {
        days + leap_days
    }
}

pub fn days_diff_360_us(start: EasyDate, end: EasyDate, method: Method360Us) -> i32 {
    let mut sd1 = start.day as i32;
    let sm1 = start.month as i32;
    let sy1 = start.year as i32;
    let mut ed1 = end.day as i32;
    let em1 = end.month as i32;
    let ey1 = end.year as i32;

    if end.is_last_date_of_feburary()
        && (start.is_last_date_of_feburary() || matches!(method, Method360Us::ModifyStartDate))
    {
        ed1 = 30;
    }

    if ed1 == 31 && (sd1 >= 30 || matches!(method, Method360Us::ModifyBothDates)) {
        ed1 = 30;
    }

    if sd1 == 31 {
        sd1 = 30;
    }

    if start.is_last_date_of_feburary() {
        sd1 = 30;
    }

    let d1 = EasyDate {
        year: sy1 as u32,
        month: sm1 as u8,
        day: sd1 as u8,
    };
    let d2 = EasyDate {
        year: ey1 as u32,
        month: em1 as u8,
        day: ed1 as u8,
    };

    days_diff_360(d1, d2)
}

pub fn days_diff_360_eu(start: EasyDate, end: EasyDate) -> i32 {
    let mut sd1 = start.day as i32;
    let sm1 = start.month as i32;
    let sy1 = start.year as i32;
    let mut ed1 = end.day as i32;
    let em1 = end.month as i32;
    let ey1 = end.year as i32;

    if sd1 == 31 {
        sd1 = 30;
    }

    if ed1 == 31 {
        ed1 = 30;
    }

    let d1 = EasyDate {
        year: sy1 as u32,
        month: sm1 as u8,
        day: sd1 as u8,
    };
    let d2 = EasyDate {
        year: ey1 as u32,
        month: em1 as u8,
        day: ed1 as u8,
    };

    days_diff_360(d1, d2)
}

pub fn get_price_yield_factors<T: DayCountTools>(
    settlement: EasyDate,
    maturity: EasyDate,
    freq: u8,
) -> PriceYieldFactors {
    let n = get_coupon_num(settlement, maturity, freq);
    let pcd = find_previous_coupon_date(settlement, maturity, freq);
    let a = T::days_between(pcd, settlement, NumDenumPosition::Numerator);
    let e = T::coup_days(settlement, maturity, freq);
    let dsc = e as i32 - a;
    PriceYieldFactors { n, pcd, a, e, dsc }
}

pub fn get_mat_factors<T: DayCountTools>(
    settlement: EasyDate,
    maturity: EasyDate,
    issue: EasyDate,
) -> MatFactors {
    let b = T::days_in_year(issue, settlement);
    let dim = T::days_between(issue, maturity, NumDenumPosition::Numerator);
    let a = T::days_between(issue, settlement, NumDenumPosition::Numerator);
    let dsm = dim - a;
    MatFactors { b, dim, a, dsm }
}

pub fn get_common_factors<T: DayCountTools>(
    settlement: EasyDate,
    maturity: EasyDate,
) -> CommonFactors {
    let dim = T::days_between(settlement, maturity, NumDenumPosition::Numerator);
    let b = T::days_in_year(settlement, maturity);

    CommonFactors { dim, b }
}

pub enum Method360Us {
    ModifyStartDate,
    ModifyBothDates,
}

pub enum NumDenumPosition {
    Numerator,
    // Denumerator,
}

pub enum DayCountBasis {
    US30Divide360,
    ActualDivideActual,
    ActualDivide360,
    ActualDivide365,
    Euro30Divide360,
}

pub struct PriceYieldFactors {
    pub n: u32,
    pub pcd: EasyDate,
    pub a: i32,
    pub e: u32,
    pub dsc: i32,
}

pub struct MatFactors {
    pub b: f64,
    pub dim: i32,
    pub a: i32,
    pub dsm: i32,
}

pub struct CommonFactors {
    pub dim: i32,
    pub b: f64,
}