Struct NonNegativeF64 

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

A non-negative, finite f64 value (i.e., >= 0.0).

Used for parameters that may be zero but not negative, such as edge_weight_influence (where 0.0 means “no influence”).

Construction

use cugraph::params::NonNegativeF64;

let influence = NonNegativeF64::new(0.0).unwrap();
assert_eq!(influence.get(), 0.0);

let influence = NonNegativeF64::new(1.5).unwrap();
assert_eq!(influence.get(), 1.5);

// Negative values are rejected:
assert!(NonNegativeF64::new(-0.1).is_err());

Implementations

impl NonNegativeF64

pub fn new(value: f64) -> Result<Self>

Create a new NonNegativeF64 from an f64.

Errors

Returns ErrorKind::InvalidInput if value is negative, NaN, or infinite.

pub const fn get(self) -> f64

Get the underlying f64 value.

Trait Implementations

impl Clone for NonNegativeF64

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NonNegativeF64

impl Debug for NonNegativeF64

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

Formats the value using the given formatter.

impl Display for NonNegativeF64

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

Formats the value using the given formatter.

impl From<NonNegativeF64> for f64

fn from(val: NonNegativeF64) -> f64

Converts to this type from the input type.

impl PartialEq for NonNegativeF64

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NonNegativeF64

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 StructuralPartialEq for NonNegativeF64

impl TryFrom<f64> for NonNegativeF64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self>

Performs the conversion.