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
//! Points on the 2D character grid.
use std::cmp::{max, min, Ordering};
use std::ops::{Add, Div, Mul, Sub};
use num::traits::Zero;
use crate::div;
use crate::XY;
/// Simple 2D size, in cells.
///
/// Note: due to a bug in rustdoc ([#32077]), the documentation for `Vec2` is
/// currently shown on the [`XY`] page.
///
/// [#32077]: https://github.com/rust-lang/rust/issues/32077
/// [`XY`]: crate::XY
pub type Vec2 = XY<usize>;
/// A signed 2D quantity, in cells.
///
/// Usually represents an offset.
pub type Vec2i = XY<isize>;
impl<T: PartialOrd> PartialOrd for XY<T> {
/// `a < b` <=> `a.x < b.x && a.y < b.y`
fn partial_cmp(&self, other: &XY<T>) -> Option<Ordering> {
if self == other {
Some(Ordering::Equal)
} else if self.x < other.x && self.y < other.y {
Some(Ordering::Less)
} else if self.x > other.x && self.y > other.y {
Some(Ordering::Greater)
} else {
None
}
}
}
impl XY<usize> {
/// Returns a `Vec2` with `usize::max_value()` in each axis.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// assert!(Vec2::new(9999, 9999) < Vec2::max_value());
/// ```
#[must_use]
pub fn max_value() -> Self {
Self::new(usize::max_value(), usize::max_value())
}
/// Saturating subtraction. Computes `self - other`, saturating at 0.
///
/// Never panics.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let u = Vec2::new(1, 2);
/// let v = Vec2::new(2, 1);
/// assert_eq!(u.saturating_sub(v), Vec2::new(0, 1));
/// ```
#[must_use]
pub fn saturating_sub<O: Into<Self>>(&self, other: O) -> Self {
let other = other.into();
self.zip_map(other, usize::saturating_sub)
}
/// Saturating addition with a signed vec.
///
/// Any coordinates saturates to 0.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// # use cursive_core::XY;
/// let u = Vec2::new(1, 2);
/// let v = XY::<isize>::new(-2, 1);
/// assert_eq!(u.saturating_add(v), Vec2::new(0, 3));
/// ```
#[must_use]
pub fn saturating_add<O: Into<XY<isize>>>(&self, other: O) -> Self {
let other = other.into();
self.zip_map(other, |s, o| {
if o > 0 {
s.saturating_add(o as usize)
} else {
s.saturating_sub((-o) as usize)
}
})
}
/// Checked addition with a signed vec.
///
/// Will return `None` if any coordinates exceeds bounds.
pub fn checked_add<O: Into<XY<isize>>>(&self, other: O) -> Option<Self> {
let other = other.into();
self.zip_map(other, |s, o| {
if o > 0 {
s.checked_add(o as usize)
} else {
s.checked_sub((-o) as usize)
}
})
.both()
}
/// Term-by-term integer division that rounds up.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let u = Vec2::new(1, 6);
/// let v = Vec2::new(2, 3);
/// assert_eq!(u.div_up(v), Vec2::new(1, 2));
/// ```
#[must_use]
pub fn div_up<O>(&self, other: O) -> Self
where
O: Into<Self>,
{
self.zip_map(other.into(), div::div_up)
}
/// Checked subtraction. Computes `self - other` if possible.
///
/// Returns `None` if `self.x < other.x || self.y < other.y`.
///
/// Never panics.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let xy = Vec2::new(1, 2);
/// assert_eq!(xy.checked_sub((1, 1)), Some(Vec2::new(0, 1)));
/// assert_eq!(xy.checked_sub((2, 2)), None);
/// ```
pub fn checked_sub<O: Into<Self>>(&self, other: O) -> Option<Self> {
let other = other.into();
if self.fits(other) {
Some(*self - other)
} else {
None
}
}
/// Returns a `XY<isize>` from `self`.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// # use cursive_core::XY;
/// let v: XY<isize> = Vec2::new(1, 2).signed().map(|i| i - 5);
/// assert_eq!(v, XY::new(-4, -3));
///
/// let u = Vec2::new(3, 4);
/// assert_eq!(u.saturating_add(v), Vec2::new(0, 1));
/// ```
pub fn signed(self) -> XY<isize> {
self.into()
}
}
impl<T: Ord> XY<T> {
/// Returns `true` if `self` could fit inside `other`.
///
/// Shortcut for `self.x <= other.x && self.y <= other.y`.
///
/// If this returns `true`, then `other - self` will not underflow.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let v = Vec2::new(1, 2);
/// assert!(v.fits_in((1, 2)));
/// assert!(v.fits_in((3, 3)));
/// assert!(!v.fits_in((2, 1)));
/// ```
pub fn fits_in<O: Into<Self>>(&self, other: O) -> bool {
let other = other.into();
self.x <= other.x && self.y <= other.y
}
/// Returns `true` if `other` could fit inside `self`.
///
/// Shortcut for `self.x >= other.x && self.y >= other.y`.
///
/// If this returns `true`, then `self - other` will not underflow.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let v = Vec2::new(1, 2);
/// assert!(v.fits((1, 2)));
/// assert!(v.fits((0, 0)));
/// assert!(!v.fits((2, 1)));
/// ```
pub fn fits<O: Into<Self>>(&self, other: O) -> bool {
let other = other.into();
self.x >= other.x && self.y >= other.y
}
/// Returns `true` if `other` is strictly less than `self` in each axis.
pub fn strictly_lt<O: Into<Self>>(&self, other: O) -> bool {
let other = other.into();
self < &other
}
/// Returns `true` if `other` is strictly greater than `self` in each axis.
pub fn strictly_gt<O: Into<Self>>(&self, other: O) -> bool {
let other = other.into();
self > &other
}
/// Returns a new Vec2 that is a maximum per coordinate.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// assert_eq!(Vec2::max((1, 2), (3, 1)), Vec2::new(3, 2));
/// ```
#[must_use]
pub fn max<A: Into<XY<T>>, B: Into<XY<T>>>(a: A, b: B) -> Self {
let a = a.into();
let b = b.into();
a.zip_map(b, max)
}
/// Returns a new Vec2 that is no larger than any input in both dimensions.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// assert_eq!(Vec2::min((1, 2), (3, 1)), Vec2::new(1, 1));
/// ```
#[must_use]
pub fn min<A: Into<XY<T>>, B: Into<XY<T>>>(a: A, b: B) -> Self {
let a = a.into();
let b = b.into();
a.zip_map(b, min)
}
/// Returns the minimum of `self` and `other`.
///
/// This is equivalent to `Vec2::min(self, other)`.
#[must_use]
pub fn or_min<O: Into<XY<T>>>(self, other: O) -> Self {
Self::min(self, other)
}
/// Returns the maximum of `self` and `other`.
///
/// This is equivalent to `Vec2::max(self, other)`.
#[must_use]
pub fn or_max<O: Into<XY<T>>>(self, other: O) -> Self {
Self::max(self, other)
}
}
impl<T: Ord + Add<Output = T> + Clone> XY<T> {
/// Returns (max(self.x,other.x), self.y+other.y)
#[must_use]
pub fn stack_vertical(&self, other: &Self) -> Self {
Self::new(
max(self.x.clone(), other.x.clone()),
self.y.clone() + other.y.clone(),
)
}
/// Returns (self.x+other.x, max(self.y,other.y))
#[must_use]
pub fn stack_horizontal(&self, other: &Self) -> Self {
Self::new(
self.x.clone() + other.x.clone(),
max(self.y.clone(), other.y.clone()),
)
}
/// Returns `true` if `self` fits in the given rectangle.
pub fn fits_in_rect<O1, O2>(&self, top_left: O1, size: O2) -> bool
where
O1: Into<Self>,
O2: Into<Self>,
{
let top_left = top_left.into();
self.fits(top_left.clone()) && self < &(top_left + size)
}
}
impl<T: Add> XY<T> {
/// Returns `self.x + self.y`.
pub fn sum(self) -> T::Output {
self.fold(std::ops::Add::add)
}
}
impl<T: Mul> XY<T> {
/// Returns `self.x * self.y`
pub fn product(self) -> T::Output {
self.fold(std::ops::Mul::mul)
}
}
impl<T: Zero + Clone> XY<T> {
/// Returns a vector with the X component of self, and y=0.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let xy = XY::new(1, 2);
/// assert_eq!(xy.keep_x(), XY::new(1, 0));
/// ```
#[must_use]
pub fn keep_x(&self) -> Self {
Self::new(self.x.clone(), T::zero())
}
/// Returns a vector with the Y component of self, and x=0.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let xy = XY::new(1, 2);
/// assert_eq!(xy.keep_y(), XY::new(0, 2));
/// ```
#[must_use]
pub fn keep_y(&self) -> Self {
Self::new(T::zero(), self.y.clone())
}
/// Alias for `Self::new(0,0)`.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// assert_eq!(Vec2::zero(), Vec2::new(0, 0));
/// ```
#[must_use]
pub fn zero() -> Self {
Self::new(T::zero(), T::zero())
}
}
impl<'a, T> From<&'a XY<T>> for XY<T>
where
T: Clone,
{
/// Clone a XY
///
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let xy = XY::new(String::from("a"), String::from("ab"));
/// assert_eq!(XY::from(&xy), xy);
/// ```
fn from(t: &'a XY<T>) -> Self {
t.clone()
}
}
// Anything that can become XY<usize> can also become XY<isize>
impl<T> From<T> for XY<isize>
where
T: Into<XY<usize>>,
{
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// # use cursive_core::Vec2;
/// let u = Vec2::new(1, 2);
/// let v: XY<isize> = XY::from(u);
/// assert_eq!(v, XY::new(1, 2));
/// ```
fn from(t: T) -> Self {
let other = t.into();
Self::new(other.x as isize, other.y as isize)
}
}
impl From<(i32, i32)> for XY<usize> {
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let xy: XY<isize> = XY::from((-1i32, -2i32));
/// assert_eq!(xy, XY::new(-1, -2));
/// ```
fn from((x, y): (i32, i32)) -> Self {
(x as usize, y as usize).into()
}
}
impl From<(u32, u32)> for XY<usize> {
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let v = Vec2::from((1u32, 2u32));
/// assert_eq!(v, Vec2::new(1, 2));
/// ```
fn from((x, y): (u32, u32)) -> Self {
(x as usize, y as usize).into()
}
}
impl From<(u8, u8)> for XY<usize> {
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let v = Vec2::from((1u8, 2u8));
/// assert_eq!(v, Vec2::new(1, 2));
/// ```
fn from((x, y): (u8, u8)) -> Self {
(x as usize, y as usize).into()
}
}
impl From<(u16, u16)> for XY<usize> {
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let v = Vec2::from((1u16, 2u16));
/// assert_eq!(v, Vec2::new(1, 2));
/// ```
fn from((x, y): (u16, u16)) -> Self {
(x as usize, y as usize).into()
}
}
// Allow xy + (into xy)
impl<T, O> Add<O> for XY<T>
where
T: Add<Output = T>,
O: Into<XY<T>>,
{
type Output = Self;
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let xy = XY::new(1, 2);
/// assert_eq!(xy + (2, 3), XY::new(3, 5));
/// ```
fn add(self, other: O) -> Self {
self.zip_map(other.into(), Add::add)
}
}
impl<T, O> Sub<O> for XY<T>
where
T: Sub<Output = T>,
O: Into<XY<T>>,
{
type Output = Self;
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let xy = XY::new(1, 2);
/// assert_eq!(xy - (1, 0), XY::new(0, 2));
/// ```
fn sub(self, other: O) -> Self {
self.zip_map(other.into(), Sub::sub)
}
}
impl<T: Clone + Div<Output = T>> Div<T> for XY<T> {
type Output = Self;
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let xy = XY::new(1, 4);
/// assert_eq!(xy / 2, XY::new(0, 2));
/// ```
fn div(self, other: T) -> Self {
self.map(|s| s / other.clone())
}
}
impl Mul<usize> for XY<usize> {
type Output = Vec2;
/// # Examples
///
/// ```rust
/// # use cursive_core::Vec2;
/// let v = Vec2::new(1, 2);
/// assert_eq!(v * 2, Vec2::new(2, 4));
/// ```
fn mul(self, other: usize) -> Vec2 {
self.map(|s| s * other)
}
}
impl<T> Mul<XY<T>> for XY<T>
where
T: Mul<T>,
{
type Output = XY<T::Output>;
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let u = XY::new(1, 2);
/// let v = XY::new(2, 3);
/// assert_eq!(u * v, XY::new(2, 6));
/// ```
fn mul(self, other: XY<T>) -> Self::Output {
self.zip_map(other, |s, o| s * o)
}
}
impl<T> Div<XY<T>> for XY<T>
where
T: Div<T>,
{
type Output = XY<T::Output>;
/// # Examples
///
/// ```rust
/// # use cursive_core::XY;
/// let u = XY::new(2, 3);
/// let v = XY::new(1, 2);
/// assert_eq!(u / v, XY::new(2, 1));
/// ```
fn div(self, other: XY<T>) -> Self::Output {
self.zip_map(other, |s, o| s / o)
}
}
#[cfg(test)]
mod tests {
use super::Vec2;
#[test]
fn test_from() {
let vi32 = Vec2::from((4i32, 5i32));
let vu32 = Vec2::from((4u32, 5u32));
let vusize = Vec2::from((4usize, 5usize));
let vvec = Vec2::from(Vec2::new(4, 5));
assert_eq!(vi32 - vu32, vusize - vvec);
}
}