Struct DiversityIndex 

pub struct DiversityIndex { /* private fields */ }

Implementations

impl DiversityIndex

pub fn new( kind: DiversityIndexKind, value: f64, ) -> Result<Self, BiodiversityValueError>

Errors

Returns BiodiversityValueError::NonFinite when value is not finite.

pub const fn kind(&self) -> &DiversityIndexKind

pub const fn value(&self) -> f64

Trait Implementations

impl Clone for DiversityIndex

fn clone(&self) -> DiversityIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiversityIndex

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

Formats the value using the given formatter.

impl Display for DiversityIndex

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

Formats the value using the given formatter.

impl PartialEq for DiversityIndex

fn eq(&self, other: &DiversityIndex) -> 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 PartialOrd for DiversityIndex

fn partial_cmp(&self, other: &DiversityIndex) -> 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 DiversityIndex