Struct GeocentricUnit 

pub struct GeocentricUnit { /* private fields */ }

Unit vector from the Earth’s centre.

x towards 0°N 0°E, y towards 0°N 90°E, z towards the north pole. Direction only, no radius.

Components are private, finite and of unit length. As a bare [f64; 3] a caller could pass the zero vector, a vector in other axes, or metres, and the signature would not prevent it.

Example

use kinavis_kernel::{GeocentricUnit, Latitude, Longitude, Position};

let greenwich = Position::new(Latitude::from_degrees(0.0)?, Longitude::from_degrees(0.0)?);
let unit = greenwich.to_geocentric_unit();
assert!((unit.x() - 1.0).abs() < 1e-12);

// Round trips, and the length is normalised on the way in.
let doubled = GeocentricUnit::new(2.0, 0.0, 0.0)?;
assert_eq!(Position::from_geocentric_unit(doubled), greenwich);

// The zero vector points nowhere and is refused.
assert!(GeocentricUnit::new(0.0, 0.0, 0.0).is_err());

Implementations

impl GeocentricUnit

pub fn new(x: f64, y: f64, z: f64) -> Result<Self>

Normalises an Earth-centred vector; any positive multiple gives the same direction.

Errors

• KernelError::NotFinite for a NaN or infinite component.
• KernelError::Indeterminate for the zero vector or one too small to normalise meaningfully.

pub const fn x(self) -> f64

Component towards 0°N 0°E.

pub const fn y(self) -> f64

Component towards 0°N 90°E.

pub const fn z(self) -> f64

Component towards the north pole.

pub const fn components(self) -> [f64; 3]

Components [x, y, z].

pub fn dot(self, other: Self) -> f64

Cosine of the angle between two directions.

pub fn antipode(self) -> Self

Antipodal direction.

Trait Implementations

impl Clone for GeocentricUnit

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 GeocentricUnit

impl Debug for GeocentricUnit

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

Formats the value using the given formatter.

impl PartialEq for GeocentricUnit

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GeocentricUnit