kosher-rust 0.1.0

Rust port of KosherJava: Jewish holidays, halachic times (zmanim), and daily learning schedules. no_std-friendly.
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
#[allow(unused_imports)]
use core_maths::*;
use jiff::{SignedDuration, Timestamp, civil::Date, tz::TimeZone};

use crate::zmanim::types::{error::ZmanimError, location::Location};

const GEOMETRIC_ZENITH: f64 = 90.0;
const REFRACTION: f64 = 34.0 / 60.0;
const SOLAR_RADIUS: f64 = 16.0 / 60.0;
const EARTH_RADIUS_KM: f64 = 6356.9;
const JULIAN_DAY_JAN_1_2000: f64 = 2_451_545.0;
const JULIAN_DAYS_PER_CENTURY: f64 = 36_525.0;
const HOUR_NANOS: f64 = 3_600_000.0 * 1_000_000.0;

#[derive(Clone, Copy)]
pub(crate) enum SolarEvent {
    Sunrise,
    Sunset,
    Noon,
    Midnight,
}

pub(crate) fn sunrise(date: Date, location: &Location, adjust_for_elevation: bool) -> Result<Timestamp, ZmanimError> {
    rise_set(
        date,
        location,
        GEOMETRIC_ZENITH,
        adjust_for_elevation,
        SolarEvent::Sunrise,
    )
}

pub(crate) fn sunset(date: Date, location: &Location, adjust_for_elevation: bool) -> Result<Timestamp, ZmanimError> {
    rise_set(
        date,
        location,
        GEOMETRIC_ZENITH,
        adjust_for_elevation,
        SolarEvent::Sunset,
    )
}

pub(crate) fn sunrise_offset_by_degrees(
    date: Date,
    location: &Location,
    degrees: f64,
) -> Result<Timestamp, ZmanimError> {
    rise_set(date, location, GEOMETRIC_ZENITH + degrees, false, SolarEvent::Sunrise)
}

pub(crate) fn sunset_offset_by_degrees(
    date: Date,
    location: &Location,
    degrees: f64,
) -> Result<Timestamp, ZmanimError> {
    rise_set(date, location, GEOMETRIC_ZENITH + degrees, false, SolarEvent::Sunset)
}

pub(crate) fn solar_noon(date: Date, location: &Location) -> Result<Timestamp, ZmanimError> {
    let adjusted_date = adjusted_local_date(date, location)?;
    let noon = solar_noon_midnight_utc(julian_day(adjusted_date), -location.longitude, SolarEvent::Noon);
    instant_from_utc_hours(
        normalize_utc_hours(noon / 60.0),
        adjusted_date,
        location,
        SolarEvent::Noon,
    )
}

pub(crate) fn solar_midnight(date: Date, location: &Location) -> Result<Timestamp, ZmanimError> {
    let adjusted_date = adjusted_local_date(date, location)?;
    let midnight = solar_noon_midnight_utc(julian_day(adjusted_date), -location.longitude, SolarEvent::Midnight);
    instant_from_utc_hours(
        normalize_utc_hours(midnight / 60.0),
        adjusted_date,
        location,
        SolarEvent::Midnight,
    )
}

pub(crate) fn time_at_azimuth(
    date: Date,
    location: &Location,
    mut target_azimuth: f64,
) -> Result<Timestamp, ZmanimError> {
    target_azimuth %= 360.0;
    if target_azimuth < 0.0 {
        target_azimuth += 360.0;
    }

    let adjusted_date = adjusted_local_date(date, location)?;
    let step = 15.0 / 60.0;
    let mut best_hour = f64::NAN;
    let mut best_error = f64::INFINITY;

    let mut hour = 0.0;
    while hour <= 24.0 {
        let instant = timestamp_from_utc_hour(adjusted_date, hour)?;
        let azimuth = solar_azimuth(instant, location)?;
        let diff = azimuth_error(azimuth, target_azimuth);
        if diff < best_error {
            best_error = diff;
            best_hour = hour;
        }
        hour += step;
    }

    if best_hour.is_nan() || best_error > 5.0 {
        return Err(ZmanimError::CalculationError);
    }

    let mut low = 0.0_f64.max(best_hour - step);
    let mut high = 24.0_f64.min(best_hour + step);

    for _ in 0..30 {
        let m1 = low + (high - low) / 3.0;
        let m2 = high - (high - low) / 3.0;
        let a1 = solar_azimuth(timestamp_from_utc_hour(adjusted_date, m1)?, location)?;
        let a2 = solar_azimuth(timestamp_from_utc_hour(adjusted_date, m2)?, location)?;
        let e1 = azimuth_error(a1, target_azimuth);
        let e2 = azimuth_error(a2, target_azimuth);
        if e1 < e2 {
            high = m2;
        } else {
            low = m1;
        }
    }

    let result = (low + high) / 2.0;
    let instant = timestamp_from_utc_hour(adjusted_date, result)?;
    let diff = azimuth_error(solar_azimuth(instant, location)?, target_azimuth);
    if diff < 0.01 {
        Ok(instant)
    } else {
        Err(ZmanimError::CalculationError)
    }
}

fn solar_azimuth(instant: Timestamp, location: &Location) -> Result<f64, ZmanimError> {
    Ok(solar_elevation_azimuth(instant, location, true))
}

fn solar_elevation_azimuth(instant: Timestamp, location: &Location, is_azimuth: bool) -> f64 {
    let lat = location.latitude.to_radians();
    let lon = location.longitude;
    let utc = instant.to_zoned(TimeZone::UTC);
    let time = utc.time();
    let fractional_day = (f64::from(time.hour())
        + (f64::from(time.minute())
            + (f64::from(time.second()) + f64::from(time.nanosecond()) / 1_000_000_000.0) / 60.0)
            / 60.0)
        / 24.0;
    let jd = julian_day(utc.date()) + fractional_day;
    let jc = julian_centuries_from_julian_day(jd);
    let decl = sun_declination(jc).to_radians();
    let eot = equation_of_time(jc);
    let true_solar_time = (fractional_day + eot / 1440.0 + lon / 360.0 + 2.0) % 1.0;
    let hour_angle = true_solar_time * 2.0 * core::f64::consts::PI - core::f64::consts::PI;
    let cos_zenith = lat.sin() * decl.sin() + lat.cos() * decl.cos() * hour_angle.cos();
    let zenith = cos_zenith.clamp(-1.0, 1.0).acos();
    let zenith_deg = zenith.to_degrees();
    let elevation = 90.0 - (zenith_deg - adjust_elevation_for_refraction(90.0 - zenith_deg));
    let az_denom = lat.cos() * zenith.sin();
    let azimuth = if az_denom.abs() > 0.001 {
        let az = (lat.sin() * zenith.cos() - decl.sin()) / az_denom;
        180.0 - az.clamp(-1.0, 1.0).acos().to_degrees() * if hour_angle > 0.0 { -1.0 } else { 1.0 }
    } else if location.latitude > 0.0 {
        180.0
    } else {
        0.0
    };

    if is_azimuth {
        (azimuth + 360.0) % 360.0
    } else {
        elevation
    }
}

fn adjust_elevation_for_refraction(elevation: f64) -> f64 {
    if elevation > 85.0 {
        return 0.0;
    }

    let te = elevation.to_radians().tan();
    let correction = if elevation > 5.0 {
        58.1 / te - 0.07 / te.powi(3) + 0.000086 / te.powi(5)
    } else if elevation > -0.575 {
        1735.0 + elevation * (-518.2 + elevation * (103.4 + elevation * (-12.79 + 0.711 * elevation)))
    } else {
        -20.774 / te
    };
    correction / 3600.0
}

fn azimuth_error(azimuth: f64, target_azimuth: f64) -> f64 {
    let diff = (azimuth - target_azimuth).abs() % 360.0;
    diff.min(360.0 - diff)
}

fn timestamp_from_utc_hour(date: Date, hour: f64) -> Result<Timestamp, ZmanimError> {
    let nanos = (hour * HOUR_NANOS).round() as i64;
    date.at(0, 0, 0, 0)
        .checked_add(SignedDuration::from_nanos(nanos))
        .map_err(|_| ZmanimError::TimeConversionError)?
        .to_zoned(TimeZone::UTC)
        .map_err(|_| ZmanimError::TimeConversionError)
        .map(|zdt| zdt.timestamp())
}

fn rise_set(
    date: Date,
    location: &Location,
    zenith: f64,
    adjust_for_elevation: bool,
    event: SolarEvent,
) -> Result<Timestamp, ZmanimError> {
    let adjusted_date = adjusted_local_date(date, location)?;
    let elevation = if adjust_for_elevation { location.elevation } else { 0.0 };
    let adjusted_zenith = adjust_zenith(zenith, elevation);
    let utc_minutes = sun_rise_set_utc(
        adjusted_date,
        location.latitude,
        -location.longitude,
        adjusted_zenith,
        event,
    )?;
    instant_from_utc_hours(normalize_utc_hours(utc_minutes / 60.0), adjusted_date, location, event)
}

pub(crate) fn adjusted_local_date(date: Date, location: &Location) -> Result<Date, ZmanimError> {
    let Some(timezone) = &location.timezone else {
        return Ok(date);
    };

    let midnight = timezone
        .to_ambiguous_timestamp(date.at(0, 0, 0, 0))
        .earlier()
        .map_err(|_| ZmanimError::TimeConversionError)?;
    let offset = midnight.to_zoned(timezone.clone()).offset().seconds();
    let local_hours_offset = (location.longitude * 240.0 - f64::from(offset)) / 3600.0;

    if local_hours_offset >= 20.0 {
        add_days(date, 1)
    } else if local_hours_offset <= -20.0 {
        add_days(date, -1)
    } else {
        Ok(date)
    }
}

fn instant_from_utc_hours(
    time: f64,
    mut date: Date,
    location: &Location,
    event: SolarEvent,
) -> Result<Timestamp, ZmanimError> {
    if time.is_nan() {
        return Err(ZmanimError::CalculationError);
    }

    let local_time_hours = location.longitude / 15.0 + time;
    match event {
        SolarEvent::Sunrise if local_time_hours > 18.0 => date = add_days(date, -1)?,
        SolarEvent::Sunset if local_time_hours < 6.0 => date = add_days(date, 1)?,
        SolarEvent::Midnight if local_time_hours < 12.0 => date = add_days(date, 1)?,
        SolarEvent::Noon if local_time_hours < 0.0 => date = add_days(date, 1)?,
        SolarEvent::Noon if local_time_hours > 24.0 => date = add_days(date, -1)?,
        _ => {}
    }

    let nanos = (time * HOUR_NANOS).round() as i64;
    let date_time = date
        .at(0, 0, 0, 0)
        .checked_add(SignedDuration::from_nanos(nanos))
        .map_err(|_| ZmanimError::TimeConversionError)?;
    date_time
        .to_zoned(TimeZone::UTC)
        .map_err(|_| ZmanimError::TimeConversionError)
        .map(|zdt| zdt.timestamp())
}

fn add_days(date: Date, days: i64) -> Result<Date, ZmanimError> {
    date.checked_add(SignedDuration::from_hours(24 * days))
        .map_err(|_| ZmanimError::TimeConversionError)
}

fn normalize_utc_hours(time: f64) -> f64 {
    if time > 0.0 { time % 24.0 } else { time % 24.0 + 24.0 }
}

fn adjust_zenith(zenith: f64, elevation: f64) -> f64 {
    if zenith == GEOMETRIC_ZENITH {
        zenith + SOLAR_RADIUS + REFRACTION + elevation_adjustment(elevation)
    } else {
        zenith
    }
}

fn elevation_adjustment(elevation_m: f64) -> f64 {
    (EARTH_RADIUS_KM / (EARTH_RADIUS_KM + elevation_m / 1000.0))
        .acos()
        .to_degrees()
}

fn julian_day(date: Date) -> f64 {
    let mut year = i32::from(date.year());
    let mut month = i32::from(date.month());
    let day = i32::from(date.day());

    if month <= 2 {
        year -= 1;
        month += 12;
    }

    let a = year / 100;
    let b = 2 - a + a / 4;

    (365.25 * f64::from(year + 4716)).floor() + (30.6001 * f64::from(month + 1)).floor() + f64::from(day) + f64::from(b)
        - 1524.5
}

fn julian_centuries_from_julian_day(julian_day: f64) -> f64 {
    (julian_day - JULIAN_DAY_JAN_1_2000) / JULIAN_DAYS_PER_CENTURY
}

fn sun_geometric_mean_longitude(julian_centuries: f64) -> f64 {
    let longitude = 280.46646 + julian_centuries * (36000.76983 + 0.0003032 * julian_centuries);
    if longitude > 0.0 {
        longitude % 360.0
    } else {
        longitude % 360.0 + 360.0
    }
}

fn sun_geometric_mean_anomaly(julian_centuries: f64) -> f64 {
    357.52911 + julian_centuries * (35999.05029 - 0.0001537 * julian_centuries)
}

fn earth_orbit_eccentricity(julian_centuries: f64) -> f64 {
    0.016708634 - julian_centuries * (0.000042037 + 0.0000001267 * julian_centuries)
}

fn sun_equation_of_center(julian_centuries: f64) -> f64 {
    let m = sun_geometric_mean_anomaly(julian_centuries);
    let mrad = m.to_radians();
    let sinm = mrad.sin();
    let sin2m = (mrad + mrad).sin();
    let sin3m = (mrad + mrad + mrad).sin();
    sinm * (1.914602 - julian_centuries * (0.004817 + 0.000014 * julian_centuries))
        + sin2m * (0.019993 - 0.000101 * julian_centuries)
        + sin3m * 0.000289
}

fn sun_true_longitude(julian_centuries: f64) -> f64 {
    sun_geometric_mean_longitude(julian_centuries) + sun_equation_of_center(julian_centuries)
}

fn sun_apparent_longitude(julian_centuries: f64) -> f64 {
    let omega = 125.04 - 1934.136 * julian_centuries;
    sun_true_longitude(julian_centuries) - 0.00569 - 0.00478 * omega.to_radians().sin()
}

fn mean_obliquity_of_ecliptic(julian_centuries: f64) -> f64 {
    let seconds = 21.448 - julian_centuries * (46.8150 + julian_centuries * (0.00059 - julian_centuries * 0.001813));
    23.0 + (26.0 + seconds / 60.0) / 60.0
}

fn obliquity_correction(julian_centuries: f64) -> f64 {
    let omega = 125.04 - 1934.136 * julian_centuries;
    mean_obliquity_of_ecliptic(julian_centuries) + 0.00256 * omega.to_radians().cos()
}

fn sun_declination(julian_centuries: f64) -> f64 {
    let obliquity_correction = obliquity_correction(julian_centuries);
    let lambda = sun_apparent_longitude(julian_centuries);
    let sint = obliquity_correction.to_radians().sin() * lambda.to_radians().sin();
    sint.asin().to_degrees()
}

fn equation_of_time(julian_centuries: f64) -> f64 {
    let epsilon = obliquity_correction(julian_centuries);
    let geom_mean_long_sun = sun_geometric_mean_longitude(julian_centuries);
    let eccentricity_earth_orbit = earth_orbit_eccentricity(julian_centuries);
    let geom_mean_anomaly_sun = sun_geometric_mean_anomaly(julian_centuries);
    let mut y = (epsilon.to_radians() / 2.0).tan();
    y *= y;

    let sin2l0 = (2.0 * geom_mean_long_sun.to_radians()).sin();
    let sinm = geom_mean_anomaly_sun.to_radians().sin();
    let cos2l0 = (2.0 * geom_mean_long_sun.to_radians()).cos();
    let sin4l0 = (4.0 * geom_mean_long_sun.to_radians()).sin();
    let sin2m = (2.0 * geom_mean_anomaly_sun.to_radians()).sin();
    let equation_of_time = y * sin2l0 - 2.0 * eccentricity_earth_orbit * sinm
        + 4.0 * eccentricity_earth_orbit * y * sinm * cos2l0
        - 0.5 * y * y * sin4l0
        - 1.25 * eccentricity_earth_orbit * eccentricity_earth_orbit * sin2m;
    equation_of_time.to_degrees() * 4.0
}

fn sun_hour_angle(latitude: f64, solar_declination: f64, zenith: f64, event: SolarEvent) -> Result<f64, ZmanimError> {
    let lat_rad = latitude.to_radians();
    let sd_rad = solar_declination.to_radians();
    let cos_hour_angle = zenith.to_radians().cos() / (lat_rad.cos() * sd_rad.cos()) - lat_rad.tan() * sd_rad.tan();

    if cos_hour_angle > 1.0 {
        return Err(ZmanimError::AllNight);
    }
    if cos_hour_angle < -1.0 {
        return Err(ZmanimError::AllDay);
    }

    let mut hour_angle = cos_hour_angle.acos();
    if matches!(event, SolarEvent::Sunset) {
        hour_angle = -hour_angle;
    }
    Ok(hour_angle)
}

fn solar_noon_midnight_utc(mut julian_day: f64, longitude: f64, event: SolarEvent) -> f64 {
    julian_day = if matches!(event, SolarEvent::Noon) {
        julian_day
    } else {
        julian_day + 0.5
    };
    let tnoon = julian_centuries_from_julian_day(julian_day + longitude / 360.0);
    let mut eq_time = equation_of_time(tnoon);
    let mut sol_noon_utc = longitude * 4.0 - eq_time;

    for _ in 0..2 {
        let newt = julian_centuries_from_julian_day(julian_day + sol_noon_utc / 1440.0);
        eq_time = equation_of_time(newt);
        sol_noon_utc = if matches!(event, SolarEvent::Noon) {
            720.0
        } else {
            1440.0
        } + longitude * 4.0
            - eq_time;
    }

    (if matches!(event, SolarEvent::Noon) {
        720.0
    } else {
        1440.0
    }) + longitude * 4.0
        - eq_time
}

fn sun_rise_set_utc(
    local_date: Date,
    latitude: f64,
    longitude: f64,
    zenith: f64,
    event: SolarEvent,
) -> Result<f64, ZmanimError> {
    let julian_day = julian_day(local_date);
    let noon_min = solar_noon_midnight_utc(julian_day, longitude, SolarEvent::Noon);
    let tnoon = julian_centuries_from_julian_day(julian_day + noon_min / 1440.0);
    let mut eq_time = equation_of_time(tnoon);
    let mut solar_declination = sun_declination(tnoon);
    let mut hour_angle = sun_hour_angle(latitude, solar_declination, zenith, event)?;
    let mut delta = longitude - hour_angle.to_degrees();
    let mut time_diff = 4.0 * delta;
    let mut time_utc = 720.0 + time_diff - eq_time;

    let newt = julian_centuries_from_julian_day(julian_day + time_utc / 1440.0);
    eq_time = equation_of_time(newt);
    solar_declination = sun_declination(newt);
    hour_angle = sun_hour_angle(latitude, solar_declination, zenith, event)?;
    delta = longitude - hour_angle.to_degrees();
    time_diff = 4.0 * delta;
    time_utc = 720.0 + time_diff - eq_time;
    Ok(time_utc)
}