Struct extendr_api::scalar::Rint

pub struct Rint(pub i32);

Rint is a wrapper for i32 in the context of an R’s integer vector.

Rint can have a value between i32::MIN+1 and i32::MAX

The value i32::MIN is used as “NA”.

Rint has the same footprint as an i32 value allowing us to use it in zero copy slices.

Tuple Fields

0: i32

Implementations

impl Rint

pub fn inner(&self) -> i32

Get underlying value.

Trait Implementations

impl Add<Rint> for &Rint

fn add(self, rhs: Rint) -> Self::Output

Add two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the + operator.

impl Add<Rint> for Rint

fn add(self, rhs: Rint) -> Self::Output

Add two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the + operator.

impl Add<Rint> for i32

fn add(self, rhs: Rint) -> Self::Output

Add two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the + operator.

impl Add<i32> for Rint

fn add(self, rhs: i32) -> Self::Output

Add two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the + operator.

impl AddAssign<Rint> for &mut Rint

fn add_assign(&mut self, other: Rint)

Add two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl AddAssign<Rint> for Option<i32>

fn add_assign(&mut self, other: Rint)

Add two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl AddAssign<Rint> for Rint

fn add_assign(&mut self, other: Rint)

Add two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl AddAssign<i32> for &mut Rint

fn add_assign(&mut self, other: i32)

Add two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl AddAssign<i32> for Rint

fn add_assign(&mut self, other: i32)

Add two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl<'a> AsTypedSlice<'a, Rint> for Robjwhere Self: 'a,

fn as_typed_slice(&self) -> Option<&'a [Rint]>

fn as_typed_slice_mut(&mut self) -> Option<&'a mut [Rint]>

impl CanBeNA for Rint

use extendr_api::prelude::*;
test! {
    assert!((<Rint>::na()).is_na());
}

fn is_na(&self) -> bool

Return true is the is a NA value.

fn na() -> Self

Construct a NA.

impl Clone for Rint

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Debug format.

impl Default for Rint

use extendr_api::prelude::*;
test! {
    assert_eq!(<Rint>::default(), <i32>::default());
}

fn default() -> Self

Returns the “default value” for a type.

impl Div<Rint> for &Rint

fn div(self, rhs: Rint) -> Self::Output

Divide two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the / operator.

impl Div<Rint> for Rint

fn div(self, rhs: Rint) -> Self::Output

Divide two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the / operator.

impl Div<Rint> for i32

fn div(self, rhs: Rint) -> Self::Output

Divide two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the / operator.

impl Div<i32> for Rint

fn div(self, rhs: i32) -> Self::Output

Divide two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the / operator.

impl DivAssign<Rint> for &mut Rint

fn div_assign(&mut self, other: Rint)

Divide two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl DivAssign<Rint> for Option<i32>

fn div_assign(&mut self, other: Rint)

Divide two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl DivAssign<Rint> for Rint

fn div_assign(&mut self, other: Rint)

Divide two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl DivAssign<i32> for &mut Rint

fn div_assign(&mut self, other: i32)

Divide two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl DivAssign<i32> for Rint

fn div_assign(&mut self, other: i32)

Divide two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl From<&i32> for Rint

fn from(v: &i32) -> Self

Converts to this type from the input type.

impl From<Option<&i32>> for Rint

fn from(v: Option<&i32>) -> Self

Converts to this type from the input type.

impl From<Option<i32>> for Rint

fn from(v: Option<i32>) -> Self

Converts to this type from the input type.

impl From<Rint> for Option<i32>

fn from(v: Rint) -> Self

Converts to this type from the input type.

impl From<Rint> for Robj

fn from(value: Rint) -> Self

Converts to this type from the input type.

impl From<i32> for Rint

fn from(v: i32) -> Self

Converts to this type from the input type.

impl FromIterator<Rint> for Integers

fn from_iter<T: IntoIterator<Item = Rint>>(iter: T) -> Self

A more generalised iterator collector for small vectors. Generates a non-ALTREP vector.

impl Mul<Rint> for &Rint

fn mul(self, rhs: Rint) -> Self::Output

Multiply two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the * operator.

impl Mul<Rint> for Rint

fn mul(self, rhs: Rint) -> Self::Output

Multiply two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the * operator.

impl Mul<Rint> for i32

fn mul(self, rhs: Rint) -> Self::Output

Multiply two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the * operator.

impl Mul<i32> for Rint

fn mul(self, rhs: i32) -> Self::Output

Multiply two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the * operator.

impl MulAssign<Rint> for &mut Rint

fn mul_assign(&mut self, other: Rint)

Multiply two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl MulAssign<Rint> for Option<i32>

fn mul_assign(&mut self, other: Rint)

Multiply two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl MulAssign<Rint> for Rint

fn mul_assign(&mut self, other: Rint)

Multiply two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl MulAssign<i32> for &mut Rint

fn mul_assign(&mut self, other: i32)

Multiply two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl MulAssign<i32> for Rint

fn mul_assign(&mut self, other: i32)

Multiply two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl Neg for &Rint

fn neg(self) -> Self::Output

Negate a Rint value, overflows to NA.

type Output = Rint

The resulting type after applying the - operator.

impl Neg for Rint

fn neg(self) -> Self::Output

Negate a Rint value, overflows to NA.

type Output = Rint

The resulting type after applying the - operator.

impl Not for &Rint

fn not(self) -> Self::Output

Logical not a Rint value, overflows to NA.

type Output = Rint

The resulting type after applying the ! operator.

impl Not for Rint

fn not(self) -> Self::Output

Logical not a Rint value, overflows to NA.

type Output = Rint

The resulting type after applying the ! operator.

impl PartialEq<Rint> for Rint

use extendr_api::prelude::*;
test! {
    assert!(<Rint>::default().eq(&<Rint>::default()));
    assert!(!<Rint>::na().eq(&<Rint>::na()));
}

fn eq(&self, other: &Rint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i32> for &Rint

use extendr_api::prelude::*;
test! {
    assert!(<Rint>::default().eq(&<i32>::default()));
}

fn eq(&self, other: &i32) -> bool

NA always fails.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i32> for Rint

use extendr_api::prelude::*;
test! {
    assert!(<Rint>::default().eq(&<i32>::default()));
}

fn eq(&self, other: &i32) -> bool

NA always fails.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Rint> for &Rint

fn sub(self, rhs: Rint) -> Self::Output

Subtract two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the - operator.

impl Sub<Rint> for Rint

fn sub(self, rhs: Rint) -> Self::Output

Subtract two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the - operator.

impl Sub<Rint> for i32

fn sub(self, rhs: Rint) -> Self::Output

Subtract two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the - operator.

impl Sub<i32> for Rint

fn sub(self, rhs: i32) -> Self::Output

Subtract two Rint values or an option of i32, overflows to NA.

type Output = Rint

The resulting type after applying the - operator.

impl SubAssign<Rint> for &mut Rint

fn sub_assign(&mut self, other: Rint)

Subtract two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl SubAssign<Rint> for Option<i32>

fn sub_assign(&mut self, other: Rint)

Subtract two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl SubAssign<Rint> for Rint

fn sub_assign(&mut self, other: Rint)

Subtract two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl SubAssign<i32> for &mut Rint

fn sub_assign(&mut self, other: i32)

Subtract two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl SubAssign<i32> for Rint

fn sub_assign(&mut self, other: i32)

Subtract two Rint values or an option of i32, modifying the left-hand side in place. Overflows to NA.

impl<'a> Sum<&'a Rint> for Rint

fn sum<I: Iterator<Item = &'a Rint>>(iter: I) -> Rint

Yields NA on overflow if NAs present.

use extendr_api::prelude::*;
use std::iter::Sum;
test! {
    let z =Rint::default();
    let x = (0..100).map(|_| &z);
    assert_eq!(<Rint as Sum<& Rint>>::sum(x), <Rint>::default());
}

impl Sum<Rint> for Rint

fn sum<I: Iterator<Item = Rint>>(iter: I) -> Rint

Yields NA on overflow if NAs present.

use extendr_api::prelude::*;
use std::iter::Sum;
test! {
    let x = (0..100).map(|x| Rint::default());
    assert_eq!(<Rint as Sum>::sum(x), <Rint>::default());
}

impl TryFrom<&Robj> for Rint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(robj: &Robj) -> Result<Self>

Performs the conversion.

impl TryFrom<Robj> for Rint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(robj: Robj) -> Result<Self>

Performs the conversion.

impl Copy for Rint