Struct extendr_api::scalar::Rint

pub struct Rint(/* private fields */);

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.

Implementations

impl Rint

pub fn min(&self, other: Self) -> Self

use extendr_api::prelude::*;
test! {
    assert!(Rint::na().min(Rint::default()).is_na());    
    assert!(Rint::default().min(Rint::na()).is_na());
    assert_eq!(Rint::default().min(Rint::default()), Rint::default());
    assert_eq!(Rint::from(1).min(Rint::from(2)), Rint::from(1));    
    assert_eq!(Rint::from(2).min(Rint::from(1)), Rint::from(1));    
}

pub fn max(&self, other: Self) -> Self

use extendr_api::prelude::*;
test! {
    assert!(Rint::na().max(Rint::default()).is_na());    
    assert!(Rint::default().max(Rint::na()).is_na());
    assert_eq!(Rint::default().max(Rint::default()), Rint::default());
    assert_eq!(Rint::from(1).max(Rint::from(2)), Rint::from(2));    
    assert_eq!(Rint::from(2).max(Rint::from(1)), Rint::from(2));    
}

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 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 Add 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 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<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 AddAssign 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<'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<'de> Deserialize<'de> for Rint

fn deserialize<D>(deserializer: D) -> Result<Rint, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for Rint

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value>where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_unit_struct<V>( self, name: &'static str, visitor: V ) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_newtype_struct<V>( self, name: &'static str, visitor: V ) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_tuple<V>( self, len: usize, visitor: V ) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V>( self, name: &'static str, len: usize, visitor: V ) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_struct<V>( self, name: &'static str, fields: &'static [&'static str], visitor: V ) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_enum<V>( self, name: &'static str, variants: &'static [&'static str], visitor: V ) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

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 Div 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 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<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 DivAssign 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 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 Rfloat

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 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 Mul 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 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<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 MulAssign 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 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 i32

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

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 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 PartialOrd<Rint> for i32

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

fn partial_cmp(&self, other: &Rint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<i32> for Rint

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

fn partial_cmp(&self, other: &i32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for Rint

use extendr_api::prelude::*;
test! {
    assert_eq!(<Rint>::default() <  <Rint>::na(), false);
    assert_eq!(<Rint>::default() <= <Rint>::na(), false);
    assert_eq!(<Rint>::default() >  <Rint>::na(), false);
    assert_eq!(<Rint>::default() >= <Rint>::na(), false);
    assert_eq!(<Rint>::default() <  <Rint>::default(), false);
    assert_eq!(<Rint>::default() <= <Rint>::default(), true);
    assert_eq!(<Rint>::default() >  <Rint>::default(), false);
    assert_eq!(<Rint>::default() >= <Rint>::default(), true);
}

fn partial_cmp(&self, other: &Rint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Scalar<i32> for Rint

fn inner(&self) -> i32

fn new(val: i32) -> Self

impl Serialize for Rint

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

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 Sub 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 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<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 SubAssign 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<'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 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 ToVectorValue for &Rint

fn sexptype() -> SEXPTYPE

fn to_real(&self) -> f64where Self: Sized,

fn to_complex(&self) -> Rcomplexwhere Self: Sized,

fn to_integer(&self) -> i32where Self: Sized,

fn to_logical(&self) -> i32where Self: Sized,

fn to_raw(&self) -> u8where Self: Sized,

fn to_sexp(&self) -> SEXPwhere Self: Sized,

impl ToVectorValue for Rint

fn sexptype() -> SEXPTYPE

fn to_real(&self) -> f64where Self: Sized,

fn to_complex(&self) -> Rcomplexwhere Self: Sized,

fn to_integer(&self) -> i32where Self: Sized,

fn to_logical(&self) -> i32where Self: Sized,

fn to_raw(&self) -> u8where Self: Sized,

fn to_sexp(&self) -> SEXPwhere Self: Sized,

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