Function mathio::periodical_difference_short

pub fn periodical_difference_short(period: f32, x1: f32, x2: f32) -> f32

Periodical Difference Short

Returns a difference between 2 periodical values. Uses the shortest path.

The most common example would be getting a difference between 2 angles in degrees. Because of the nature of trigonometry, you can sometimes get inner or outer angle depending on use case. This function will always return the INNER angle.

Examples

 let period = 360.0;
 assert_eq!(120.0, periodical_difference_short(period, 0.0, 120.0));
 assert_eq!(-90.0, periodical_difference_short(period, 0.0, 270.0)); //Always returns the inner angle
 assert_eq!(45.0, periodical_difference_short(period, 45.0, 90.0));
 assert_eq!(-45.0, periodical_difference_short(period, 90.0, 45.0));