astronomical-quantities 0.15.0

Unit-safe computations with astronomical quantities.
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

// ---------------------------------------------------------------------------
// Copyright:   (c) 2021 ff. Michael Amrhein (michael@adrhinum.de)
// License:     This program is part of a larger application. For license
//              details please read the file LICENSE.TXT provided together
//              with the application.
// ---------------------------------------------------------------------------
// $Source: astronimical_quantities/src/lib.rs $
// $Revision: 2026-01-31T23:26:53+01:00 $

#![doc = include_str ! ("../README.md")]
#![cfg_attr(not(feature = "std"), no_std)]
#![allow(dead_code)]

use quantities::prelude::*;

#[quantity]
#[ref_unit(Solar_Mass, "M☉", "Reference unit of quantity `Mass`")]
#[unit(Lunar_Mass, "M☾", 3.694329684197616e-8, "1/27068510·M☉")]
#[unit(Earth_Mass, "M🜨", 3.003489616124103e-6, "10000/3329460487·M☉")]
#[unit(Jupiter_Mass, "M♃", 9.547918983127074e-4, "1000000/1047348644·M☉")]
/// The quantity of matter in an astonomical body.
///
/// Reference unit: Solar Mass ('M☉')
///
/// Predefined units:
///
/// | Symbol | Name            | Definition            | Equivalent in 'M☉'   |
/// |--------|-----------------|-----------------------|----------------------|
/// | M☾     | Lunar Mass      | 1/27068510 M☉         | 3.694329684197616e-8 |
/// | M🜨     | Earth Mass      | 10000/3329460487 M☉   | 3.003489616124103e-6 |
/// | M♃     | Jupiter Mass    | 1000000/1047348644 M☉ | 9.547918983127074e-4 |
pub struct Mass {}

#[quantity]
#[ref_unit(
    Astronomical_Unit,
    "au",
    "Reference unit of quantity `Length` (= 149597870700·m)"
)]
#[unit(Kilometer, "km", 6.6845871222684464e-9, "1000·m")]
#[unit(Lightsecond, "ls", 0.002003988804100004, "299792458·m")]
#[unit(Lightyear, "ly", 63241.07708426629, "31557600·ls")]
#[unit(Parsec, "pc", 206264.80624709636, "648000/π·au")]
#[unit(Kilolightyear, "kly", 63241077.08426629, "1000·ly")]
#[unit(Kiloparsec, "kpc", 206264806.24709636, "1000·pc")]
#[unit(Megalightyear, "Mly", 63241077084.26629, "10⁶·ly")]
#[unit(Megaparsec, "Mpc", 206264806247.09636, "10⁶·pc")]
#[unit(Gigalightyear, "Gly", 63241077084266.29, "10⁹·ly")]
#[unit(Gigaparsec, "Gpc", 206264806247096.36, "10⁹·pc")]
/// The quantity of distance between two points in spacetime.
///
/// Reference unit: Astronomical Unit ('au')
///
/// Predefined units:
///
/// | Symbol | Name                    | Definition     | Equivalent in 'au'   |
/// |--------|-------------------------|----------------|----------------------|
/// | km     | Kilometer               | 1000·m         | 6.684587122268446e-9 |
/// | ls     | Lightsecond             | 299792458·m    | 0.002003988804100004 |
/// | ly     | Lightyear               | 31557600·ls    | 63241.07708426629    |
/// | pc     | Parsec                  | 648000/π·au    | 206264.80624709636   |
/// | kly    | Kilolightyear           | 1000·ly        | 63241077.08426629    |
/// | kpc    | Kiloparsec              | 1000·pc        | 206264806.24709636   |
/// | Mly    | Megalightyear           | 10⁶·ly         | 63241077084.26629    |
/// | Mpc    | Megaparsec              | 10⁶·pc         | 206264806247.09636   |
/// | Gly    | Gigalightyear           | 10⁹·ly         | 63241077084266.29    |
/// | Gpc    | Gigaparsec              | 10⁹·pc         | 206264806247096.36   |
pub struct Length {}

#[quantity]
#[ref_unit(Day, "d", "Reference unit of quantity `Duration` (= 24·h)")]
#[unit(Second, "s", 1.1574074074074073e-5, "SI reference unit")]
#[unit(Minute, "min", 0.0006944444444444445, "60·s")]
#[unit(Hour, "h", 0.041666666666666664, "60·min")]
#[unit(Sideral_Day, "dₛ", 0.9972685185185185, "a·d/(a + d)")]
#[unit(Julian_Year, "a", 365.25, "365.25·d")]
#[unit(Gregorian_Year, "yr", 365.2425, "365.2425·d")]
#[unit(
    Earth_Period,
    "T🜨",
    365.256363004,
    "Earth's Orbital Period (≈ 365.256363004·d)"
)]
/// Duration: 'what a clock reads'
///
/// Reference unit: Day ('d')
///
/// Predefined units:
///
/// | Symbol | Name                | Definition        | Equivalent in 'd'     |
/// |--------|---------------------|-------------------|-----------------------|
/// | s      | Second              | SI reference unit | 1.1574074074074073e-5 |
/// | min    | Minute              | 60·s              | 0.0006944444444444445 |
/// | h      | Hour                | 60·min            | 0.041666666666666664  |
/// | dₛ     | Siderial Day        | a·d/(a + d)       | 0.9972685185185185    |
/// | a      | Julian Year         | 365.25·d          | 365.25                |
/// | yr     | Gregorian Year      | 365.2425·d        | 365.2425              |
/// | T🜨     | Earth's Orbital Period | ≈ 365.256363004·d | 365.256363004      |
pub struct Duration {}

#[quantity(Length / Duration)]
#[ref_unit(
    Astronomical_Units_per_Day,
    "au/d",
    "Reference unit of quantity `Speed`"
)]
#[unit(Kilometer_per_Hour, "km/h", 1.604300909344427e-7, "km/h")]
#[unit(Meter_per_Second, "m/s", 5.775483273639937e-7, "SI reference unit")]
#[unit(Speed_of_Light, "c", 173.14463267424034, "ls/s")]
/// Magnitude of the change of an objects position per unit of time
///
/// Definition: Length/Duration
///
/// Reference unit: Astronomical Units per Day ('au/d')
///
/// Predefined units:
///
/// | Symbol | Name                 | Definition        | Equivalent in 'au/d' |
/// |--------|----------------------|-------------------|----------------------|
/// | km/h   | Kilometer per Hour   | km/h              | 1.604300909344427e-7 |
/// | m/s    | Meter per Second     | SI reference unit | 5.775483273639937e-7 |
/// | c      | Speed of Light       | ls/s              | 173.14463267424034   |
pub struct Speed {}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_mass() {
        assert_eq!(<Mass as HasRefUnit>::REF_UNIT, MassUnit::REF_UNIT);
        assert!(SOLAR_MASS.is_ref_unit());
        let amnt: AmountT = Amnt!(29.35);
        let m = amnt * SOLAR_MASS;
        assert_eq!(m.amount, amnt);
        assert_eq!(m.unit, SOLAR_MASS);
        #[cfg(feature = "std")]
        assert_eq!(m.to_string(), "29.35 M☉");
    }

    #[test]
    fn test_length() {
        assert_eq!(<Length as HasRefUnit>::REF_UNIT, LengthUnit::REF_UNIT);
        assert!(ASTRONOMICAL_UNIT.is_ref_unit());
        let amnt: AmountT = Amnt!(29.35);
        let l = amnt * PARSEC;
        assert_eq!(l.amount, amnt);
        assert_eq!(l.unit, PARSEC);
        #[cfg(feature = "std")]
        assert_eq!(l.to_string(), "29.35 pc");
    }

    #[test]
    fn test_duration() {
        assert_eq!(
            <Duration as HasRefUnit>::REF_UNIT,
            DurationUnit::REF_UNIT
        );
        assert!(DAY.is_ref_unit());
        let amnt: AmountT = Amnt!(29.35);
        let d = amnt * JULIAN_YEAR;
        assert_eq!(d.amount, amnt);
        assert_eq!(d.unit, JULIAN_YEAR);
        #[cfg(feature = "std")]
        assert_eq!(d.to_string(), "29.35 a");
    }

    #[test]
    fn test_speed() {
        assert_eq!(<Speed as HasRefUnit>::REF_UNIT, SpeedUnit::REF_UNIT);
        assert!(ASTRONOMICAL_UNITS_PER_DAY.is_ref_unit());
        let amnt: AmountT = Amnt!(235.4);
        let v = amnt * SPEED_OF_LIGHT;
        assert_eq!(v.amount(), amnt);
        assert_eq!(v.unit(), SPEED_OF_LIGHT);
        #[cfg(feature = "std")]
        assert_eq!(v.to_string(), "235.4 c");
    }
}