Struct Eccentricity 

pub struct Eccentricity(f64);

Eccentricity with validation. For elliptical orbits: 0 <= e < 1 For parabolic: e == 1 For hyperbolic: e > 1

Tuple Fields

0: f64

Implementations

impl Eccentricity

pub fn new(e: f64) -> Option<Self>

Create a new eccentricity value. Returns None if negative.

pub fn elliptical(e: f64) -> Option<Self>

Create eccentricity for an elliptical orbit (0 <= e < 1). Returns None if out of range.

pub fn value(self) -> f64

pub fn is_circular(&self) -> bool

pub fn is_elliptical(&self) -> bool

pub fn is_parabolic(&self) -> bool

pub fn is_hyperbolic(&self) -> bool

Trait Implementations

impl Clone for Eccentricity

fn clone(&self) -> Eccentricity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Eccentricity

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

Formats the value using the given formatter.

impl Display for Eccentricity

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

Formats the value using the given formatter.

impl PartialEq for Eccentricity

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

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

impl StructuralPartialEq for Eccentricity