Struct BfsDepthLimit 

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

A BFS depth limit: the number of hops to expand from the sources.

0 expands no hops and reaches only the sources. Use None at the API boundary to request unlimited traversal. A limit larger than the graph’s vertex type can index behaves as unlimited.

Construction

use cugraph::params::BfsDepthLimit;

let limit = BfsDepthLimit::new(3);
assert_eq!(limit.get(), 3);

assert_eq!(BfsDepthLimit::new(0).get(), 0);
assert!(BfsDepthLimit::try_from(-1i32).is_err());

Implementations

impl BfsDepthLimit

pub const fn new(value: usize) -> Self

Create a new BfsDepthLimit from a usize.

pub const fn get(self) -> usize

Get the underlying value as usize.

Trait Implementations

impl Clone for BfsDepthLimit

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 BfsDepthLimit

impl Debug for BfsDepthLimit

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

Formats the value using the given formatter.

impl Display for BfsDepthLimit

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

Formats the value using the given formatter.

impl Eq for BfsDepthLimit

impl From<BfsDepthLimit> for usize

fn from(limit: BfsDepthLimit) -> usize

Converts to this type from the input type.

impl From<u32> for BfsDepthLimit

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<usize> for BfsDepthLimit

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for BfsDepthLimit

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 BfsDepthLimit

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 BfsDepthLimit

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BfsDepthLimit

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 BfsDepthLimit

impl TryFrom<i32> for BfsDepthLimit

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.