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
|
use std::fmt::{self, Debug, Formatter};
use std::ops::{Add, Div, Mul, Neg};
use ecow::EcoString;
use typst_utils::{Numeric, Scalar};
use crate::foundations::{repr, ty, Repr};
/// A ratio of a whole.
///
/// A ratio is written as a number, followed by a percent sign. Ratios most
/// often appear as part of a [relative length]($relative), to specify the size
/// of some layout element relative to the page or some container.
///
/// ```example
/// #rect(width: 25%)
/// ```
///
/// However, they can also describe any other property that is relative to some
/// base, e.g. an amount of [horizontal scaling]($scale.x) or the
/// [height of parentheses]($math.lr.size) relative to the height of the content
/// they enclose.
///
/// # Scripting
/// Within your own code, you can use ratios as you like. You can multiply them
/// with various other types as shown below:
///
/// | Multiply by | Example | Result |
/// |-----------------|-------------------------|-----------------|
/// | [`ratio`] | `{27% * 10%}` | `{2.7%}` |
/// | [`length`] | `{27% * 100pt}` | `{27pt}` |
/// | [`relative`] | `{27% * (10% + 100pt)}` | `{2.7% + 27pt}` |
/// | [`angle`] | `{27% * 100deg}` | `{27deg}` |
/// | [`int`] | `{27% * 2}` | `{54%}` |
/// | [`float`] | `{27% * 0.37037}` | `{10%}` |
/// | [`fraction`] | `{27% * 3fr}` | `{0.81fr}` |
///
/// When ratios are displayed in the document, they are rounded to two
/// significant digits for readability.
#[ty(cast)]
#[derive(Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct Ratio(Scalar);
impl Ratio {
/// A ratio of `0%` represented as `0.0`.
pub const fn zero() -> Self {
Self(Scalar::ZERO)
}
/// A ratio of `100%` represented as `1.0`.
pub const fn one() -> Self {
Self(Scalar::ONE)
}
/// Create a new ratio from a value, where `1.0` means `100%`.
pub const fn new(ratio: f64) -> Self {
Self(Scalar::new(ratio))
}
/// Get the underlying ratio.
pub const fn get(self) -> f64 {
(self.0).get()
}
/// Whether the ratio is zero.
pub fn is_zero(self) -> bool {
self.0 == 0.0
}
/// Whether the ratio is one.
pub fn is_one(self) -> bool {
self.0 == 1.0
}
/// The absolute value of this ratio.
pub fn abs(self) -> Self {
Self::new(self.get().abs())
}
/// Return the ratio of the given `whole`.
pub fn of<T: Numeric>(self, whole: T) -> T {
let resolved = whole * self.get();
if resolved.is_finite() {
resolved
} else {
T::zero()
}
}
}
impl Debug for Ratio {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
write!(f, "{:?}%", self.get() * 100.0)
}
}
impl Repr for Ratio {
fn repr(&self) -> EcoString {
repr::format_float_with_unit(self.get() * 100.0, "%")
}
}
impl Neg for Ratio {
type Output = Self;
fn neg(self) -> Self {
Self(-self.0)
}
}
impl Add for Ratio {
type Output = Self;
fn add(self, other: Self) -> Self {
Self(self.0 + other.0)
}
}
typst_utils::sub_impl!(Ratio - Ratio -> Ratio);
impl Mul for Ratio {
type Output = Self;
fn mul(self, other: Self) -> Self {
Self(self.0 * other.0)
}
}
impl Mul<f64> for Ratio {
type Output = Self;
fn mul(self, other: f64) -> Self {
Self(self.0 * other)
}
}
impl Mul<Ratio> for f64 {
type Output = Ratio;
fn mul(self, other: Ratio) -> Ratio {
other * self
}
}
impl Div for Ratio {
type Output = f64;
fn div(self, other: Self) -> f64 {
self.get() / other.get()
}
}
impl Div<f64> for Ratio {
type Output = Self;
fn div(self, other: f64) -> Self {
Self(self.0 / other)
}
}
impl Div<Ratio> for f64 {
type Output = Self;
fn div(self, other: Ratio) -> Self {
self / other.get()
}
}
typst_utils::assign_impl!(Ratio += Ratio);
typst_utils::assign_impl!(Ratio -= Ratio);
typst_utils::assign_impl!(Ratio *= Ratio);
typst_utils::assign_impl!(Ratio *= f64);
typst_utils::assign_impl!(Ratio /= f64);
|
