-
Notifications
You must be signed in to change notification settings - Fork 98
/
system.rs
1505 lines (1396 loc) · 58.4 KB
/
system.rs
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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// Macro to implement a [system of quantities](http://jcgm.bipm.org/vim/en/1.3.html). `@...` match
/// arms are considered private.
///
/// * `$quantities_attr`: System of quantities attributes. Generally used to set documentation
/// comments for the system of quantities.
/// * `$quantities`: Name of the system of quantities (e.g. `ISQ`).
/// * `$name`: Name of the base quantities for the system of quantities (e.g. `length`, `mass`,
/// ...). Note that this name must match the module name of the quantity.
/// * `$unit`: Base unit of the quantity (e.g. `meter`, `kilogram`).
/// * `$symbol`: Dimension symbol of the quantity.
/// * `$units_attr`: System of units attributes. Generally used to set documentation comments for
/// the system of units.
/// * `$units`: Name of the system of units (e.g. `SI`).
/// * `$module`: Module name of the quantity. When prefixed by the `mod` keyword the module must
/// already be defined with the `#[macro_use]` attribute. A `#[macro_use] pub mod $module;`
/// statement is generated if this variable is not prefixed by the `mod` keyword.
/// * `$quantity`: Quantity name (e.g. `Length`, `Mass`, ...).
///
/// An example invocation is given below for a meter-kilogram-second system. The `#[macro_use]`
/// attribute must be used when including the `uom` crate to make the `system!` macro available.
///
/// ```
/// #[macro_use]
/// extern crate uom;
///
/// # fn main() { }
/// # mod mks {
/// # #[macro_use]
/// # mod length {
/// # quantity! {
/// # /// Length (base unit meter, m<sup>1</sup>).
/// # quantity: Length; "length";
/// # /// Length dimension, m<sup>1</sup>.
/// # dimension: Q<P1 /*length*/, Z0 /*mass*/, Z0 /*time*/>;
/// # units {
/// # @meter: 1.0E0; "m", "meter", "meters";
/// # @foot: 3.048E-1; "ft", "foot", "feet";
/// # }
/// # }
/// # }
/// # #[macro_use]
/// # mod mass {
/// # quantity! {
/// # /// Mass (base unit kilogram, kg<sup>1</sup>).
/// # quantity: Mass; "mass";
/// # /// Mass dimension, kg<sup>1</sup>.
/// # dimension: Q<Z0 /*length*/, P1 /*mass*/, Z0 /*time*/>;
/// # units {
/// # @kilogram: 1.0; "kg", "kilogram", "kilograms";
/// # }
/// # }
/// # }
/// # #[macro_use]
/// # mod time {
/// # quantity! {
/// # /// Time (base unit second, s<sup>1</sup>).
/// # quantity: Time; "time";
/// # /// Time dimension, s<sup>1</sup>.
/// # dimension: Q<Z0 /*length*/, Z0 /*mass*/, P1 /*time*/>;
/// # units {
/// # @second: 1.0; "s", "second", "seconds";
/// # }
/// # }
/// # }
/// system! {
/// /// System of quantities, Q.
/// quantities: Q {
/// length: meter, L;
/// mass: kilogram, M;
/// time: second, T;
/// }
/// /// System of units, U.
/// units: U {
/// mod length::Length,
/// mod mass::Mass,
/// mod time::Time,
/// }
/// }
/// # mod f32 {
/// # Q!(mks, f32/*, (centimeter, gram, second)*/);
/// # }
/// # }
/// ```
#[macro_export]
macro_rules! system {
(
$(#[$quantities_attr:meta])* quantities: $quantities:ident {
$($name:ident: $unit:ident, $symbol:ident;)+
}
$(#[$units_attr:meta])* units: $units:ident {
$($module:ident::$quantity:ident,)+
}
) => {
$(#[macro_use]
pub mod $module;)+
system! {
$(#[$quantities_attr])*
quantities: $quantities {
$($name: $unit, $symbol;)+
}
$(#[$units_attr])*
units: $units {
$(mod $module::$quantity,)+
}
}
};
(
$(#[$quantities_attr:meta])* quantities: $quantities:ident {
$($name:ident: $unit:ident, $symbol:ident;)+
}
$(#[$units_attr:meta])* units: $units:ident {
$(mod $module:ident::$quantity:ident,)+
}
) => {
/// Marker trait to express the dependence of a [quantity][quantity] on the
/// [base quantities][base] of a [system of quantities][quantities] as a product of powers
/// of factors corresponding to the base quantities, omitting any numerical factor.
///
/// * <http://jcgm.bipm.org/vim/en/1.7.html>
///
/// [quantity]: http://jcgm.bipm.org/vim/en/1.1.html
/// [base]: http://jcgm.bipm.org/vim/en/1.4.html
/// [quantities]: http://jcgm.bipm.org/vim/en/1.3.html
pub trait Dimension: Send + Sync {
$(/// Quantity dimension.
type $symbol: $crate::typenum::Integer;)+
/// [Kind][kind] of the quantity. Quantities of the same dimension but differing kinds
/// are not comparable.
///
/// [kind]: https://jcgm.bipm.org/vim/en/1.2.html
type Kind: ?Sized;
}
/// Marker trait to identify a [system of units][units] based on a set of [base units][base]
/// of a [system of quantities][quantities].
///
/// [units]: http://jcgm.bipm.org/vim/en/1.13.html
/// [base]: http://jcgm.bipm.org/vim/en/1.10.html
/// [quantities]: http://jcgm.bipm.org/vim/en/1.3.html
pub trait Units<V>: Send + Sync
where
V: $crate::Conversion<V>,
{
$(/// Base unit.
type $name: Unit + $crate::Conversion<V, T = V::T>;)+
}
/// Trait to identify [measurement units][measurement] of individual
/// [quantities][quantity].
///
/// [measurement]: http://jcgm.bipm.org/vim/en/1.9.html
/// [quantity]: http://jcgm.bipm.org/vim/en/1.1.html
pub trait Unit: Copy {
/// Unit abbreviation.
fn abbreviation() -> &'static str;
/// Unit singular description.
fn singular() -> &'static str;
/// Unit plural description.
fn plural() -> &'static str;
}
/// Property of a phenomenon, body or substance, where the property has a magnitude that
/// can be expressed as a number and a reference.
///
/// The preferred method of creating a `Quantity` instance is to use the `new` constructor
/// which is generic over the input unit and accepts the input value as it's only
/// parameter.
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::length::meter;
/// // Create a length of 1 meter.
/// let l = Length::new::<meter>(1.0);
/// ```
///
/// `Quantity` fields are public to allow for the creation of `const` values and instances
/// of non-named `Quantity`s. This functionality will be deprecated and subsequently removed
/// once the [`const fn`](https://github.com/rust-lang/rust/issues/24111) feature is
/// stabilized.
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::{Quantity, ISQ, SI};
/// # use uom::si::f32::*;
/// # use uom::lib::marker::PhantomData;
/// # use uom::typenum::{P2, Z0};
/// // Create a `const` length of 1 meter.
/// const L: Length = Length { dimension: PhantomData, units: PhantomData, value: 1.0, };
/// // Create a `const` area of 1 square meter explicitly without using the `Area` alias.
/// const A: Quantity<ISQ<P2, Z0, Z0, Z0, Z0, Z0, Z0>, SI<f32>, f32> =
/// Quantity { dimension: PhantomData, units: PhantomData, value: 1.0, };
/// ```
///
/// Using units for the wrong quantity will cause a compile error:
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust,compile_fail")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::time::second;
/// // error[E0277]: the trait bound `second: length::Unit` is not satisfied
/// let l = Length::new::<second>(1.0);
/// ```
///
/// Mixing quantities will also cause a compile error:
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust,compile_fail")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::length::meter;
/// # use uom::si::time::second;
/// // error[E0308]: mismatched types
/// let r = Length::new::<meter>(1.0) + Time::new::<second>(1.0);
/// ```
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust,compile_fail")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::length::meter;
/// # use uom::si::time::second;
/// // error[E0308]: mismatched types
/// let v: Velocity = Length::new::<meter>(1.0) * Time::new::<second>(1.0);
/// ```
///
/// * <http://jcgm.bipm.org/vim/en/1.1.html>
pub struct Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>,
{
/// Quantity dimension. See [`Dimension`](./trait.Dimension.html).
pub dimension: $crate::lib::marker::PhantomData<D>,
/// Quantity base units. See [`Units`](./trait.Units.html).
pub units: $crate::lib::marker::PhantomData<U>,
/// Quantity value stored in the base units for the quantity.
pub value: V,
}
// Type alias for dimensions where all exponents of the factors are the given value.
type DN<N> = Dimension<$($symbol = system!(@replace $symbol N),)+ Kind = $crate::Kind>;
/// Type alias for [dimension one][one] for which all the exponents of the factors
/// corresponding to the [base quantities][base] are zero.
///
/// [one]: http://jcgm.bipm.org/vim/en/1.8.html
/// [base]: http://jcgm.bipm.org/vim/en/1.4.html
#[allow(dead_code)]
pub type DimensionOne = DN<$crate::typenum::Z0>;
$(#[$quantities_attr])*
pub type $quantities<$($symbol,)+ K = $crate::Kind> =
Dimension<$($symbol = $symbol,)+ Kind = K>;
$(#[$units_attr])*
#[allow(unused_qualifications)]
pub type $units<V> = Units<V, $($name = $name::$unit),+>;
/// Convert a value from base units to the given unit.
#[inline(always)]
fn from_base<D, U, V, N>(v: &V) -> V
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::Conversion<V> + $crate::lib::ops::Mul<V, Output = V>,
N: $crate::Conversion<V, T = V::T>,
{
use $crate::typenum::Integer;
use $crate::Conversion;
use $crate::ConversionFactor;
(v.into_conversion() $(* U::$name::coefficient().powi(D::$symbol::to_i32()))+
/ N::coefficient() - N::constant())
.value()
}
/// Convert a value from the given unit to base units.
#[inline(always)]
fn to_base<D, U, V, N>(v: &V) -> V
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::Conversion<V> + $crate::lib::ops::Mul<V, Output = V>,
N: $crate::Conversion<V, T = V::T>,
{
use $crate::typenum::Integer;
use $crate::Conversion;
use $crate::ConversionFactor;
((v.into_conversion() + N::constant()) * N::coefficient()
/ (V::coefficient() $(* U::$name::coefficient().powi(D::$symbol::to_i32()))+))
.value()
}
/// Convert a value from one set of base units to a second.
autoconvert_test! {
#[allow(dead_code)]
#[inline(always)]
fn change_base<D, Ul, Ur, V>(v: &V) -> V
where
D: Dimension + ?Sized,
Ul: Units<V> + ?Sized,
Ur: Units<V> + ?Sized,
V: $crate::Conversion<V> + $crate::lib::ops::Mul<V, Output = V>,
{
use $crate::typenum::Integer;
use $crate::Conversion;
use $crate::ConversionFactor;
(v.into_conversion() $(* Ur::$name::coefficient().powi(D::$symbol::to_i32())
/ Ul::$name::coefficient().powi(D::$symbol::to_i32()))+)
.value()
}}
#[doc(hidden)]
macro_rules! impl_ops {
(
$AddSubTrait:ident, $addsub_fun:ident, $addsub_op:tt,
$AddSubAssignTrait:ident, $addsubassign_fun:ident, $addsubassign_op:tt,
$AddSubAlias:ident,
$MulDivTrait:ident, $muldiv_fun:ident, $muldiv_op:tt,
$MulDivAssignTrait:ident, $muldivassign_fun:ident, $muldivassign_op:tt,
$Mod:ident
) => {
autoconvert! {
impl<D, Ul, Ur, V> $crate::lib::ops::$AddSubTrait<Quantity<D, Ur, V>>
for Quantity<D, Ul, V>
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::$AddSubTrait,
Ul: Units<V> + ?Sized,
Ur: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>,
{
type Output = Quantity<D, Ul, V>;
#[inline(always)]
fn $addsub_fun(self, rhs: Quantity<D, Ur, V>) -> Self::Output {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value $addsub_op change_base::<D, Ul, Ur, V>(&rhs.value),
}
}
}}
not_autoconvert! {
impl<D, U, V> $crate::lib::ops::$AddSubTrait for Quantity<D, U, V>
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::$AddSubTrait,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>,
{
type Output = Self;
#[inline(always)]
fn $addsub_fun(self, rhs: Self) -> Self::Output {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value $addsub_op rhs.value,
}
}
}}
autoconvert! {
impl<D, Ul, Ur, V> $crate::lib::ops::$AddSubAssignTrait<Quantity<D, Ur, V>>
for Quantity<D, Ul, V>
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::$AddSubAssignTrait,
Ul: Units<V> + ?Sized,
Ur: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>
+ $crate::lib::ops::$AddSubAssignTrait<V>,
{
#[inline(always)]
fn $addsubassign_fun(&mut self, rhs: Quantity<D, Ur, V>) {
self.value $addsubassign_op change_base::<D, Ul, Ur, V>(&rhs.value);
}
}}
not_autoconvert! {
impl<D, U, V> $crate::lib::ops::$AddSubAssignTrait for Quantity<D, U, V>
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::$AddSubAssignTrait,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>
+ $crate::lib::ops::$AddSubAssignTrait<V>,
{
#[inline(always)]
fn $addsubassign_fun(&mut self, rhs: Self) {
self.value $addsubassign_op rhs.value;
}
}}
autoconvert! {
impl<Dl, Dr, Ul, Ur, V> $crate::lib::ops::$MulDivTrait<Quantity<Dr, Ur, V>>
for Quantity<Dl, Ul, V>
where
Dl: Dimension + ?Sized,
$(Dl::$symbol: $crate::lib::ops::$AddSubTrait<Dr::$symbol>,)+
Dl::Kind: $crate::marker::$MulDivTrait,
Dr: Dimension + ?Sized,
Dr::Kind: $crate::marker::$MulDivTrait,
Ul: Units<V> + ?Sized,
Ur: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::ops::$MulDivTrait<V>,
{
type Output = Quantity<
$quantities<$($crate::typenum::$AddSubAlias<Dl::$symbol, Dr::$symbol>,)+>,
Ul, V>;
#[inline(always)]
fn $muldiv_fun(self, rhs: Quantity<Dr, Ur, V>) -> Self::Output {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value $muldiv_op change_base::<Dr, Ul, Ur, V>(&rhs.value),
}
}
}}
not_autoconvert! {
impl<Dl, Dr, U, V> $crate::lib::ops::$MulDivTrait<Quantity<Dr, U, V>>
for Quantity<Dl, U, V>
where
Dl: Dimension + ?Sized,
$(Dl::$symbol: $crate::lib::ops::$AddSubTrait<Dr::$symbol>,)+
Dl::Kind: $crate::marker::$MulDivTrait,
Dr: Dimension + ?Sized,
Dr::Kind: $crate::marker::$MulDivTrait,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::ops::$MulDivTrait<V>,
{
type Output = Quantity<
$quantities<$($crate::typenum::$AddSubAlias<Dl::$symbol, Dr::$symbol>,)+>,
U, V>;
#[inline(always)]
fn $muldiv_fun(self, rhs: Quantity<Dr, U, V>) -> Self::Output {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value $muldiv_op rhs.value,
}
}
}}
impl<D, U, V> $crate::lib::ops::$MulDivTrait<V> for Quantity<D, U, V>
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::$MulDivTrait,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>,
{
type Output = Quantity<D, U, V>;
#[inline(always)]
fn $muldiv_fun(self, rhs: V) -> Self::Output {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value $muldiv_op rhs,
}
}
}
impl<D, U, V> $crate::lib::ops::$MulDivAssignTrait<V> for Quantity<D, U, V>
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::$MulDivAssignTrait,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>
+ $crate::lib::ops::$MulDivAssignTrait<V>,
{
#[inline(always)]
fn $muldivassign_fun(&mut self, rhs: V) {
self.value $muldivassign_op rhs;
}
}
#[doc(hidden)]
mod $Mod {
storage_types! {
use super::super::*;
impl<D, U> $crate::lib::ops::$MulDivTrait<Quantity<D, U, V>> for V
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::$MulDivTrait,
U: Units<V> + ?Sized,
$($crate::typenum::Z0: $crate::lib::ops::$AddSubTrait<D::$symbol>,)+
{
type Output = Quantity<
$quantities<
$($crate::typenum::$AddSubAlias<
$crate::typenum::Z0,
D::$symbol>,)+>,
U, V>;
#[inline(always)]
fn $muldiv_fun(self, rhs: Quantity<D, U, V>) -> Self::Output {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self $muldiv_op rhs.value,
}
}
}
}
}
};
}
impl_ops!(Add, add, +, AddAssign, add_assign, +=, Sum,
Mul, mul, *, MulAssign, mul_assign, *=, add_mul);
impl_ops!(Sub, sub, -, SubAssign, sub_assign, -=, Diff,
Div, div, /, DivAssign, div_assign, /=, sub_div);
impl<D, U, V> Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>,
{
/// Returns `true` if this value is `NAN` and `false` otherwise.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::wrong_self_convention))]
#[inline(always)]
pub fn is_nan(self) -> bool
where
V: $crate::num::Float,
{
self.value.is_nan()
}
/// Returns `true` if this value is positive infinity or negative infinity and
/// `false` otherwise.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::wrong_self_convention))]
#[inline(always)]
pub fn is_infinite(self) -> bool
where
V: $crate::num::Float,
{
self.value.is_infinite()
}
/// Returns `true` if this number is neither infinite nor `NAN`.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::wrong_self_convention))]
#[inline(always)]
pub fn is_finite(self) -> bool
where
V: $crate::num::Float,
{
self.value.is_finite()
}
/// Returns `true` if the number is neither zero, infinite, subnormal, or `NAN`.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::wrong_self_convention))]
#[inline(always)]
pub fn is_normal(self) -> bool
where
V: $crate::num::Float,
{
self.value.is_normal()
}
/// Returns the floating point category of the number. If only one property is
/// going to be tested, it is generally faster to use the specific predicate
/// instead.
#[inline(always)]
pub fn classify(self) -> $crate::lib::num::FpCategory
where
V: $crate::num::Float,
{
self.value.classify()
}
std! {
/// Takes the cubic root of a number.
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::volume::cubic_meter;
/// let l: Length = Volume::new::<cubic_meter>(8.0).cbrt();
/// ```
///
/// The input type must have dimensions divisible by three:
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust,compile_fail")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::area::square_meter;
/// // error[E0271]: type mismatch resolving ...
/// let r = Area::new::<square_meter>(8.0).cbrt();
/// ```
#[inline(always)]
pub fn cbrt(
self
) -> Quantity<
$quantities<$($crate::typenum::PartialQuot<D::$symbol, $crate::typenum::P3>),+>,
U, V>
where
$(D::$symbol: $crate::lib::ops::PartialDiv<$crate::typenum::P3>,)+
D::Kind: $crate::marker::Div,
V: $crate::num::Float,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.cbrt(),
}
}}
/// Computes the absolute value of `self`. Returns `NAN` if the quantity is
/// `NAN`.
#[inline(always)]
pub fn abs(self) -> Self
where
V: $crate::num::Signed,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.abs(),
}
}
/// Returns a quantity that represents the sign of `self`.
///
/// * `1.0` of the base unit if the number is positive, `+0.0`, or `INFINITY`.
/// * `-1.0` of the base unit if the number is negative, `-0.0`, or
/// `NEG_INFINITY`.
/// * `NAN` if the number is `NAN`.
#[inline(always)]
pub fn signum(self) -> Self
where
V: $crate::num::Signed,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.signum(),
}
}
/// Returns `true` if `self`'s sign bit is positive, including `+0.0` and
/// `INFINITY`.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::wrong_self_convention))]
#[inline(always)]
pub fn is_sign_positive(self) -> bool
where
V: $crate::num::Float,
{
self.value.is_sign_positive()
}
/// Returns `true` if `self`'s sign is negative, including `-0.0` and
/// `NEG_INFINITY`.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::wrong_self_convention))]
#[inline(always)]
pub fn is_sign_negative(self) -> bool
where
V: $crate::num::Float,
{
self.value.is_sign_negative()
}
std! {
/// Fused multiply-add. Computes `(self * a) + b` with only one rounding error.
/// This produces a more accurate result with better performance than a separate
/// multiplication operation followed by an add.
#[inline(always)]
pub fn mul_add<Da, Ua, Ub>(
self,
a: Quantity<Da, Ua, V>,
b: Quantity<$quantities<$($crate::typenum::Sum<D::$symbol, Da::$symbol>),+>, Ub, V>,
) -> Quantity<$quantities<$($crate::typenum::Sum<D::$symbol, Da::$symbol>),+>, U, V>
where
$(D::$symbol: $crate::lib::ops::Add<Da::$symbol>,)+
D::Kind: $crate::marker::Mul,
V: $crate::num::Float,
Da: Dimension + ?Sized,
Da::Kind: $crate::marker::Mul,
Ua: Units<V> + ?Sized,
Ub: Units<V> + ?Sized,
{
// (self * a) + b
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.mul_add(a.value, b.value),
}
}}
/// Takes the reciprocal (inverse) of a number, `1/x`.
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::time::second;
/// let f: Frequency = Time::new::<second>(1.0).recip();
/// ```
#[inline(always)]
pub fn recip(
self
) -> Quantity<$quantities<$($crate::typenum::Negate<D::$symbol>),+>, U, V>
where
$(D::$symbol: $crate::lib::ops::Neg,)+
D::Kind: $crate::marker::Div,
V: $crate::num::Float,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.recip(),
}
}
/// Raises a quantity to an integer power.
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::length::meter;
/// let a: Area = Length::new::<meter>(3.0).powi(::uom::typenum::P2::new());
/// ```
#[inline(always)]
pub fn powi<E>(
self, e: E
) -> Quantity<$quantities<$($crate::typenum::Prod<D::$symbol, E>),+>, U, V>
where
$(D::$symbol: $crate::lib::ops::Mul<E>,)+
D::Kind: $crate::marker::Mul,
E: $crate::typenum::Integer,
V: $crate::typenum::Pow<E, Output = V> + $crate::Conversion<V>,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: $crate::typenum::Pow::powi(self.value, e),
}
}
std! {
/// Takes the square root of a number. Returns `NAN` if `self` is a negative
/// number.
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::area::square_meter;
/// let l: Length = Area::new::<square_meter>(4.0).sqrt();
/// ```
///
/// The input type must have dimensions divisible by two:
///
#[cfg_attr(all(feature = "si", feature = "f32"), doc = " ```rust,compile_fail")]
#[cfg_attr(not(all(feature = "si", feature = "f32")), doc = " ```rust,ignore")]
/// # use uom::si::f32::*;
/// # use uom::si::length::meter;
/// // error[E0271]: type mismatch resolving ...
/// let r = Length::new::<meter>(4.0).sqrt();
/// ```
#[inline(always)]
pub fn sqrt(
self
) -> Quantity<
$quantities<$($crate::typenum::PartialQuot<D::$symbol, $crate::typenum::P2>),+>,
U, V>
where
$(D::$symbol: $crate::typenum::PartialDiv<$crate::typenum::P2>,)+
D::Kind: $crate::marker::Div,
V: $crate::num::Float,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.sqrt(),
}
}}
/// Returns the maximum of the two quantities.
#[inline(always)]
pub fn max(self, other: Self) -> Self
where
V: $crate::num::Float,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.max(other.value),
}
}
/// Returns the minimum of the two quantities.
#[inline(always)]
pub fn min(self, other: Self) -> Self
where
V: $crate::num::Float,
{
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.min(other.value),
}
}
}
impl<D, U, V> $crate::lib::clone::Clone for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::clone::Clone,
{
#[inline(always)]
fn clone(&self) -> Self {
match *self {
Quantity { ref value, .. } => {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: $crate::lib::clone::Clone::clone(&(*value)),
}
}
}
}
}
impl<D, U, V> $crate::lib::marker::Copy for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::marker::Copy,
{
}
#[allow(non_camel_case_types)]
impl<D, U, V> $crate::lib::fmt::Debug for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::fmt::Debug,
{
fn fmt(&self, f: &mut $crate::lib::fmt::Formatter) -> $crate::lib::fmt::Result {
self.value.fmt(f)
$(.and_then(|_| {
let d = <D::$symbol as $crate::typenum::Integer>::to_i32();
if 0 != d {
write!(f, " {}^{}", U::$name::abbreviation(), d)
}
else {
Ok(())
}
}))+
}
}
impl<D, U, V> $crate::lib::default::Default for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::default::Default,
{
fn default() -> Self {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: V::default(),
}
}
}
impl<D, U, V> $crate::lib::cmp::Eq for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::cmp::Eq,
{
}
impl<D, U, V> $crate::lib::hash::Hash for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::hash::Hash,
{
fn hash<H: $crate::lib::hash::Hasher>(&self, state: &mut H) {
self.value.hash(state);
}
}
impl<D, U, V> $crate::lib::ops::Neg for Quantity<D, U, V>
where
D: Dimension + ?Sized,
D::Kind: $crate::marker::Neg,
U: Units<V> + ?Sized,
V: $crate::num::Signed + $crate::Conversion<V>,
{
type Output = Quantity<D, U, V>;
#[inline(always)]
fn neg(self) -> Self::Output {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: -self.value,
}
}
}
impl<D, U, V> $crate::lib::cmp::Ord for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::cmp::Ord,
{
#[inline(always)]
fn cmp(&self, other: &Self) -> $crate::lib::cmp::Ordering {
self.value.cmp(&other.value)
}
#[inline(always)]
fn max(self, other: Self) -> Self {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.max(other.value),
}
}
#[inline(always)]
fn min(self, other: Self) -> Self {
Quantity {
dimension: $crate::lib::marker::PhantomData,
units: $crate::lib::marker::PhantomData,
value: self.value.min(other.value),
}
}
}
autoconvert! {
impl<D, Ul, Ur, V> $crate::lib::cmp::PartialEq<Quantity<D, Ur, V>> for Quantity<D, Ul, V>
where
D: Dimension + ?Sized,
Ul: Units<V> + ?Sized,
Ur: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>,
{
#[inline(always)]
fn eq(&self, other: &Quantity<D, Ur, V>) -> bool {
self.value == change_base::<D, Ul, Ur, V>(&other.value)
}
}}
not_autoconvert! {
impl<D, U, V> $crate::lib::cmp::PartialEq for Quantity<D, U, V>
where
D: Dimension + ?Sized,
U: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V>,
{
#[inline(always)]
fn eq(&self, other: &Self) -> bool {
self.value == other.value
}
}}
autoconvert! {
impl<D, Ul, Ur, V> $crate::lib::cmp::PartialOrd<Quantity<D, Ur, V>> for Quantity<D, Ul, V>
where
D: Dimension + ?Sized,
Ul: Units<V> + ?Sized,
Ur: Units<V> + ?Sized,
V: $crate::num::Num + $crate::Conversion<V> + $crate::lib::cmp::PartialOrd,
{
#[inline(always)]
fn partial_cmp(
&self, other: &Quantity<D, Ur, V>
) -> Option<$crate::lib::cmp::Ordering>
{
self.value.partial_cmp(&change_base::<D, Ul, Ur, V>(&other.value))
}
#[inline(always)]
fn lt(&self, other: &Quantity<D, Ur, V>) -> bool {
self.value.lt(&change_base::<D, Ul, Ur, V>(&other.value))
}
#[inline(always)]