Struct FractionF64 

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

A finite f64 value in the half-open interval (0.0, 1.0].

Used for parameters libcugraph requires to be positive and at most one, such as the ECG convergence threshold and resolution.

Construction

use cugraph::params::FractionF64;

assert_eq!(FractionF64::new(1.0).unwrap().get(), 1.0);

// Zero and values above one are rejected:
assert!(FractionF64::new(0.0).is_err());
assert!(FractionF64::new(1.5).is_err());

Implementations

impl FractionF64

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

Create a new FractionF64 from an f64.

Errors

Returns ErrorKind::InvalidInput if value is not in the interval (0.0, 1.0] or is not finite.

pub const fn get(self) -> f64

Get the underlying f64 value.

Trait Implementations

impl Clone for FractionF64

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 FractionF64

impl Debug for FractionF64

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

Formats the value using the given formatter.

impl Display for FractionF64

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

Formats the value using the given formatter.

impl From<FractionF64> for f64

fn from(val: FractionF64) -> f64

Converts to this type from the input type.

impl PartialEq for FractionF64

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FractionF64

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 FractionF64

impl TryFrom<f64> for FractionF64

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.