Skip to main content

AsNumericVec

Struct AsNumericVec 

Source
pub struct AsNumericVec(pub Vec<Option<f64>>);
Expand description

A numeric vector read like R’s as.numeric(): from a double, integer, logical, character, or factor (by its labels) vector. NA of any type is None.

Data read from CSV files or spreadsheets often arrives as character, with numbers mixed with tokens such as "n/a" or "<0.1", or as a factor whose labels are the numbers. This marker takes any of those, maps every kind of NA to None, and names the values that are not numbers in one error.

§Reading rules

R inputResult
doubleas is; NA_real_ → None, NaN stays Some(NaN)
integer, logicalwidened to f64; NA → None
characterparsed as as.numeric() does (see below)
factoreach label (levels(x)[x]) parsed as character, never the codes; code NA → None
anything else (list, raw, complex, …)SexpError::Type

Character parsing follows R’s String2Real (RealFromString in src/main/coerce.c):

  • NA_character_ → None.
  • A blank string (empty, or whitespace only) → None, as as.numeric("") gives NA without a warning.
  • The token "NA", with blanks around it at most, → None. This follows scan() / type.convert(), which read "NA" as missing; as.numeric("NA") also gives NA, but with a coercion warning.
  • Otherwise R’s own R_strtod reads a number, and the rest of the string must be blank. That accepts surrounding spaces, "Inf", "-inf", "Infinity", "NaN", "1e3", "+.5", "5.", and hex such as "0x1A" or "0x1p3", exactly as the running R does.
  • Anything else fails. All failures are collected and reported together: non-numeric value(s): "n/a", "<0.1" (elements 2, 5), with 1-based element numbers and at most 10 values listed (the rest as "; and N more").

§no_na

#[miniextendr(no_na)] refuses everything this marker reads as missing, not only what R’s anyNA() sees: the R guard refuses NA (and a numeric NaN) before the call, and the C wrapper checks the converted value after it, refusing None (the token "NA", blank strings, factor labels among those) and NaN (from the text "NaN" too). Both raise the same 'x' must not contain NA argument error. NULL given to an Option<AsNumericVec> is still None, as not given. A type alias or a #[derive(TryFromSexp)] newtype of the marker is checked the same way.

Option<AsNumericVec> (and Option<AsNumeric>) also accept NULL as None.

§IntoR

The markers convert to R as their inner Vec<Option<f64>> / Option<f64>: a double vector with NA for None, which the marker reads back unchanged (NaN stays Some(NaN), though a NaN carrying R’s NA payload reads back as None, as R_IsNA says), and Option<marker> gives NULL for None. That is what lets a #[miniextendr] trait method take a marker parameter: the trait’s View converts each argument with IntoR and the implementing side reads it back with TryFromSexp. A #[miniextendr] function returning a marker gives the same R value as returning .0; returning .0 stays the idiom.

§Example

ⓘ
use miniextendr_api::{miniextendr, AsNumericVec};

#[miniextendr]
fn total(x: AsNumericVec) -> f64 {
    x.0.into_iter().flatten().sum()
}
// R: total(c(" 1.5 ", "NA", "", "0x10")) → 17.5
//    total(factor(c("10", "2")))         → 12  (labels, not codes)
//    total(c("1", "n/a", "3", "4", "<0.1"))
//    → error: non-numeric value(s): "n/a", "<0.1" (elements 2, 5)

Tuple Fields§

§0: Vec<Option<f64>>

Trait Implementations§

Source§

impl Clone for AsNumericVec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AsNumericVec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AsNumericVec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl IntoR for AsNumericVec

Source§

type Error = <Vec<Option<f64>> as IntoR>::Error

The error type for fallible conversions. Read more
Source§

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

Try to convert this value to an R SEXP. Read more
Source§

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

Try to convert to SEXP without thread safety checks. Read more
Source§

fn into_sexp(self) -> SEXP

Convert this value to an R SEXP, panicking on error. Read more
Source§

unsafe fn into_sexp_unchecked(self) -> SEXP

Convert to SEXP without thread safety checks, panicking on error. Read more
Source§

impl PartialEq for AsNumericVec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AsNumericVec

Source§

impl TryFromSexp for AsNumericVec

Source§

type Error = SexpError

The error type returned when conversion fails.
Source§

fn __mx_has_na(&self) -> bool

Whether the converted argument holds a value #[miniextendr(no_na)] refuses after the conversion. Read more
Source§

fn try_from_sexp(sexp: SEXP) -> Result<Self, Self::Error>

Attempt to convert an R SEXP to this Rust type. Read more
Source§

const NATIVE_BORROW: Option<NativeBorrow> = None

Native vector storage retained by this conversion, if any. Read more
Source§

const CHARACTER_ONLY: bool = false

Whether this conversion accepts only character input: every value it converts, other than NULL, is a character vector or a factor. Read more
Source§

#[doc(hidden)]
const __MX_EXPECTATION: Option<&'static str> = None

What an argument of this type must be, in R terms, when #[miniextendr] cannot tell from the type as written: the <expected> of a failed conversion’s '<p>' must be <expected>: .... Read more
Source§

unsafe fn try_from_sexp_unchecked(sexp: SEXP) -> Result<Self, Self::Error>

Convert from SEXP without thread safety checks. Read more
Source§

#[doc(hidden)]
unsafe fn __mx_try_from_rooted(root: Root<'_>) -> Result<Self, Self::Error>

Convert with a scope able to retain uncached ALTREP elements. Custom reference converters keep their existing behavior by default. Read more
Source§

#[doc(hidden)]
fn __mx_input_has_na(&self, input: SEXP) -> bool

Whether #[miniextendr(no_na)] refuses this converted argument, read from input (the R value it converted from), when no R guard ran. Read more
Source§

#[doc(hidden)]
fn __mx_try_from_sexp_with_check( sexp: SEXP, check: &ElementCheck<'_>, ) -> Result<Self, SexpError>
where Self::Error: Into<SexpError>,

Convert, running check, an element type’s TryFromSexpElement::check_sexp, on the R value that carries an element’s class (#1837). Read more
Source§

#[doc(hidden)]
unsafe fn __mx_try_from_sexp_unchecked_with_check( sexp: SEXP, check: &ElementCheck<'_>, ) -> Result<Self, SexpError>
where Self::Error: Into<SexpError>,

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ConsumingFallible for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<I> OptionInner for I

Source§

const OPTION_NATIVE_BORROW: Option<NativeBorrow> = const OPTION_NATIVE_BORROW: Option<NativeBorrow> = <Option<I> as TryFromSexp>::NATIVE_BORROW;

<Option<Self> as TryFromSexp>::NATIVE_BORROW.
Source§

const OPTION_CHARACTER_ONLY: bool = const OPTION_CHARACTER_ONLY: bool = <Option<I> as TryFromSexp>::CHARACTER_ONLY;

<Option<Self> as TryFromSexp>::CHARACTER_ONLY.
Source§

fn option_try_from_sexp(sexp: SEXP) -> Result<Option<I>, SexpError>

<Option<Self> as TryFromSexp>::try_from_sexp, its error as a SexpError.
Source§

unsafe fn option_try_from_sexp_unchecked( sexp: SEXP, ) -> Result<Option<I>, SexpError>

<Option<Self> as TryFromSexp>::try_from_sexp_unchecked, its error as a SexpError. Read more
Source§

impl<T> RClone for T
where T: Clone,

Source§

fn r_clone(&self) -> T

Create a deep copy of this value.
Source§

#[doc(hidden)]
unsafe extern "C" fn __RClone_r_clone_shim( data: *mut c_void, argc: i32, argv: *const SEXP, ) -> SEXP
where Self: Sized + RClone + IntoR,

Method shim for RClone::r_clone. Read more
Source§

impl<T> RDebug for T
where T: Debug,

Source§

fn debug_str(&self) -> String

Get a compact debug string representation.
Source§

fn debug_str_pretty(&self) -> String

Get a pretty-printed debug string with indentation.
Source§

#[doc(hidden)]
unsafe extern "C" fn __RDebug_debug_str_shim( data: *mut c_void, argc: i32, argv: *const SEXP, ) -> SEXP
where Self: Sized + RDebug,

Method shim for RDebug::debug_str. Read more
Source§

#[doc(hidden)]
unsafe extern "C" fn __RDebug_debug_str_pretty_shim( data: *mut c_void, argc: i32, argv: *const SEXP, ) -> SEXP
where Self: Sized + RDebug,

Method shim for RDebug::debug_str_pretty. Read more
Source§

impl<T> RDefault for T
where T: Default,

Source§

fn r_default() -> T

Create a new instance with default values.
Source§

impl<T> SizeHint for T
where T: ?Sized,

Source§

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)
Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more
Source§

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more
Source§

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an estimate for the number of elements this container like type contains. Read more
Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes