extendr_api/scalar/macros.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
/// Generates an implementation of a unary operator Trait for a scalar type
///
/// Generates the implementation of the specified unary operator for both `Type` and
/// `&Type`, using the logic of the provided closure to provide functionality.
///
/// This macro requires the following arguments:
///
/// * `$type` - The Type the unary operator Trait is implemented for
/// * `$opname` - The Trait for which the implementation is generated
/// * `$expr` - A closure providing the logic for the implementation
/// * `$docstring` - String to include as the Doc comment for the Trait implementation
///
/// Example Usage:
///
/// ```ignore
/// gen_unop!(Rint, Neg, |lhs: i32| Some(-lhs), "Doc Comment");
/// ```
///
/// The 'example usage' implements the following trait definitions:
///
/// - `impl Neg for Rint`
/// - `impl Neg for &Rint`
macro_rules! gen_unop {
($type : ty, $opname : ident, $expr: expr, $docstring: expr) => {
// The 'example usage' expands to...
//
// impl Neg for Rint {
// type Output = Rint;
//
// /// Doc Comment
// fn neg(self) -> Self::Output {
// if let Some(lhs) = self.into() {
// let f = |lhs: i32| Some(-lhs);
// if let Some(res) = f(lhs) {
// return Rint::from(res);
// }
// }
// Rint::na()
// }
impl $opname for $type {
type Output = $type;
paste::paste! {
#[doc = $docstring]
// Note: $opname:lower lowercases the Trait name, i.e. Neg -> neg
fn [<$opname:lower>](self) -> Self::Output {
if let Some(lhs) = self.into() {
let f = $expr;
if let Some(res) = f(lhs) {
// Note that if res is NA, this will also be NA.
return $type::from(res);
}
}
$type::na()
}
}
}
// The 'example usage' expands to...
//
// impl Neg for &Rint {
// type Output = Rint;
//
// /// Doc Comment
// fn neg(self) -> Self::Output {
// if let Some(lhs) = (*self).into() {
// let f = |lhs: i32| Some(-lhs);
// if let Some(res) = f(lhs) {
// return Rint::from(res);
// }
// }
// Rint::na()
// }
impl $opname for &$type {
type Output = $type;
paste::paste! {
#[doc = $docstring]
// Note: $opname:lower lowercases the Trait name, i.e. Neg -> neg
fn [< $opname:lower >](self) -> Self::Output {
if let Some(lhs) = (*self).into() {
let f = $expr;
if let Some(res) = f(lhs) {
// Note that if res is NA, this will also be NA.
return $type::from(res);
}
}
$type::na()
}
}
}
};
}
/// Generates an implementation of a binary operator Trait for a scalar type
///
/// This macro requires the following arguments:
///
/// * `$type` - The Type the binary operator Trait is implemented for
/// * `$type_prim` - The primitive Rust scalar type that corresponds to `$type`
/// * `$opname` - The Trait for which the implementation is generated
/// * `$expr` - A closure providing the logic for the implementation
/// * `$docstring` - String to include as the Doc comment for the Trait implementation
///
/// Example Usage:
///
/// ```ignore
/// gen_binop!(Rint, i32, Add, |lhs: i32, rhs| lhs.checked_add(rhs), "Doc Comment");
/// ```
///
/// The 'example usage' implements the following trait definitions:
///
/// - `impl Add<Rint> for Rint`
/// - `impl Add<Rint> for &Rint`
/// - `impl Add<i32> for Rint`
/// - `impl Add<Rint> for i32`
// TODO: binary operators for pairs `(Rtype, Type)` and `(Type, Rtype)` using references?
macro_rules! gen_binop {
($type : tt, $type_prim : tt, $opname : ident, $expr: expr, $docstring: expr) => {
// The 'example usage' expands to...
//
// impl Add<Rint> for Rint {
// type Output = Rint;
// /// Doc Comment
// fn add(self, rhs: Rint) -> Self::Output {
// if let Some(lhs) = self.clone().into() {
// if let Some(rhs) = rhs.into() {
// let f = |lhs: i32, rhs| lhs.checked_add(rhs);
// if let Some(res) = f(lhs, rhs) {
// return Rint::from(res);
// }
// }
// }
// Rint::na()
// }
// }
impl $opname<$type> for $type {
type Output = $type;
paste::paste! {
#[doc = $docstring]
// Note: $opname:lower lowercases the Trait name, i.e. Add -> add
fn [< $opname:lower >](self, rhs: $type) -> Self::Output {
if let Some(lhs) = self.clone().into() {
if let Some(rhs) = rhs.into() {
let f = $expr;
if let Some(res) = f(lhs, rhs) {
// Note that if res is NA, this will also be NA.
return $type::from(res);
}
}
}
$type::na()
}
}
}
// The 'example usage' expands to...
//
// impl Add<Rint> for &Rint {
// type Output = Rint;
// /// Doc Comment
// fn add(self, rhs: Rint) -> Self::Output {
// if let Some(lhs) = self.clone().into() {
// if let Some(rhs) = rhs.into() {
// let f = |lhs:i32, rhs| lhs.checked_add(rhs);
// if let Some(res) = f(lhs, rhs) {
// return Rint::from(res);
// }
// }
// }
// Rint::na()
// }
// }
impl $opname<$type> for &$type {
type Output = $type;
paste::paste! {
#[doc = $docstring]
// Note: $opname:lower lowercases the Trait name, i.e. Add -> add
fn [< $opname:lower >](self, rhs: $type) -> Self::Output {
if let Some(lhs) = self.clone().into() {
if let Some(rhs) = rhs.into() {
let f = $expr;
if let Some(res) = f(lhs, rhs) {
// Note that if res is NA, this will also be NA.
return $type::from(res);
}
}
}
$type::na()
}
}
}
// The 'example usage' expands to...
//
// impl Add<i32> for Rint {
// type Output = Rint;
// /// Doc Comment
// fn add(self, rhs: i32) -> Self::Output {
// if let Some(lhs) = self.clone().into() {
// let f = |lhs:i32, rhs| lhs.checked_add(rhs);
// if let Some(res) = f(lhs, rhs) {
// return Rint::from(res);
// }
// }
// Rint::na()
// }
// }
impl $opname<$type_prim> for $type {
type Output = $type;
paste::paste! {
#[doc = $docstring]
// Note: $opname:lower lowercases the Trait name, i.e. Add -> add
fn [< $opname:lower >](self, rhs: $type_prim) -> Self::Output {
if let Some(lhs) = self.clone().into() {
let f = $expr;
if let Some(res) = f(lhs, rhs) {
// Note that if res is NA, this will also be NA.
return $type::from(res);
}
}
$type::na()
}
}
}
// The 'example usage' expands to...
//
// impl Add<Rint> for i32 {
// type Output = Rint;
// /// Doc Comment
// fn add(self, rhs: Rint) -> Self::Output {
// if let Some(rhs) = self.clone().into() {
// let f = |lhs:i32, rhs| lhs.checked_add(rhs);
// if let Some(res) = f(lhs, rhs) {
// return Rint::from(res);
// }
// }
// Rint::na()
// }
// }
impl $opname<$type> for $type_prim {
type Output = $type;
paste::paste! {
#[doc = $docstring]
// Note: $opname:lower lowercases the Trait name, i.e. Add -> add
fn [< $opname:lower >](self, rhs: $type) -> Self::Output {
if let Some(rhs) = rhs.clone().into() {
let f = $expr;
if let Some(res) = f(self, rhs) {
// Note that if res is NA, this will also be NA.
return $type::from(res);
}
}
$type::na()
}
}
}
};
}
/// Generates an implementation of a binary operate-assign Trait for a scalar type
///
/// This macro requires the following arguments:
///
/// * `$type` - The Type the binary operate-assign Trait is implemented for
/// * `$type_prim` - The primitive Rust scalar type that corresponds to `$type`
/// * `$opname` - The Trait for which the implementation is generated
/// * `$expr` - A closure providing the logic for the implementation
/// * `$docstring` - String to include as the Doc comment for the Trait implementation
///
/// Example Usage:
///
/// ```ignore
/// gen_binopassign!(Rint, i32, AddAssign, |lhs: i32, rhs| lhs.checked_add(rhs), "Doc Comment");
/// ```
///
/// The 'example usage' implements the following trait definitions:
///
/// - `impl AddAssign<Rint> for Rint`
/// - `impl AddAssign<Rint> for &mut Rint`
/// - `impl AddAssign<i32> for Rint`
/// - `impl AddAssign<i32> for &mut Rint`
/// - `impl AddAssign<Rint> for Option<i32>`
macro_rules! gen_binopassign {
($type : ty, $type_prim : ty, $opname : ident, $expr: expr, $docstring: expr) => {
// The 'example usage' expands to...
//
// impl AddAssign<Rint> for Rint {
// /// Doc Comment
// fn add_assign(&mut self, other: Rint) {
// match (self.clone().into(), other.into()) {
// (Some(lhs), Some(rhs)) => {
// let f = |lhs: i32, rhs| lhs.checked_add(rhs);
// match f(lhs, rhs) {
// Some(res) => *self = Rint::from(res),
// None => *self = Rint:na(),
// }
// }
// _ => *self = Rint::na(),
// }
// }
// }
impl $opname<$type> for $type {
paste::paste! {
#[doc = $docstring]
// Note: $opname:snake snake cases the Trait name, i.e. AddAssign -> add_assign
fn [< $opname:snake >](&mut self, other: $type) {
// `.clone()` is needed to convert &mut Rint -> Rint -> Option<$type_prim>
match (self.clone().into(), other.into()) {
(Some(lhs), Some(rhs)) => {
let f = $expr;
match f(lhs, rhs) {
Some(res) => *self = $type::from(res),
None => *self = $type::na(),
}
},
_ => *self = $type::na(),
}
}
}
}
// The 'example usage' expands to...
//
// impl AddAssign<Rint> for &mut Rint {
// /// Doc Comment
// fn add_assign(&mut self, other: Rint) {
// match (self.clone().into(), other.into()) {
// (Some(lhs), Some(rhs)) => {
// let f = |lhs: i32, rhs| lhs.checked_add(rhs);
// match f(lhs, rhs) {
// Some(res) => **self = Rint::from(res),
// None => **self = Rint:na(),
// }
// }
// _ => **self = Rint::na(),
// }
// }
// }
impl $opname<$type> for &mut $type {
paste::paste! {
#[doc = $docstring]
// Note: $opname:snake snake cases the Trait name, i.e. AddAssign -> add_assign
fn [< $opname:snake >](&mut self, other: $type) {
// `.clone()` is needed to convert &mut &mut Rint -> Rint -> Option<$type_prim>
match (self.clone().into(), other.into()) {
(Some(lhs), Some(rhs)) => {
let f = $expr;
match f(lhs, rhs) {
Some(res) => **self = $type::from(res),
None => **self = $type::na(),
}
},
_ => **self = $type::na(),
}
}
}
}
// The 'example usage' expands to...
//
// impl AddAssign<i32> for Rint {
// /// Doc Comment
// fn add_assign(&mut self, other: i32) {
// match self.clone().int() {
// Some(lhs) => {
// let f = |lhs: i32, rhs| lhs.checked_add(rhs);
// match f(lhs, rhs) {
// Some(res) => *self = Rint::from(res),
// None => *self = Rint:na(),
// }
// }
// _ => *self = Rint::na(),
// }
// }
// }
// }
impl $opname<$type_prim> for $type {
paste::paste! {
#[doc = $docstring]
// Note: $opname:snake snake cases the Trait name, i.e. AddAssign -> add_assign
fn [< $opname:snake >](&mut self, other: $type_prim) {
// `.clone()` is needed to convert &mut Rint -> Rint -> Option<$type_prim>
match self.clone().into() {
Some(lhs) => {
let f = $expr;
match f(lhs, other) {
Some(res) => *self = $type::from(res),
None => *self = $type::na(),
}
}
None => *self = $type::na(),
}
}
}
}
// The 'example usage' expands to...
//
// impl AddAssign<i32> for &mut Rint {
// /// Doc Comment
// fn add_assign(&mut self, other: i32) {
// match self.clone().int() {
// Some(lhs) => {
// let f = |lhs: i32, rhs| lhs.checked_add(rhs);
// match f(lhs, rhs) {
// Some(res) => **self = Rint::from(res),
// None => **self = Rint:na(),
// }
// }
// _ => **self = Rint::na(),
// }
// }
// }
// }
impl $opname<$type_prim> for &mut $type {
paste::paste! {
#[doc = $docstring]
// Note: $opname:snake snake cases the Trait name, i.e. AddAssign -> add_assign
fn [< $opname:snake >](&mut self, other: $type_prim) {
// `.clone()` is needed to convert &mut &mut Rint -> Rint -> Option<$type_prim>
match self.clone().into() {
Some(lhs) => {
let f = $expr;
match f(lhs, other) {
Some(res) => **self = $type::from(res),
None => **self = $type::na(),
}
}
None => **self = $type::na(),
}
}
}
}
// The 'example usage' expands to...
//
// impl AddAssign<Rint> for Option<i32> {
// /// Doc Comment
// fn add_assign(&mut self, other: Rint) {
// match (*self, other.into()) {
// (Some(lhs), Some(rhs)) => {
// let f = |lhs: i32, rhs| lhs.checked_add(rhs);
// *self = f(lhs, rhs);
// },
// _ => *self = None,
// }
// }
// }
impl $opname<$type> for Option<$type_prim> {
paste::paste! {
#[doc = $docstring]
// Note: $opname:snake snake cases the Trait name, i.e. AddAssign -> add_assign
fn [< $opname:snake >](&mut self, other: $type) {
match (*self, other.into()) {
(Some(lhs), Some(rhs)) => {
let f = $expr;
let _ = (); // confuse clippy.
*self = f(lhs, rhs);
},
_ => *self = None,
}
}
}
}
};
}
/// Generates an implementation of type conversion Traits from a primitive type
///
/// This macro requires the following arguments:
///
/// * `$type` - The Type the unary operator Trait is implemented for
/// * `$type_prim` - The primitive Rust scalar type that corresponds to `$type`
///
/// Example Usage:
///
/// ```ignore
/// gen_from_primitive!(Rint, i32);
/// ```
///
/// The 'example usage' implements the following trait definitions:
///
/// - `From<i32> for Rint`
/// - `From<Option<i32>> for Rint`
macro_rules! gen_from_primitive {
($type : tt, $type_prim : tt) => {
// The 'example usage' expands to...
//
// impl From<i32> for Rint {
// fn from(v: i32) -> Self {
// Self(v)
// }
// }
impl From<$type_prim> for $type {
fn from(v: $type_prim) -> Self {
Self(v)
}
}
// Same but for references
impl From<&$type_prim> for $type {
fn from(v: &$type_prim) -> Self {
Self(*v)
}
}
// The 'example usage' expands to...
//
// impl From<Option<i32>> for Rint {
// fn from(v: Option<i32>) -> Self {
// if let Some(v) = v {
// v.into()
// } else {
// Rint::na()
// }
// }
// }
impl From<Option<$type_prim>> for $type {
fn from(v: Option<$type_prim>) -> Self {
if let Some(v) = v {
v.into()
} else {
$type::na()
}
}
}
// Same but for references
impl From<Option<&$type_prim>> for $type {
fn from(v: Option<&$type_prim>) -> Self {
if let Some(v) = v {
v.into()
} else {
$type::na()
}
}
}
};
}
/// Generates an implementation of a number of Traits for the specified Type
///
/// This macro requires the following arguments:
///
/// * `$type` - The Type the Traits are implemented for
/// * `$type_prim` - The primitive Rust scalar type that corresponds to `$type`
/// * `$na_check` - Closure that provides `NA`-checking logic
/// * `$na_val` - The Rust-native value that translates to `NA`
///
/// Example Usage:
///
/// ```ignore
/// gen_trait_impl!(Rint, i32, |x: &Rint| x.0 == i32::MIN, i32::MIN);
/// ```
///
/// The 'example usage' implements the following trait definitions:
///
/// - `impl Clone for Rint`
/// - `impl Copy for Rint`
/// - `impl CanBeNA for Rint` // Includes doc test
/// - `impl Debug for Rint`
/// - `impl PartialEq<Rint> for Rint` // Includes doc test
/// - `impl PartialEq<i32> for Rint` // Includes doc test
/// - `impl Default for Rint` // Includes doc test
macro_rules! gen_trait_impl {
($type : ident, $type_prim : ty, $na_check : expr, $na_val : expr) => {
// The 'example usage' expands to...
//
// impl Clone for Rint {
// fn clone(&self) -> Self {
// Self(self.0)
// }
// }
impl Clone for $type {
fn clone(&self) -> Self {
*self
}
}
// The 'example usage' expands to...
//
// impl Copy for Rint {}
impl Copy for $type {}
// The 'example usage' expands to...
//
// /// Documentation comments/test built by the #[doc] attributes
// impl CanBeNA for Rint {
// fn is_na(&self) -> bool {
// (|x: &Rint| x.0 == i32::MIN)(self)
// }
//
// fn na() -> Self {
// Rint(i32::MIN)
// }
// }
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert!((<" $type ">::na()).is_na());"]
#[doc = "}"]
#[doc = "```"]
impl CanBeNA for $type {
/// Return true is the is a NA value.
fn is_na(&self) -> bool {
$na_check(self)
}
/// Construct a NA.
fn na() -> Self {
$type($na_val)
}
}
}
// The 'example usage' expands to...
//
//
// /// Documentation comments/test built by the #[doc] attributes
// impl PartialEq<Rint> for Rint {
// fn eq(&self, other: &Rint) -> bool {
// !(self.is_na() || other.is_na()) && self.0 == other.0
// }
// }
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert!(<" $type ">::default().eq(&<" $type ">::default()));"]
#[doc = " assert!(!<" $type ">::na().eq(&<" $type ">::na()));"]
#[doc = "}"]
#[doc = "```"]
impl PartialEq<$type> for $type {
fn eq(&self, other: &$type) -> bool {
!(self.is_na() || other.is_na()) && self.inner().eq(&other.inner())
}
}
}
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert!(<" $type ">::default().eq(&<" $type_prim ">::default()));"]
#[doc = "}"]
#[doc = "```"]
impl PartialEq<$type_prim> for $type {
/// NA always fails.
fn eq(&self, other: &$type_prim) -> bool {
<Option<$type_prim>>::try_from(self.clone()) == Ok(Some(*other))
}
}
}
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert!(<" $type_prim ">::default().eq(&<" $type ">::default()));"]
#[doc = "}"]
#[doc = "```"]
impl PartialEq<$type> for $type_prim {
fn eq(&self, other: &$type) -> bool {
<Option<$type_prim>>::try_from(*other) == Ok(Some(*self))
}
}
}
// The 'example usage' expands to...
//
// /// Documentation comments/test built by the #[doc] attributes
// impl std::default::Default for Rint {
// fn default() -> Self {
// Rint(<i32>::default())
// }
// }
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert_eq!(<" $type ">::default(), <" $type_prim ">::default());"]
#[doc = "}"]
#[doc = "```"]
impl std::default::Default for $type {
fn default() -> Self {
$type::from(<$type_prim>::default())
}
}
}
};
}
macro_rules! gen_partial_ord {
($type : ident, $type_prim : ty) => {
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert_eq!(<" $type ">::default() < <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type ">::default() <= <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type ">::default() > <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type ">::default() >= <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type ">::default() < <" $type ">::default(), false);"]
#[doc = " assert_eq!(<" $type ">::default() <= <" $type ">::default(), true);"]
#[doc = " assert_eq!(<" $type ">::default() > <" $type ">::default(), false);"]
#[doc = " assert_eq!(<" $type ">::default() >= <" $type ">::default(), true);"]
#[doc = "}"]
#[doc = "```"]
impl std::cmp::PartialOrd<$type> for $type {
fn partial_cmp(&self, other: &$type) -> Option<std::cmp::Ordering> {
if self.is_na() || other.is_na() {
None
} else {
self.inner().partial_cmp(&other.inner())
}
}
}
}
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert_eq!(<" $type_prim ">::default() < <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type_prim ">::default() <= <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type_prim ">::default() > <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type_prim ">::default() >= <" $type ">::na(), false);"]
#[doc = " assert_eq!(<" $type_prim ">::default() < <" $type ">::default(), false);"]
#[doc = " assert_eq!(<" $type_prim ">::default() <= <" $type ">::default(), true);"]
#[doc = " assert_eq!(<" $type_prim ">::default() > <" $type ">::default(), false);"]
#[doc = " assert_eq!(<" $type_prim ">::default() >= <" $type ">::default(), true);"]
#[doc = "}"]
#[doc = "```"]
impl std::cmp::PartialOrd<$type_prim> for $type {
fn partial_cmp(&self, other: &$type_prim) -> Option<std::cmp::Ordering> {
let other: $type = (*other).try_into().unwrap_or($type::na());
self.partial_cmp(&other)
}
}
}
paste::paste! {
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "test! {"]
#[doc = " assert_eq!(<" $type ">::default() < <" $type ">::default(), false);"]
#[doc = " assert_eq!(<" $type ">::default() <= <" $type ">::default(), true);"]
#[doc = " assert_eq!(<" $type ">::default() > <" $type ">::default(), false);"]
#[doc = " assert_eq!(<" $type ">::default() >= <" $type ">::default(), true);"]
#[doc = "}"]
#[doc = "```"]
impl std::cmp::PartialOrd<$type> for $type_prim {
fn partial_cmp(&self, other: &$type) -> Option<std::cmp::Ordering> {
let slf: $type = (*self).try_into().unwrap_or($type::na());
slf.partial_cmp(other)
}
}
}
};
}
/// Generates an implementation of `std::iter::Sum` for a scalar type
///
/// This macro requires the following argument:
///
/// * `$type` - The Type to implement `std::iter::Sum` for
///
/// Example Usage:
///
/// ```ignore
/// gen_sum_iter!(Rint);
/// ```
macro_rules! gen_sum_iter {
($type : ty) => {
// The 'example usage' expands to...
//
// impl std::iter::Sum for $type {
// /// Documentation comments/test built by the #[doc] attributes
// fn sum<I: Iterator<Item = Rint>>(iter: I) -> Rint {
// iter.fold(Rint::default(), |a, b| a + b)
// }
// }
impl std::iter::Sum for $type {
paste::paste! {
#[doc = "Yields NA on overflow if NAs present."]
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "use std::iter::Sum;"]
#[doc = "test! {"]
#[doc = " let x = (0..100).map(|x| " $type "::default());"]
#[doc = " assert_eq!(<" $type " as Sum>::sum(x), <" $type ">::default());"]
#[doc = "}"]
#[doc = "```"]
fn sum<I: Iterator<Item = $type>>(iter: I) -> $type {
iter.fold($type::default(), |a, b| a + b)
}
}
}
// The 'example usage' expands to...
//
// impl std::iter::Sum for &$type {
// /// Documentation comments/test built by the #[doc] attributes
// fn sum<I: Iterator<Item = &Rint>>(iter: I) -> Rint {
// iter.fold(Rint::default(), |a, b| a + b)
// }
// }
impl<'a> std::iter::Sum<&'a $type> for $type {
paste::paste! {
#[doc = "Yields NA on overflow if NAs present."]
#[doc = "```"]
#[doc = "use extendr_api::prelude::*;"]
#[doc = "use std::iter::Sum;"]
#[doc = "test! {"]
#[doc = " let z =" $type "::default();"]
#[doc = " let x = (0..100).map(|_| &z);"]
#[doc = " assert_eq!(<" $type " as Sum<& " $type ">>::sum(x), <" $type ">::default());"]
#[doc = "}"]
#[doc = "```"]
fn sum<I: Iterator<Item = &'a $type>>(iter: I) -> $type {
iter.fold($type::default(), |a, b| a + *b)
}
}
}
};
}
pub(in crate::scalar) use gen_binop;
pub(in crate::scalar) use gen_binopassign;
pub(in crate::scalar) use gen_from_primitive;
pub(in crate::scalar) use gen_partial_ord;
pub(in crate::scalar) use gen_sum_iter;
pub(in crate::scalar) use gen_trait_impl;
pub(in crate::scalar) use gen_unop;