Struct pf16 

#[repr(transparent)]
pub struct pf16(pub f16);

A portable float16 type.

This type is a newtype wrapper around half::f16. We intend to replace it by Rust’s builtin f16 type once it is stabilized.

Tuple Fields

0: f16

Implementations

impl pf16

pub const NAN: Self

pub const INFINITY: Self

pub const NEG_INFINITY: Self

pub fn to_le_bytes(&self) -> [u8; 2]

pub fn is_nan(self) -> bool

pub fn is_finite(self) -> bool

pub fn abs(self) -> Self

pub fn trunc(self) -> Self

pub fn round(self) -> Self

pub fn floor(self) -> Self

pub fn ceil(self) -> Self

pub fn log(self, base: Self) -> Self

pub fn to_bits(self) -> u16

pub fn from_bits(b: u16) -> Self

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

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

Trait Implementations

impl AbsDiff for pf16

type Abs = pf16

fn max_abs_diff() -> Self::Abs

fn abs_diff(self, other: Self) -> Self::Abs

impl Add for pf16

type Output = pf16

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign for pf16

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AsPrimitive<f32> for pf16

fn as_(self) -> f32

Convert a value to another, using the as operator.

impl AsPrimitive<f64> for pf16

fn as_(self) -> f64

Convert a value to another, using the as operator.

impl AsPrimitive<i128> for pf16

fn as_(self) -> i128

Convert a value to another, using the as operator.

impl AsPrimitive<i16> for pf16

fn as_(self) -> i16

Convert a value to another, using the as operator.

impl AsPrimitive<i32> for pf16

fn as_(self) -> i32

Convert a value to another, using the as operator.

impl AsPrimitive<i64> for pf16

fn as_(self) -> i64

Convert a value to another, using the as operator.

impl AsPrimitive<i8> for pf16

fn as_(self) -> i8

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for f32

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for f64

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for i128

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for i16

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for i32

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for i64

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for i8

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for isize

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for pf16

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for u128

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for u16

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for u32

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for u64

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for u8

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<pf16> for usize

fn as_(self) -> pf16

Convert a value to another, using the as operator.

impl AsPrimitive<u128> for pf16

fn as_(self) -> u128

Convert a value to another, using the as operator.

impl AsPrimitive<u16> for pf16

fn as_(self) -> u16

Convert a value to another, using the as operator.

impl AsPrimitive<u32> for pf16

fn as_(self) -> u32

Convert a value to another, using the as operator.

impl AsPrimitive<u64> for pf16

fn as_(self) -> u64

Convert a value to another, using the as operator.

impl AsPrimitive<u8> for pf16

fn as_(self) -> u8

Convert a value to another, using the as operator.

impl Bounded for pf16

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

impl Clone for pf16

fn clone(&self) -> pf16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for pf16

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

Formats the value using the given formatter.

impl Default for pf16

fn default() -> pf16

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for pf16

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DirtyHash for pf16

fn dirty_hash(&self) -> u64

impl Display for pf16

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

Formats the value using the given formatter.

impl Div for pf16

type Output = pf16

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl DivAssign for pf16

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl Element for pf16

Available on crate feature python only.

const IS_COPY: bool = true

Flag that indicates whether this type is trivially copyable.

fn get_dtype(py: Python<'_>) -> Bound<'_, PyArrayDescr>

Returns the associated type descriptor (“dtype”) for the given element type.

fn clone_ref(&self, py: Python<'_>) -> Self

Create a clone of the value while the GIL is guaranteed to be held.

fn vec_from_slice(py: Python<'_>, slc: &[Self]) -> Vec<Self>

Create an owned copy of the slice while the GIL is guaranteed to be held.

fn array_from_view<D>( py: Python<'_>, view: ArrayBase<ViewRepr<&Self>, D>, ) -> ArrayBase<OwnedRepr<Self>, D>

where D: Dimension,

Create an owned copy of the array while the GIL is guaranteed to be held.

impl Float for pf16

fn nan() -> Self

Returns the NaN value.

fn infinity() -> Self

Returns the infinite value.

fn neg_infinity() -> Self

Returns the negative infinite value.

fn neg_zero() -> Self

Returns -0.0.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn abs(self) -> Self

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0, Float::infinity(), and Float::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0, Float::neg_infinity(), and -Float::nan().

fn mul_add(self, a: Self, b: Self) -> Self

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

fn recip(self) -> Self

Take the reciprocal (inverse) of a number, 1/x.

fn powi(self, n: i32) -> Self

Raise a number to an integer power.

fn powf(self, n: Self) -> Self

Raise a number to a floating point power.

fn sqrt(self) -> Self

Take the square root of a number.

fn exp(self) -> Self

Returns e^(self), (the exponential function).

fn exp2(self) -> Self

Returns 2^(self).

fn ln(self) -> Self

Returns the natural logarithm of the number.

fn log(self, base: Self) -> Self

Returns the logarithm of the number with respect to an arbitrary base.

fn log2(self) -> Self

Returns the base 2 logarithm of the number.

fn log10(self) -> Self

Returns the base 10 logarithm of the number.

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

Returns the maximum of the two numbers.

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

Returns the minimum of the two numbers.

fn abs_sub(self, other: Self) -> Self

The positive difference of two numbers.

fn cbrt(self) -> Self

Take the cubic root of a number.

fn hypot(self, other: Self) -> Self

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

fn sin(self) -> Self

Computes the sine of a number (in radians).

fn cos(self) -> Self

Computes the cosine of a number (in radians).

fn tan(self) -> Self

Computes the tangent of a number (in radians).

fn asin(self) -> Self

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

fn acos(self) -> Self

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

fn atan(self) -> Self

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

fn atan2(self, other: Self) -> Self

Computes the four quadrant arctangent of self (y) and other (x).

fn sin_cos(self) -> (Self, Self)

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

fn exp_m1(self) -> Self

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

fn ln_1p(self) -> Self

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

fn sinh(self) -> Self

Hyperbolic sine function.

fn cosh(self) -> Self

Hyperbolic cosine function.

fn tanh(self) -> Self

Hyperbolic tangent function.

fn asinh(self) -> Self

Inverse hyperbolic sine function.

fn acosh(self) -> Self

Inverse hyperbolic cosine function.

fn atanh(self) -> Self

Inverse hyperbolic tangent function.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn epsilon() -> Self

Returns epsilon, a small positive value.

fn to_degrees(self) -> Self

Converts radians to degrees.

fn to_radians(self) -> Self

Converts degrees to radians.

fn is_subnormal(self) -> bool

Returns true if the number is subnormal.

fn clamp(self, min: Self, max: Self) -> Self

Clamps a value between a min and max.

fn copysign(self, sign: Self) -> Self

Returns a number composed of the magnitude of self and the sign of sign.

impl FloorDivMod for pf16

fn wrapping_floor_div_mod(self, other: Self) -> (Self, Self)

impl From<bool> for pf16

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for pf16

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for pf16

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<pf16> for f32

fn from(value: pf16) -> Self

Converts to this type from the input type.

impl From<pf16> for f64

fn from(value: pf16) -> Self

Converts to this type from the input type.

impl FromBytes for pf16

type Bytes = [u8; 2]

fn from_be_bytes(bytes: &Self::Bytes) -> Self

Create a number from its representation as a byte array in big endian.

fn from_le_bytes(bytes: &Self::Bytes) -> Self

Create a number from its representation as a byte array in little endian.

fn from_ne_bytes(bytes: &Self::Bytes) -> Self

Create a number from its memory representation as a byte array in native endianness.

impl FromPrimitive for pf16

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<'py> FromPyObject<'py> for pf16

Available on crate feature python only.

fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for pf16

Available on crate feature python only.

type Target = PyFloat

The Python output type

type Output = Bound<'py, <pf16 as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = Infallible

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error>

Performs the conversion.

impl IsFloat for pf16

fn is_float() -> bool

fn is_f16() -> bool

fn is_f32() -> bool

fn is_f64() -> bool

fn nan_value() -> Self

fn pos_inf_value() -> Self

fn neg_inf_value() -> Self

fn is_nan(&self) -> bool

fn is_finite(&self) -> bool

impl IsNull for pf16

const HAS_NULLS: bool = false

type Inner = pf16

fn is_null(&self) -> bool

fn unwrap_inner(self) -> Self::Inner

impl JsonSchema for pf16

Available on crate feature dsl-schema only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn always_inline_schema() -> bool

👎Deprecated: Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl LowerExp for pf16

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

Formats the value using the given formatter.

impl MinMax for pf16

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

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

fn min_ignore_nan(self, other: Self) -> Self

fn max_ignore_nan(self, other: Self) -> Self

fn min_propagate_nan(self, other: Self) -> Self

fn max_propagate_nan(self, other: Self) -> Self

impl Mul for pf16

type Output = pf16

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl MulAssign for pf16

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for pf16

type Output = pf16

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Num for pf16

type FromStrRadixErr = <f16 as Num>::FromStrRadixErr

fn from_str_radix(s: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl NumCast for pf16

fn from<T: ToPrimitive>(n: T) -> Option<Self>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl One for pf16

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl PartialEq for pf16

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for pf16

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Pow<pf16> for pf16

type Output = pf16

The result after applying the operator.

fn pow(self, rhs: pf16) -> Self::Output

Returns self to the power rhs.

impl Rem for pf16

type Output = pf16

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self

Performs the % operation.

impl RemAssign for pf16

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl Serialize for pf16

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for pf16

type Output = pf16

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign for pf16

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Sum for pf16

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

Takes an iterator and generates Self from the elements by “summing up” the items.

impl ToBytes for pf16

type Bytes = [u8; 2]

fn to_be_bytes(&self) -> Self::Bytes

Return the memory representation of this number as a byte array in big-endian byte order.

fn to_le_bytes(&self) -> Self::Bytes

Return the memory representation of this number as a byte array in little-endian byte order.

fn to_ne_bytes(&self) -> Self::Bytes

Return the memory representation of this number as a byte array in native byte order.

impl ToPrimitive for pf16

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl ToTotalOrd for pf16

type TotalOrdItem = TotalOrdWrap<pf16>

type SourceItem = pf16

fn to_total_ord(&self) -> Self::TotalOrdItem

fn peel_total_ord(ord_item: Self::TotalOrdItem) -> Self::SourceItem

impl TotalEq for pf16

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

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

impl TotalHash for pf16

fn tot_hash<H>(&self, state: &mut H)

where H: Hasher,

fn tot_hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

impl TotalOrd for pf16

fn tot_cmp(&self, other: &Self) -> Ordering

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

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

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

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

impl Zero for pf16

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zeroable for pf16

fn zeroed() -> Self

Calls zeroed.

impl Copy for pf16

impl Pod for pf16

impl StructuralPartialEq for pf16