Struct sphrs::Coordinates

pub struct Coordinates<T> { /* private fields */ }

Representation of coordinates.

Generic over floats. Can be created with cartesian (Cartesian coordinates) or spherical (spherical coordinates).

Implementations

impl<T> Coordinates<T>where T: SphrsFloat,

pub fn cartesian(x: T, y: T, z: T) -> Self

Create Coordinates struct from Cartesian coordinates

Example

let coords = Coordinates::cartesian(1.0f64, 0.5, 12.0);

pub fn spherical(r: T, theta: T, phi: T) -> Self

Create Coordinates struct from spherical coordinates

Example

let coords = Coordinates::spherical(1.0f64, 0.5, 0.9);

Trait Implementations

impl<T: Clone> Clone for Coordinates<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Coordinates<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Coordinates<T>

fn default() -> Coordinates<T>

Returns the “default value” for a type.

impl<T> SHCoordinates<T> for Coordinates<T>where T: SphrsFloat,

fn theta(&self) -> T

Return angle theta

fn phi(&self) -> T

Return angle phi

fn r(&self) -> T

Return radius r

fn x(&self) -> T

Return coordinate x

fn y(&self) -> T

Return coordinate y

fn z(&self) -> T

Return coordinate z

fn theta_cos(&self) -> T

Return cos(theta)