Struct IterationCount 

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

A strictly positive iteration count.

Wraps a NonZeroU32 to guarantee that iteration-count parameters (like max_iter) are always at least 1. This prevents no-ops that finish without an error from passing zero iterations to algorithm functions.

Construction

use cugraph::params::IterationCount;

// From a runtime value (fallible):
let count = IterationCount::new(500).unwrap();
assert_eq!(count.get(), 500);

// TryFrom conversions:
let count: IterationCount = 100u32.try_into().unwrap();
let count: IterationCount = 100i32.try_into().unwrap();
let count: IterationCount = 100usize.try_into().unwrap();

Implementations

impl IterationCount

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

Create a new IterationCount from a u32.

Errors

Returns ErrorKind::InvalidInput if value is zero.

pub const fn from_non_zero(value: NonZeroU32) -> Self

Create a new IterationCount from a NonZeroU32 (infallible).

pub const fn get(self) -> u32

Get the underlying value as a u32.

pub const fn into_inner(self) -> NonZeroU32

Get the underlying NonZeroU32.

Trait Implementations

impl Clone for IterationCount

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 IterationCount

impl Debug for IterationCount

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

Formats the value using the given formatter.

impl Display for IterationCount

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

Formats the value using the given formatter.

impl Eq for IterationCount

impl From<IterationCount> for u32

fn from(count: IterationCount) -> u32

Converts to this type from the input type.

impl From<IterationCount> for usize

fn from(count: IterationCount) -> usize

Converts to this type from the input type.

impl Hash for IterationCount

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IterationCount

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for IterationCount

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for IterationCount

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 IterationCount

impl TryFrom<IterationCount> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(count: IterationCount) -> Result<i32>

Performs the conversion.

impl TryFrom<i32> for IterationCount

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u32> for IterationCount

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<usize> for IterationCount

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.