Skip to main content

Hyperbola

ogeom_math::conic

Struct Hyperbola 

Source 
pub struct Hyperbola { /* private fields */ }
Expand description

A hyperbola in space.

Only the branch on the positive x side of its frame is described; the other branch is the same hyperbola with the frame’s x reversed.

Implementations§

Source§

impl Hyperbola

Source

pub fn new( frame: Frame, major_radius: f64, minor_radius: f64, tol: Tolerances, ) -> OgeomResult<Self>

A hyperbola with the given radii in the xy plane of frame.

§Errors

OgeomError::Construction if either radius is not finite and positive. Unlike an ellipse, the minor radius may exceed the major.

Source

pub const fn frame(&self) -> Frame

The frame positioning this hyperbola.

Source

pub const fn centre(&self) -> Point

The centre: the midpoint of the two vertices, not a point on the curve.

Source

pub const fn major_radius(&self) -> f64

The major radius: centre to vertex.

Source

pub const fn minor_radius(&self) -> f64

The minor radius, governing how fast the branches open.

Source

pub fn focal_distance(&self) -> f64

The distance from the centre to either focus.

Source

pub fn eccentricity(&self) -> f64

The eccentricity, always greater than 1.

Source

pub fn foci(&self) -> (Point, Point)

The two foci.

Source

pub fn vertex(&self) -> Point

The vertex of the described branch.

Source

pub fn transformed(&self, t: &Transform, tol: Tolerances) -> OgeomResult<Self>

This hyperbola moved by t.

§Errors

OgeomError::Construction if the transformed frame is degenerate.

Trait Implementations§

Source§

impl Clone for Hyperbola

Source§

fn clone(&self) -> Hyperbola

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Hyperbola

Source§

impl Debug for Hyperbola

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Hyperbola

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Hyperbola

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.