Struct Maximum 

pub struct Maximum<T> {
    pub value: T,
    pub vertex: VertexId,
}

The maximum of a per-vertex measure and the vertex attaining it, the Rust counterpart of the C pair igraph_vector_max() / igraph_vector_which_max().

Fields

value: T

The largest value.

vertex: VertexId

The (first) vertex attaining it.

Implementations

impl<T: PartialOrd + Copy> Maximum<T>

pub fn of(values: &[T]) -> Option<Self>

The largest element of values (indexed by vertex id) and its index, or None for an empty slice.

It behaves exactly like igraph’s igraph_vector_max() and igraph_vector_which_max(): the first maximal element wins ties, and if values contains a NaN (for floating-point types: any element not comparable with itself), the first NaN and its index are returned.

Examples

use igraph::tutorial::Maximum;
assert_eq!(Maximum::of(&[3, 7, 1, 7]), Some(Maximum { value: 7, vertex: 1 }));
assert_eq!(Maximum::<f64>::of(&[]), None);
// As in igraph, a NaN is the "maximum" of any vector containing one.
let m = Maximum::of(&[1.0, f64::NAN, 2.0]).unwrap();
assert!(m.value.is_nan() && m.vertex == 1);

Trait Implementations

impl<T: Clone> Clone for Maximum<T>

fn clone(&self) -> Maximum<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy> Copy for Maximum<T>

impl<T: Debug> Debug for Maximum<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Maximum<T>

fn eq(&self, other: &Maximum<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialEq> StructuralPartialEq for Maximum<T>