Trait ndarray_stats::MaybeNan

pub trait MaybeNan: Sized {
    type NotNan;
    pub fn is_nan(&self) -> bool;
    pub fn try_as_not_nan(&self) -> Option<&Self::NotNan>;
    pub fn from_not_nan(_: Self::NotNan) -> Self;
    pub fn from_not_nan_opt(_: Option<Self::NotNan>) -> Self;
    pub fn from_not_nan_ref_opt(_: Option<&Self::NotNan>) -> &Self;
    pub fn remove_nan_mut(
        _: ArrayViewMut1<'_, Self>
    ) -> ArrayViewMut1<'_, Self::NotNan>;
}

A number type that can have not-a-number values.

Associated Types

type NotNan

A type that is guaranteed not to be a NaN value.

Loading content...

Required methods

pub fn is_nan(&self) -> bool

Returns true if the value is a NaN value.

pub fn try_as_not_nan(&self) -> Option<&Self::NotNan>

Tries to convert the value to NotNan.

Returns None if the value is a NaN value.

pub fn from_not_nan(_: Self::NotNan) -> Self

Converts the value.

If the value is None, a NaN value is returned.

pub fn from_not_nan_opt(_: Option<Self::NotNan>) -> Self

Converts the value.

If the value is None, a NaN value is returned.

pub fn from_not_nan_ref_opt(_: Option<&Self::NotNan>) -> &Self

Converts the value.

If the value is None, a NaN value is returned.

pub fn remove_nan_mut(
    _: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

Returns a view with the NaN values removed.

This modifies the input view by moving elements as necessary. The final order of the elements is unspecified. However, this method is idempotent, and given the same input data, the result is always ordered the same way.

Loading content...

Implementations on Foreign Types

impl MaybeNan for f32

type NotNan = N32

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&N32>

pub fn from_not_nan(value: N32) -> f32

pub fn from_not_nan_opt(value: Option<N32>) -> f32

pub fn from_not_nan_ref_opt(value: Option<&N32>) -> &f32

pub fn remove_nan_mut(view: ArrayViewMut1<'_, f32>) -> ArrayViewMut1<'_, N32>

impl MaybeNan for f64

type NotNan = N64

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&N64>

pub fn from_not_nan(value: N64) -> f64

pub fn from_not_nan_opt(value: Option<N64>) -> f64

pub fn from_not_nan_ref_opt(value: Option<&N64>) -> &f64

pub fn remove_nan_mut(view: ArrayViewMut1<'_, f64>) -> ArrayViewMut1<'_, N64>

impl MaybeNan for Option<u8>

type NotNan = NotNone<u8>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<u8>>

pub fn from_not_nan(value: NotNone<u8>) -> Option<u8>

pub fn from_not_nan_opt(value: Option<NotNone<u8>>) -> Option<u8>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<u8>>) -> &Option<u8>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<u16>

type NotNan = NotNone<u16>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<u16>>

pub fn from_not_nan(value: NotNone<u16>) -> Option<u16>

pub fn from_not_nan_opt(value: Option<NotNone<u16>>) -> Option<u16>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<u16>>) -> &Option<u16>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<u32>

type NotNan = NotNone<u32>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<u32>>

pub fn from_not_nan(value: NotNone<u32>) -> Option<u32>

pub fn from_not_nan_opt(value: Option<NotNone<u32>>) -> Option<u32>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<u32>>) -> &Option<u32>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<u64>

type NotNan = NotNone<u64>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<u64>>

pub fn from_not_nan(value: NotNone<u64>) -> Option<u64>

pub fn from_not_nan_opt(value: Option<NotNone<u64>>) -> Option<u64>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<u64>>) -> &Option<u64>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<u128>

type NotNan = NotNone<u128>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<u128>>

pub fn from_not_nan(value: NotNone<u128>) -> Option<u128>

pub fn from_not_nan_opt(value: Option<NotNone<u128>>) -> Option<u128>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<u128>>) -> &Option<u128>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<i8>

type NotNan = NotNone<i8>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<i8>>

pub fn from_not_nan(value: NotNone<i8>) -> Option<i8>

pub fn from_not_nan_opt(value: Option<NotNone<i8>>) -> Option<i8>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<i8>>) -> &Option<i8>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<i16>

type NotNan = NotNone<i16>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<i16>>

pub fn from_not_nan(value: NotNone<i16>) -> Option<i16>

pub fn from_not_nan_opt(value: Option<NotNone<i16>>) -> Option<i16>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<i16>>) -> &Option<i16>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<i32>

type NotNan = NotNone<i32>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<i32>>

pub fn from_not_nan(value: NotNone<i32>) -> Option<i32>

pub fn from_not_nan_opt(value: Option<NotNone<i32>>) -> Option<i32>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<i32>>) -> &Option<i32>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<i64>

type NotNan = NotNone<i64>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<i64>>

pub fn from_not_nan(value: NotNone<i64>) -> Option<i64>

pub fn from_not_nan_opt(value: Option<NotNone<i64>>) -> Option<i64>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<i64>>) -> &Option<i64>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<i128>

type NotNan = NotNone<i128>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<i128>>

pub fn from_not_nan(value: NotNone<i128>) -> Option<i128>

pub fn from_not_nan_opt(value: Option<NotNone<i128>>) -> Option<i128>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<i128>>) -> &Option<i128>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<N32>

type NotNan = NotNone<N32>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<N32>>

pub fn from_not_nan(value: NotNone<N32>) -> Option<N32>

pub fn from_not_nan_opt(value: Option<NotNone<N32>>) -> Option<N32>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<N32>>) -> &Option<N32>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

impl MaybeNan for Option<N64>

type NotNan = NotNone<N64>

pub fn is_nan(&self) -> bool

pub fn try_as_not_nan(&self) -> Option<&NotNone<N64>>

pub fn from_not_nan(value: NotNone<N64>) -> Option<N64>

pub fn from_not_nan_opt(value: Option<NotNone<N64>>) -> Option<N64>

pub fn from_not_nan_ref_opt(value: Option<&NotNone<N64>>) -> &Option<N64>

pub fn remove_nan_mut(
    view: ArrayViewMut1<'_, Self>
) -> ArrayViewMut1<'_, Self::NotNan>

Loading content...

Implementors

Loading content...