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
//! Context is used in expressions returning `BigFloat`.
use crate::BigFloat;
use crate::Consts;
use crate::Error;
use crate::Exponent;
use crate::RoundingMode;
use crate::EXPONENT_MAX;
use crate::EXPONENT_MIN;
/// Context contains parameters, like rounding mode and precision, as well as constant values, and is used with `expr!` macro.
#[derive(Debug)]
pub struct Context {
cc: Consts,
p: usize,
rm: RoundingMode,
emin: Exponent,
emax: Exponent,
}
impl Context {
/// Create a new context.
/// The value of `emin` will be clamped to a range between EXPONENT_MIN and 0.
/// The value of `emax` will be clamped to a range between 0 and EXPONENT_MAX.
pub fn new(p: usize, rm: RoundingMode, cc: Consts, emin: Exponent, emax: Exponent) -> Self {
Context {
cc,
p,
rm,
emin: emin.clamp(EXPONENT_MIN, 0),
emax: emax.clamp(0, EXPONENT_MAX),
}
}
/// Destructures the context and returns its parts: target precision, rounding mode,
/// constant cache, minimum exponent, maximum exponent.
pub fn to_raw_parts(self) -> (usize, RoundingMode, Consts, Exponent, Exponent) {
let Context {
p,
rm,
cc,
emin,
emax,
} = self;
(p, rm, cc, emin, emax)
}
/// Sets the precision of the context.
pub fn set_precision(&mut self, p: usize) {
self.p = p;
}
/// Sets the rounding mode of the context.
pub fn set_rounding_mode(&mut self, rm: RoundingMode) {
self.rm = rm;
}
/// Sets the constant cache of the context.
pub fn set_consts(&mut self, cc: Consts) {
self.cc = cc;
}
/// Sets the minimum exponent.
/// The value of `emin` will be clamped to a range between EXPONENT_MIN and 0.
pub fn set_emin(&mut self, emin: Exponent) {
self.emin = emin.clamp(EXPONENT_MIN, 0);
}
/// Sets the maximum exponent.
/// The value of `emax` will be clamped to a range between 0 and EXPONENT_MAX.
pub fn set_emax(&mut self, emax: Exponent) {
self.emax = emax.clamp(0, EXPONENT_MAX);
}
/// Returns the precision of the context.
pub fn precision(&self) -> usize {
self.p
}
/// Returns the rounding mode of the context.
pub fn rounding_mode(&self) -> RoundingMode {
self.rm
}
/// Returns a mutable reference to the constant cache of the context.
pub fn consts(&mut self) -> &mut Consts {
&mut self.cc
}
/// Returns the value of the pi number.
pub fn const_pi(&mut self) -> BigFloat {
self.cc.pi(self.p, self.rm)
}
/// Returns the value of the Euler number.
pub fn const_e(&mut self) -> BigFloat {
self.cc.e(self.p, self.rm)
}
/// Returns the value of the natural logarithm of 2.
pub fn const_ln2(&mut self) -> BigFloat {
self.cc.ln_2(self.p, self.rm)
}
/// Returns the value of the natural logarithm of 10.
pub fn const_ln10(&mut self) -> BigFloat {
self.cc.ln_10(self.p, self.rm)
}
/// Returns the minimum exponent.
pub fn emin(&self) -> Exponent {
self.emin
}
/// Returns the maximum exponent.
pub fn emax(&self) -> Exponent {
self.emax
}
/// Clones `self` and returns the cloned context.
///
/// # Errors
///
/// - MemoryAllocation: failed to allocate memory for the constants cache.
#[allow(clippy::should_implement_trait)]
pub fn clone(&self) -> Result<Self, Error> {
let cc = Consts::new()?;
Ok(Context {
p: self.p,
rm: self.rm,
cc,
emin: self.emin,
emax: self.emax,
})
}
}
/// Represents a type that can be used as context in `expr!` macro.
///
/// ## Examples
///
/// ```
/// # use astro_float_num::RoundingMode;
/// # use astro_float_num::Consts;
/// # use astro_float_num::ctx::Contextable;
/// let p = 123;
/// let rm = RoundingMode::Down;
/// let mut cc = Consts::new().expect("Constants cache allocated");
/// let pi = cc.pi(p, rm);
///
/// // Make context out of tuple.
/// let mut ctx = (p, rm, &mut cc);
///
/// assert_eq!(p, ctx.precision());
/// assert_eq!(rm, ctx.rounding_mode());
/// assert_eq!(pi, ctx.const_pi());
/// ```
pub trait Contextable {
/// Returns the precision of the context.
fn precision(&self) -> usize;
/// Returns the rounding mode of the context.
fn rounding_mode(&self) -> RoundingMode;
/// Returns a mutable reference to the constant cache of the context.
fn consts(&mut self) -> &mut Consts;
/// Returns the value of the pi number.
fn const_pi(&mut self) -> BigFloat;
/// Returns the value of the Euler number.
fn const_e(&mut self) -> BigFloat;
/// Returns the value of the natural logarithm of 2.
fn const_ln2(&mut self) -> BigFloat;
/// Returns the value of the natural logarithm of 10.
fn const_ln10(&mut self) -> BigFloat;
/// Returns the minimum exponent.
fn emin(&self) -> Exponent;
/// Returns the maximum exponent.
fn emax(&self) -> Exponent;
}
impl Contextable for (usize, RoundingMode, &mut Consts) {
fn precision(&self) -> usize {
self.0
}
fn rounding_mode(&self) -> RoundingMode {
self.1
}
fn consts(&mut self) -> &mut Consts {
self.2
}
fn const_pi(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().pi(p, rm)
}
fn const_e(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().e(p, rm)
}
fn const_ln2(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().ln_2(p, rm)
}
fn const_ln10(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().ln_10(p, rm)
}
fn emin(&self) -> Exponent {
EXPONENT_MIN
}
fn emax(&self) -> Exponent {
EXPONENT_MAX
}
}
impl Contextable for (usize, RoundingMode, &mut Consts, Exponent, Exponent) {
fn precision(&self) -> usize {
self.0
}
fn rounding_mode(&self) -> RoundingMode {
self.1
}
fn consts(&mut self) -> &mut Consts {
self.2
}
fn const_pi(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().pi(p, rm)
}
fn const_e(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().e(p, rm)
}
fn const_ln2(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().ln_2(p, rm)
}
fn const_ln10(&mut self) -> BigFloat {
let (p, rm) = (self.0, self.1);
self.consts().ln_10(p, rm)
}
fn emin(&self) -> Exponent {
self.3.clamp(EXPONENT_MIN, 0)
}
fn emax(&self) -> Exponent {
self.4.clamp(0, EXPONENT_MAX)
}
}
impl Contextable for Context {
fn precision(&self) -> usize {
Context::precision(self)
}
fn rounding_mode(&self) -> RoundingMode {
Context::rounding_mode(self)
}
fn consts(&mut self) -> &mut Consts {
Context::consts(self)
}
fn const_pi(&mut self) -> BigFloat {
Context::const_pi(self)
}
fn const_e(&mut self) -> BigFloat {
Context::const_e(self)
}
fn const_ln2(&mut self) -> BigFloat {
Context::const_ln2(self)
}
fn const_ln10(&mut self) -> BigFloat {
Context::const_ln10(self)
}
fn emin(&self) -> Exponent {
Context::emin(self)
}
fn emax(&self) -> Exponent {
Context::emax(self)
}
}