Struct UnitF64 

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

A finite f64 value in the open interval (0.0, 1.0).

Used for parameters that represent fractions or probabilities, such as the PageRank damping factor (alpha) and Barnes-Hut trade-off (theta).

Construction

use cugraph::params::UnitF64;

let alpha = UnitF64::new(0.85).unwrap();
assert_eq!(alpha.get(), 0.85);

// Boundary values are rejected (open interval):
assert!(UnitF64::new(0.0).is_err());
assert!(UnitF64::new(1.0).is_err());

Implementations

impl UnitF64

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

Create a new UnitF64 from an f64.

Errors

Returns ErrorKind::InvalidInput if value is not in the open 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 UnitF64

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 UnitF64

impl Debug for UnitF64

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

Formats the value using the given formatter.

impl Display for UnitF64

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

Formats the value using the given formatter.

impl From<UnitF64> for f64

fn from(val: UnitF64) -> f64

Converts to this type from the input type.

impl PartialEq for UnitF64

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for UnitF64

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 UnitF64

impl TryFrom<f64> for UnitF64

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.