Struct PositiveF64 

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

A strictly positive, finite f64 value.

Used for parameters that must be greater than zero, such as scaling ratios.

Construction

use cugraph::params::PositiveF64;

let eps = PositiveF64::new(1e-5).unwrap();
assert_eq!(eps.get(), 1e-5);

// Zero and negative values are rejected:
assert!(PositiveF64::new(0.0).is_err());
assert!(PositiveF64::new(-1.0).is_err());

// Infinity and NaN are rejected:
assert!(PositiveF64::new(f64::INFINITY).is_err());
assert!(PositiveF64::new(f64::NAN).is_err());

Implementations

impl PositiveF64

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

Create a new PositiveF64 from an f64.

Errors

Returns ErrorKind::InvalidInput if value is not finite and positive (i.e., <= 0.0, NaN, or infinity).

pub const fn get(self) -> f64

Get the underlying f64 value.

Trait Implementations

impl Clone for PositiveF64

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 PositiveF64

impl Debug for PositiveF64

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

Formats the value using the given formatter.

impl Display for PositiveF64

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

Formats the value using the given formatter.

impl From<PositiveF64> for f64

fn from(val: PositiveF64) -> f64

Converts to this type from the input type.

impl PartialEq for PositiveF64

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PositiveF64

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 PositiveF64

impl TryFrom<f64> for PositiveF64

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.