1use nalgebra::Vector3;
2use std::cmp::Ordering;
3use std::f64::consts::PI;
4use thiserror::Error;
5
6const KMH_TO_MPS: f64 = 1000.0 / 3600.0;
8
9pub fn wind_vector(speed_mps: f64, direction_rad: f64, vertical_mps: f64) -> Vector3<f64> {
14 Vector3::new(
15 -speed_mps * direction_rad.cos(),
16 vertical_mps,
17 -speed_mps * direction_rad.sin(),
18 )
19}
20
21#[derive(Debug, Clone, Copy, PartialEq, Default)]
28pub struct WindSegment {
29 pub speed_kmh: f64,
30 pub angle_deg: f64,
31 pub until_m: f64,
32 pub vertical_mps: f64,
33}
34
35impl WindSegment {
36 pub fn new(speed_kmh: f64, angle_deg: f64, until_m: f64) -> Self {
39 Self {
40 speed_kmh,
41 angle_deg,
42 until_m,
43 vertical_mps: 0.0,
44 }
45 }
46}
47
48pub(crate) fn sort_wind_segments_by_distance(segments: &mut [WindSegment]) {
53 segments.sort_by(|a, b| match (a.until_m.is_nan(), b.until_m.is_nan()) {
54 (true, true) => Ordering::Equal,
55 (true, false) => Ordering::Greater,
56 (false, true) => Ordering::Less,
57 (false, false) => {
58 a.until_m
59 .partial_cmp(&b.until_m)
60 .expect("non-NaN distances are ordered")
61 }
62 });
63}
64
65#[derive(Debug, Clone, Copy, PartialEq, Eq)]
67pub enum WindSegmentField {
68 SpeedKmh,
69 AngleDeg,
70 UntilM,
71 VerticalMps,
72}
73
74impl WindSegmentField {
75 pub fn name(self) -> &'static str {
77 match self {
78 WindSegmentField::SpeedKmh => "speed_kmh",
79 WindSegmentField::AngleDeg => "angle_deg",
80 WindSegmentField::UntilM => "until_m",
81 WindSegmentField::VerticalMps => "vertical_mps",
82 }
83 }
84}
85
86impl std::fmt::Display for WindSegmentField {
87 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
88 f.write_str(self.name())
89 }
90}
91
92#[derive(Debug, Clone, Copy, PartialEq, Eq)]
94pub enum WindSegmentRule {
95 Finite,
97 FiniteAndNonNegative,
99 FiniteAndPositive,
101}
102
103impl std::fmt::Display for WindSegmentRule {
104 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
105 f.write_str(match self {
108 WindSegmentRule::Finite => "finite",
109 WindSegmentRule::FiniteAndNonNegative => "finite and non-negative",
110 WindSegmentRule::FiniteAndPositive => "finite and greater than zero",
111 })
112 }
113}
114
115#[derive(Debug, Clone, Copy, PartialEq, Eq, Error)]
121#[error("wind.segments[{index}].{field} must be {rule}")]
122pub struct WindSegmentError {
123 pub index: usize,
124 pub field: WindSegmentField,
125 pub rule: WindSegmentRule,
126}
127
128pub fn validate_wind_segments(segments: &[WindSegment]) -> Result<(), WindSegmentError> {
135 for (index, segment) in segments.iter().enumerate() {
136 let err = |field, rule| Err(WindSegmentError { index, field, rule });
137
138 if !segment.speed_kmh.is_finite() || segment.speed_kmh < 0.0 {
139 return err(
140 WindSegmentField::SpeedKmh,
141 WindSegmentRule::FiniteAndNonNegative,
142 );
143 }
144 if !segment.angle_deg.is_finite() {
145 return err(WindSegmentField::AngleDeg, WindSegmentRule::Finite);
146 }
147 if !segment.until_m.is_finite() || segment.until_m <= 0.0 {
148 return err(WindSegmentField::UntilM, WindSegmentRule::FiniteAndPositive);
149 }
150 if !segment.vertical_mps.is_finite() {
151 return err(WindSegmentField::VerticalMps, WindSegmentRule::Finite);
152 }
153 }
154
155 Ok(())
156}
157
158#[derive(Debug, Clone)]
160pub struct WindSock {
161 winds: Vec<WindSegment>,
163 wind_vecs: Vec<Vector3<f64>>,
166 current: usize,
168 next_range: f64,
170 current_vec: Vector3<f64>,
172 validation_error: Option<WindSegmentError>,
174}
175
176impl WindSock {
177 pub fn new(segments: Vec<WindSegment>) -> Self {
188 let validation_error = validate_wind_segments(&segments).err();
191 Self::build_unchecked(segments, validation_error)
192 }
193
194 pub fn try_new(segments: Vec<WindSegment>) -> Result<Self, WindSegmentError> {
201 validate_wind_segments(&segments)?;
202 Ok(Self::build_unchecked(segments, None))
203 }
204
205 fn build_unchecked(
207 mut segments: Vec<WindSegment>,
208 validation_error: Option<WindSegmentError>,
209 ) -> Self {
210 sort_wind_segments_by_distance(&mut segments);
212
213 let wind_vecs: Vec<Vector3<f64>> = segments.iter().map(Self::calc_vec).collect();
215
216 let (current, next_range, current_vec) = if segments.is_empty() {
217 (0, f64::INFINITY, Vector3::zeros())
218 } else {
219 (0, segments[0].until_m, wind_vecs[0])
220 };
221
222 WindSock {
223 winds: segments,
224 wind_vecs,
225 current,
226 next_range,
227 current_vec,
228 validation_error,
229 }
230 }
231
232 pub(crate) fn validate_segments(&self) -> Result<(), String> {
234 self.validation_error
235 .map_or(Ok(()), |err| Err(err.to_string()))
236 }
237
238 fn calc_vec(seg: &WindSegment) -> Vector3<f64> {
240 let speed_mps = seg.speed_kmh * KMH_TO_MPS;
242 let angle_rad = if seg.angle_deg.abs() <= f64::MAX / PI {
245 seg.angle_deg * PI / 180.0
246 } else {
247 seg.angle_deg / 180.0 * PI
248 };
249
250 wind_vector(speed_mps, angle_rad, seg.vertical_mps)
259 }
260
261 pub fn max_speed_mps(&self) -> f64 {
264 self.winds
265 .iter()
266 .map(|seg| seg.speed_kmh.abs() * KMH_TO_MPS + seg.vertical_mps.abs())
267 .fold(0.0, f64::max)
268 }
269
270 pub(crate) fn muzzle_crosswind_from_right_mps(&self) -> Option<f64> {
274 (!self.winds.is_empty()).then(|| -self.vector_for_range_stateless(0.0)[2])
275 }
276
277 pub fn vector_for_range(&mut self, range_m: f64) -> Vector3<f64> {
282 if range_m.is_nan() {
284 return Vector3::zeros();
285 }
286
287 while range_m >= self.next_range && self.current < self.winds.len() {
290 self.current += 1;
291 if self.current >= self.winds.len() {
292 self.current_vec = Vector3::zeros();
293 self.next_range = f64::INFINITY;
294 } else {
295 self.current_vec = self.wind_vecs[self.current];
296 self.next_range = self.winds[self.current].until_m;
297 }
298 }
299
300 self.current_vec
301 }
302
303 pub fn vector_for_range_stateless(&self, range_m: f64) -> Vector3<f64> {
308 if range_m.is_nan() {
310 return Vector3::zeros();
311 }
312
313 for (i, segment) in self.winds.iter().enumerate() {
315 if range_m < segment.until_m {
316 return self.wind_vecs[i];
317 }
318 }
319
320 Vector3::zeros()
322 }
323}
324
325impl TryFrom<Vec<WindSegment>> for WindSock {
327 type Error = WindSegmentError;
328
329 fn try_from(segments: Vec<WindSegment>) -> Result<Self, Self::Error> {
330 WindSock::try_new(segments)
331 }
332}
333
334pub fn parse_wind_segment_str(s: &str, imperial: bool) -> Result<WindSegment, String> {
348 let parts: Vec<&str> = s.split(':').collect();
349 if parts.len() != 3 && parts.len() != 4 {
350 return Err(format!(
351 "invalid wind segment '{s}': expected SPEED:ANGLE:UNTIL_DISTANCE[:VERTICAL] \
352 (three or four colon-separated numbers; the optional 4th field VERTICAL is always \
353 m/s, positive = updraft, regardless of --units)"
354 ));
355 }
356 let num = |i: usize, name: &str| -> Result<f64, String> {
357 parts[i].trim().parse::<f64>().map_err(|_| {
358 format!("invalid wind segment '{s}': {name} '{}' is not a number", parts[i])
359 })
360 };
361 let speed = num(0, "speed")?;
362 let angle = num(1, "angle")?;
363 let until = num(2, "until-distance")?;
364 let vertical = if parts.len() == 4 {
365 num(3, "vertical")?
366 } else {
367 0.0
368 };
369 if !speed.is_finite() || !angle.is_finite() || !until.is_finite() || !vertical.is_finite() {
370 return Err(format!(
371 "invalid wind segment '{s}': speed, angle, until-distance, and vertical (m/s, \
372 positive = updraft) must be finite numbers"
373 ));
374 }
375 if speed < 0.0 {
376 return Err(format!("invalid wind segment '{s}': speed must be >= 0"));
377 }
378 if until <= 0.0 {
379 return Err(format!("invalid wind segment '{s}': until-distance must be > 0"));
380 }
381 let (speed_kmh, until_m) = if imperial {
382 (speed * 1.609344, until * 0.9144) } else {
384 (speed * 3.6, until) };
386 let mut segment = WindSegment::new(speed_kmh, angle, until_m);
387 segment.vertical_mps = vertical;
388 Ok(segment)
389}
390
391#[cfg(test)]
392mod tests {
393 use super::*;
394
395 #[test]
396 fn segment_sort_is_stable_and_places_nan_endpoints_last() {
397 let mut segments = vec![
398 WindSegment::new(10.0, 0.0, f64::NAN),
399 WindSegment::new(20.0, 0.0, 100.0),
400 WindSegment::new(30.0, 0.0, 100.0),
401 WindSegment::new(40.0, 0.0, f64::INFINITY),
402 WindSegment::new(50.0, 0.0, f64::NEG_INFINITY),
403 WindSegment::new(60.0, 0.0, f64::NAN),
404 ];
405
406 sort_wind_segments_by_distance(&mut segments);
407
408 assert_eq!(segments[0].speed_kmh, 50.0); assert_eq!(segments[1].speed_kmh, 20.0); assert_eq!(segments[2].speed_kmh, 30.0);
411 assert_eq!(segments[3].speed_kmh, 40.0); assert_eq!(segments[4].speed_kmh, 10.0); assert_eq!(segments[5].speed_kmh, 60.0);
414 assert!(segments[4].until_m.is_nan() && segments[5].until_m.is_nan());
415 }
416
417 #[test]
418 fn test_wind_sock_empty() {
419 let sock = WindSock::new(vec![]);
420 assert_eq!(sock.vector_for_range_stateless(50.0), Vector3::zeros());
421 assert_eq!(sock.muzzle_crosswind_from_right_mps(), None);
422 }
423
424 #[test]
425 fn try_new_accepts_valid_and_empty_segments() {
426 assert!(WindSock::try_new(vec![]).is_ok());
427 let sock = WindSock::try_new(vec![WindSegment::new(16.0934, 90.0, 100.0)]).unwrap();
428 assert!(sock.vector_for_range_stateless(50.0).norm() > 0.0);
429 assert!(WindSock::try_from(vec![WindSegment::new(10.0, 0.0, 50.0)]).is_ok());
431 assert!(WindSock::try_from(vec![WindSegment::new(f64::NAN, 0.0, 50.0)]).is_err());
432 }
433
434 #[test]
435 fn try_new_rejects_each_field_with_typed_index_field_rule() {
436 let ok = WindSegment::new(10.0, 0.0, 100.0);
439 let cases: Vec<(WindSegment, WindSegmentField, WindSegmentRule)> = vec![
440 (
441 WindSegment::new(f64::NAN, 0.0, 100.0),
442 WindSegmentField::SpeedKmh,
443 WindSegmentRule::FiniteAndNonNegative,
444 ),
445 (
446 WindSegment::new(-1.0, 0.0, 100.0),
447 WindSegmentField::SpeedKmh,
448 WindSegmentRule::FiniteAndNonNegative,
449 ),
450 (
451 WindSegment::new(10.0, f64::INFINITY, 100.0),
452 WindSegmentField::AngleDeg,
453 WindSegmentRule::Finite,
454 ),
455 (
456 WindSegment::new(10.0, 0.0, 0.0),
457 WindSegmentField::UntilM,
458 WindSegmentRule::FiniteAndPositive,
459 ),
460 (
461 WindSegment::new(10.0, 0.0, f64::NEG_INFINITY),
462 WindSegmentField::UntilM,
463 WindSegmentRule::FiniteAndPositive,
464 ),
465 (
466 WindSegment {
467 vertical_mps: f64::NAN,
468 ..ok
469 },
470 WindSegmentField::VerticalMps,
471 WindSegmentRule::Finite,
472 ),
473 ];
474 for (bad, field, rule) in cases {
475 let err = WindSock::try_new(vec![ok, bad]).unwrap_err();
478 assert_eq!(err.index, 1, "index for {field}");
479 assert_eq!(err.field, field);
480 assert_eq!(err.rule, rule);
481 }
482 }
483
484 #[test]
485 fn try_new_error_index_is_the_callers_presort_index() {
486 let err = WindSock::try_new(vec![
489 WindSegment::new(10.0, 0.0, 500.0),
490 WindSegment::new(20.0, 0.0, 300.0),
491 WindSegment::new(f64::NAN, 0.0, 1.0),
492 ])
493 .unwrap_err();
494 assert_eq!(err.index, 2);
495 assert_eq!(err.field, WindSegmentField::SpeedKmh);
496 }
497
498 #[test]
499 fn wind_segment_error_display_matches_legacy_strings() {
500 let err = WindSock::try_new(vec![WindSegment::new(f64::NAN, 0.0, 100.0)]).unwrap_err();
503 assert_eq!(
504 err.to_string(),
505 "wind.segments[0].speed_kmh must be finite and non-negative"
506 );
507 let err = WindSock::try_new(vec![WindSegment::new(10.0, 0.0, -5.0)]).unwrap_err();
508 assert_eq!(
509 err.to_string(),
510 "wind.segments[0].until_m must be finite and greater than zero"
511 );
512 let err = WindSock::try_new(vec![WindSegment {
513 vertical_mps: f64::INFINITY,
514 ..WindSegment::new(10.0, 0.0, 100.0)
515 }])
516 .unwrap_err();
517 assert_eq!(
518 err.to_string(),
519 "wind.segments[0].vertical_mps must be finite"
520 );
521 }
522
523 #[test]
524 fn infallible_new_still_defers_the_same_error() {
525 let sock = WindSock::new(vec![WindSegment::new(10.0, f64::NAN, 100.0)]);
528 assert_eq!(
529 sock.validate_segments().unwrap_err(),
530 "wind.segments[0].angle_deg must be finite"
531 );
532 }
533
534 #[test]
535 fn muzzle_crosswind_distinguishes_an_explicit_zero_segment() {
536 let sock = WindSock::new(vec![WindSegment::new(0.0, 90.0, 100.0)]);
537 assert_eq!(sock.muzzle_crosswind_from_right_mps(), Some(0.0));
538 }
539
540 #[test]
541 fn muzzle_crosswind_uses_the_sorted_muzzle_segment_and_wind_from_sign() {
542 let from_right = WindSock::new(vec![
543 WindSegment::new(32.18688, 270.0, 5000.0),
544 WindSegment::new(16.09344, 90.0, 100.0),
545 ]);
546 let right_mps = from_right.muzzle_crosswind_from_right_mps().unwrap();
547 assert!((right_mps - 4.4704).abs() < 1e-12);
548
549 let from_left = WindSock::new(vec![WindSegment::new(16.09344, 270.0, 100.0)]);
550 let left_mps = from_left.muzzle_crosswind_from_right_mps().unwrap();
551 assert!((left_mps + 4.4704).abs() < 1e-12);
552 }
553
554 #[test]
555 fn test_wind_sock_single_segment() {
556 let sock = WindSock::new(vec![WindSegment::new(16.0934, 90.0, 100.0)]);
558
559 let vec_50 = sock.vector_for_range_stateless(50.0);
561 println!("vec_50 = [{}, {}, {}]", vec_50[0], vec_50[1], vec_50[2]);
562 assert!(vec_50.norm() > 0.0);
563 assert!(
565 vec_50[2] < 0.0,
566 "Z (lateral) should be negative for 90° wind, got {}",
567 vec_50[2]
568 );
569 assert_eq!(vec_50[1], 0.0); assert!(
571 vec_50[0].abs() < 0.01,
572 "X (downrange) should be nearly zero for 90° wind, got {}",
573 vec_50[0]
574 );
575
576 let vec_150 = sock.vector_for_range_stateless(150.0);
578 assert_eq!(vec_150, Vector3::zeros());
579 }
580
581 #[test]
582 fn test_wind_sock_multiple_segments() {
583 let sock = WindSock::new(vec![
585 WindSegment::new(16.0934, 90.0, 50.0), WindSegment::new(24.1401, 45.0, 100.0), WindSegment::new(8.0467, 180.0, 200.0), ]);
589
590 let vec_25 = sock.vector_for_range_stateless(25.0);
592 println!("vec_25 = [{}, {}, {}]", vec_25[0], vec_25[1], vec_25[2]);
593 assert!(vec_25.norm() > 0.0);
594 assert!(vec_25[2] < 0.0, "90° wind should have negative Z (lateral)"); let vec_75 = sock.vector_for_range_stateless(75.0);
597 println!("vec_75 = [{}, {}, {}]", vec_75[0], vec_75[1], vec_75[2]);
598 assert!(vec_75.norm() > vec_25.norm()); assert!(vec_75[0] < 0.0); assert!(vec_75[2] < 0.0); let vec_150 = sock.vector_for_range_stateless(150.0);
603 println!("vec_150 = [{}, {}, {}]", vec_150[0], vec_150[1], vec_150[2]);
604 assert!(vec_150.norm() < vec_75.norm()); assert!(
606 vec_150[2].abs() < 0.01,
607 "180° wind should have near-zero Z (lateral), got {}",
608 vec_150[2]
609 ); assert!(
611 vec_150[0] > 0.0,
612 "180° wind should have positive X (tailwind, downrange), got {}",
613 vec_150[0]
614 ); let vec_250 = sock.vector_for_range_stateless(250.0);
617 assert_eq!(vec_250, Vector3::zeros()); }
619
620 #[test]
621 fn test_wind_conversion() {
622 let sock = WindSock::new(vec![WindSegment::new(16.0934, 0.0, 100.0)]);
624 let vec = sock.vector_for_range_stateless(50.0);
625
626 let expected_speed = 16.0934 * KMH_TO_MPS;
627 assert!((vec.norm() - expected_speed).abs() < 0.01);
628 }
629
630 #[test]
631 fn test_wind_sock_boundary_is_upper_exclusive() {
632 let sock = WindSock::new(vec![
635 WindSegment::new(16.0934, 90.0, 100.0),
636 WindSegment::new(32.1868, 270.0, 200.0),
637 ]);
638 assert!(sock.vector_for_range_stateless(99.999)[2] < 0.0);
640 assert!(sock.vector_for_range_stateless(100.0)[2] > 0.0);
642 assert_eq!(sock.vector_for_range_stateless(200.0), Vector3::zeros());
644 }
645
646 #[test]
647 fn calc_vec_passes_through_segment_vertical_unscaled() {
648 let seg = WindSegment {
651 speed_kmh: 16.0934,
652 angle_deg: 90.0,
653 until_m: 100.0,
654 vertical_mps: 3.0,
655 };
656 let vec = WindSock::calc_vec(&seg);
657 assert_eq!(vec[1], 3.0);
658 }
659
660 #[test]
661 fn calc_vec_zero_vertical_segment_keeps_zero_y() {
662 let seg = WindSegment::new(16.0934, 90.0, 100.0);
665 assert_eq!(seg.vertical_mps, 0.0);
666 let vec = WindSock::calc_vec(&seg);
667 assert_eq!(vec[1], 0.0);
668 }
669
670 #[test]
671 fn test_parse_wind_segment_str_units() {
672 let seg = parse_wind_segment_str("10:90:100", true).unwrap();
674 assert!((seg.speed_kmh - 16.09344).abs() < 1e-4);
675 assert_eq!(seg.angle_deg, 90.0);
676 assert!((seg.until_m - 91.44).abs() < 1e-4);
677
678 let seg = parse_wind_segment_str("5:270:200", false).unwrap();
680 assert!((seg.speed_kmh - 18.0).abs() < 1e-9);
681 assert_eq!(seg.angle_deg, 270.0);
682 assert!((seg.until_m - 200.0).abs() < 1e-9);
683
684 assert!(parse_wind_segment_str("10:90", true).is_err()); assert!(parse_wind_segment_str("10:bad:100", true).is_err()); assert!(parse_wind_segment_str("10:90:0", true).is_err()); assert!(parse_wind_segment_str("-3:90:100", true).is_err()); assert!(parse_wind_segment_str("10:nan:5000", true).is_err());
691 assert!(parse_wind_segment_str("10:90:nan", true).is_err());
692 assert!(parse_wind_segment_str("inf:90:100", true).is_err());
693 }
694
695 #[test]
696 fn test_parse_wind_segment_str_vertical_field() {
697 let seg = parse_wind_segment_str("10:90:100", true).unwrap();
699 assert_eq!(seg.vertical_mps, 0.0);
700 let seg = parse_wind_segment_str("5:270:200", false).unwrap();
701 assert_eq!(seg.vertical_mps, 0.0);
702
703 let seg = parse_wind_segment_str("10:90:100:5", true).unwrap();
705 assert_eq!(seg.vertical_mps, 5.0);
706 assert!((seg.speed_kmh - 16.09344).abs() < 1e-4);
708 assert!((seg.until_m - 91.44).abs() < 1e-4);
709
710 let seg_metric = parse_wind_segment_str("5:270:200:5", false).unwrap();
713 assert_eq!(seg_metric.vertical_mps, 5.0);
714
715 let seg_neg = parse_wind_segment_str("10:90:100:-3.5", true).unwrap();
717 assert_eq!(seg_neg.vertical_mps, -3.5);
718
719 assert!(parse_wind_segment_str("10:90:100:bad", true).is_err());
721 assert!(parse_wind_segment_str("10:90:100:nan", true).is_err());
722 assert!(parse_wind_segment_str("10:90:100:inf", true).is_err());
723
724 assert!(parse_wind_segment_str("10:90:100:5:1", true).is_err());
726 }
727}