Struct RealInterval 

pub struct RealInterval {
    pub min: f32,
    pub max: f32,
}

Represents a closed range on the real numbers.

Fields

min: f32

The starting value of this range.

max: f32

The ending value of this range.

Implementations

impl RealInterval

pub fn min_max(min: f32, max: f32) -> Self

Creates a new interval from the given minimum and maximum. The maximum must be at least as big as the minimum, or this will panic.

pub fn point(value: f32) -> Self

Creates a range that contains a single point.

pub fn point_extents(value: f32, half_extent: f32) -> Self

Creates a range from a point and extents around the point.

pub fn contains(self, value: f32) -> bool

Determines whether the provided value lies within this interval.

pub fn abs(self) -> Self

Takes the absolute value of this range.

pub fn len(&self) -> f32

Provides the length of this interval.

pub fn min(self, rhs: Self) -> Self

Applies the minimum function between two ranges.

pub fn max(self, rhs: Self) -> Self

Applies the maximum function between two ranges.

pub fn minf(self, value: f32) -> Self

Applies a scalar minimum to this range.

pub fn maxf(self, value: f32) -> Self

Applies a scalar maximum to this range.

pub fn powf(self, value: f32) -> Self

Applies a scalar power to this range. The interval must be non-negative.

pub fn powi(self, value: i32) -> Self

Applies an integral scalar power to this range.

pub fn mul_pow2(self, value: i32) -> Option<Self>

Multiplies this range by the provided integer power of 2.

pub fn mul_pow2_unchecked(self, value: i32) -> Self

Multiplies this range by the provided integer power of 2 without overflow checking. This function is safe, but in the case where the exponent of either minimum or maximum has an overflow, the result is not specified.

pub fn round(self) -> Self

Rounds this range to the nearest whole number.

Trait Implementations

impl Add<f32> for RealInterval

type Output = RealInterval

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> Self::Output

Performs the + operation.

impl Add for RealInterval

type Output = RealInterval

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl BitAnd for RealInterval

type Output = Option<RealInterval>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for RealInterval

type Output = RealInterval

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for RealInterval

fn clone(&self) -> RealInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealInterval

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

Formats the value using the given formatter.

impl Default for RealInterval

fn default() -> RealInterval

Returns the “default value” for a type.

impl Display for RealInterval

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

Formats the value using the given formatter.

impl Mul<RealInterval> for f32

type Output = RealInterval

The resulting type after applying the * operator.

fn mul(self, rhs: RealInterval) -> Self::Output

Performs the * operation.

impl Mul<f32> for RealInterval

type Output = RealInterval

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl Mul for RealInterval

type Output = RealInterval

The resulting type after applying the * operator.

fn mul(self, rhs: RealInterval) -> Self::Output

Performs the * operation.

impl Neg for RealInterval

type Output = RealInterval

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for RealInterval

fn eq(&self, other: &RealInterval) -> 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 Sub<f32> for RealInterval

type Output = RealInterval

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Self::Output

Performs the - operation.

impl Sub for RealInterval

type Output = RealInterval

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Copy for RealInterval

impl StructuralPartialEq for RealInterval