Struct f16 

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

A half-precision (16-bit) floating point number.

This type represents IEEE 754 half-precision binary floating-point format. It provides conversion methods to and from f32, and the underlying u16 representation is publicly accessible for direct bit manipulation.

Examples

use simsimd::f16;

// Create from f32
let half = f16::from_f32(3.14);

// Convert back to f32
let float = half.to_f32();

// Direct access to bits
let bits = half.0;

Tuple Fields

0: u16

Implementations

impl f16

pub const ZERO: Self

Positive zero.

pub const ONE: Self

Positive one.

pub const NEG_ONE: Self

Negative one.

pub fn from_f32(value: f32) -> Self

Converts an f32 to f16 representation.

Examples

use simsimd::f16;
let half = f16::from_f32(3.14159);

pub fn to_f32(self) -> f32

Converts the f16 to an f32.

Examples

use simsimd::f16;
let half = f16::from_f32(3.14159);
let float = half.to_f32();

pub fn is_nan(self) -> bool

Returns true if this value is NaN.

pub fn is_infinite(self) -> bool

Returns true if this value is positive or negative infinity.

pub fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

pub fn abs(self) -> Self

Returns the absolute value of self.

Trait Implementations

impl Add for f16

type Output = f16

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for f16

fn clone(&self) -> f16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComplexProducts for f16

fn dot(a: &[Self], b: &[Self]) -> Option<ComplexProduct>

Computes the dot product between two complex number vectors.

fn vdot(a: &[Self], b: &[Self]) -> Option<ComplexProduct>

Computes the Hermitian dot product (conjugate dot product) between two complex number vectors.

impl Debug for f16

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

Formats the value using the given formatter.

impl Div for f16

type Output = f16

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul for f16

type Output = f16

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for f16

type Output = f16

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for f16

fn eq(&self, other: &f16) -> 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 f16

fn partial_cmp(&self, other: &Self) -> 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 ProbabilitySimilarity for f16

fn jensenshannon(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the Jensen-Shannon divergence between two probability distributions. The Jensen-Shannon divergence is a method of measuring the similarity between two probability distributions. It is based on the Kullback-Leibler divergence, but is symmetric and always has a finite value.

fn kullbackleibler(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the Kullback-Leibler divergence between two probability distributions. The Kullback-Leibler divergence is a measure of how one probability distribution diverges from a second, expected probability distribution.

impl SpatialSimilarity for f16

fn cos(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the cosine distance between two slices. The cosine distance is 1 minus the cosine similarity between two non-zero vectors of an dot product space that measures the cosine of the angle between them.

fn dot(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the inner product (also known as dot product) between two slices. The dot product is the sum of the products of the corresponding entries of the two sequences of numbers.

fn l2sq(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the squared Euclidean distance between two slices. The squared Euclidean distance is the sum of the squared differences between corresponding elements of the two slices.

fn l2(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the Euclidean distance between two slices. The Euclidean distance is the square root of elements of the two slices.

fn sqeuclidean(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the squared Euclidean distance between two slices. The squared Euclidean distance is the sum of the squared differences between corresponding elements of the two slices.

fn euclidean(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the Euclidean distance between two slices. The Euclidean distance is the square root of the sum of the squared differences between corresponding elements of the two slices.

fn inner(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the squared Euclidean distance between two slices. The squared Euclidean distance is the sum of the squared differences between corresponding elements of the two slices.

fn cosine(a: &[Self], b: &[Self]) -> Option<Distance>

Computes the cosine distance between two slices. The cosine distance is 1 minus the cosine similarity between two non-zero vectors of an dot product space that measures the cosine of the angle between them.

impl Sub for f16

type Output = f16

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for f16

impl Eq for f16

impl StructuralPartialEq for f16