lodestone_core 0.2.3

User friendly magnetic field calculations in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

/* This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at https://mozilla.org/MPL/2.0/.
Copyright 2021 Peter Dunne */
//! Generic traits for all point objects i.e. Points (2D, 3D, cartesian, polar,
//! cylindrical, spherical), structs of
//! heap allocated vectors, stack allocated arrays
//!
//! Note that struct of arrays is implemented but unused
//!

// mod point_array2;
mod point_vec2;
mod points2;
mod points3;
mod polarpoints;
mod rotation_2d;

// make subroutines available from this module
// pub use point_array2::*;
pub use point_vec2::*;
pub use points2::*;
pub use points3::*;
pub use polarpoints::*;

/// General traits for all point types, including operation overloading
pub trait Points {
    /// Output type, usually set to Self
    type Output;
    /// Implelments addition
    fn add_p(&self, other: &Self) -> Self::Output;
    /// Implelments subtraction
    fn sub_p(&self, other: &Self) -> Self::Output;
    /// Implelments multiplication
    fn mul_p(&self, other: &Self) -> Self::Output;
    /// Implelments division
    fn div_p(&self, other: &Self) -> Self::Output;
    /// Implelments negation
    fn neg_p(&self) -> Self::Output;
    /// Implelments scaling by a float
    fn scale(&self, s: f64) -> Self::Output;
    /// Implelments round of all internal elements
    fn round(&self) -> Self::Output;
}

/// Calculates the norm of an x,y pair
pub fn internal_norm(x: &f64, y: &f64) -> (f64, f64) {
    let xy_mag = (x.powi(2) + y.powi(2)).sqrt();
    (x / xy_mag, y / xy_mag)
}