Struct Hyperellipsoid 

pub struct Hyperellipsoid<const N: usize> { /* private fields */ }

The geometry resulting from an Hypersphere that is scaled along the Cartesian axes.

See Ellipse and Ellipsoid for special cases in 2 and 3 dimensions.

Examples

Basic construction and methods:

use approxim::assert_relative_eq;
use hoomd_geometry::{BoundingSphereRadius, Volume, shape::Hyperellipsoid};
use std::f64::consts::PI;

let ellipse =
    Hyperellipsoid::with_semi_axes([1.0.try_into()?, 2.0.try_into()?]);
let bounding_radius = ellipse.bounding_sphere_radius();
let volume = ellipse.volume();

assert_eq!(bounding_radius.get(), 2.0);
assert_relative_eq!(volume, PI * 1.0 * 2.0);

let sphere = Hyperellipsoid::with_semi_axes([
    2.0.try_into()?,
    2.0.try_into()?,
    2.0.try_into()?,
]);
let bounding_radius = sphere.bounding_sphere_radius();
let volume = sphere.volume();

assert_eq!(bounding_radius.get(), 2.0);
assert_eq!(volume, 4.0 / 3.0 * PI * 2.0_f64.powi(3));

Implementations

impl<const N: usize> Hyperellipsoid<N>

pub fn with_semi_axes(semi_axes: [PositiveReal; N]) -> Self

Construct a new Hyperellipsoid with the given semi-axes along each Cartesian direction.

pub fn semi_axes(&self) -> &[PositiveReal; N]

Get the semi axes.

Trait Implementations

impl<const N: usize> BoundingSphereRadius for Hyperellipsoid<N>

fn bounding_sphere_radius(&self) -> PositiveReal

Get the bounding radius.

impl<const N: usize> Clone for Hyperellipsoid<N>

fn clone(&self) -> Hyperellipsoid<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Hyperellipsoid<N>

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

Formats the value using the given formatter.

impl<'de, const N: usize> Deserialize<'de> for Hyperellipsoid<N>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R> IntersectsAt<Hyperellipsoid<2>, Cartesian<2>, R> for Hyperellipsoid<2>

where R: Rotation + Rotate<Cartesian<2>>, Angle: From<R>, RotationMatrix<2>: From<R>,

fn intersects_at( &self, other: &Hyperellipsoid<2>, v_ij: &Cartesian<2>, o_ij: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the local frame).

fn approximate_separation_distance( &self, other: &S, v_ij: &V, o_ij: &R, resolution: PositiveReal, ) -> f64

where V: InnerProduct,

Approximate the amount of overlap between two shapes.

impl<R> IntersectsAtGlobal<Hyperellipsoid<2>, Cartesian<2>, R> for Hyperellipsoid<2>

where R: Rotation + Rotate<Cartesian<2>>, Angle: From<R>, RotationMatrix<2>: From<R>,

fn intersects_at_global( &self, other: &Hyperellipsoid<2>, r_self: &Cartesian<2>, o_self: &R, r_other: &Cartesian<2>, o_other: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the global frame).

impl<const N: usize> PartialEq for Hyperellipsoid<N>

fn eq(&self, other: &Hyperellipsoid<N>) -> 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<const N: usize> Serialize for Hyperellipsoid<N>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> SupportMapping<Cartesian<N>> for Hyperellipsoid<N>

fn support_mapping(&self, n: &Cartesian<N>) -> Cartesian<N>

Return the furthest extent of a shape in the direction of n.

impl<const N: usize> Volume for Hyperellipsoid<N>

fn volume(&self) -> f64

The N-hypervolume of a geometry.

impl<const N: usize> StructuralPartialEq for Hyperellipsoid<N>