Struct temporal_networks::interval::Interval

pub struct Interval(pub f64, pub f64);

An interval represents a context-agnostic inclusive [lower, upper] time range. While Interval may be accessible from JS, the Rust implementation includes additional operator overloads for simplified arithmetic.

JS-specific

• Use .toJSON() if you want to convert an Interval to an array of numbers
• Using indexing to get the lower and upper bounds is also an option, eg. interval[0] === lower && interval[1] === upper
• use Number.MAX_VALUE and -Number.MAX_VALUE to represent infinity and -infinity respectively

Examples

Interval arithmetic in Rust.

use temporal_networks::interval::Interval;

let interval1 = Interval::new(0., 10.);
let interval2 = Interval::new(5., 16.);

let summed_interval = Interval::new(5., 26.);
assert_eq!(interval1 + interval2, summed_interval);

let diff_interval = Interval::new(-5., 16.);
assert_eq!(interval2 - interval1, diff_interval);

let unioned_interval = Interval::new(5., 10.);
assert_eq!(interval1 & interval2, unioned_interval);

Methods

impl Interval

pub fn new(lower: f64, upper: f64) -> Interval

Create a new Interval

pub fn from_vec(other: Vec<f64>) -> Interval

Get an interval from a vector

pub fn to_json(&self) -> JsValue

Convert the interval to JSON [lower, upper]

pub fn lower(&self) -> f64

The lower bound of the range

pub fn upper(&self) -> f64

The upper bound of the range

pub fn contains(&self, v: f64) -> bool

Whether or not a point in time falls within a range

pub fn is_valid(&self) -> bool

A check that ensures the lower bound is less than the upper bound

pub fn converged(&self) -> bool

Whether or not the interval has converged to a time

pub fn union(&self, other: &Interval) -> Interval

Union these intervals

Trait Implementations

impl Add<Interval> for Interval

type Output = Interval

The resulting type after applying the + operator.

fn add(self, other: Interval) -> Interval

create a new interval from the addition of two other intervals

impl AddAssign<Interval> for Interval

fn add_assign(&mut self, other: Interval)

Performs the += operation.

impl BitAnd<Interval> for Interval

type Output = Interval

The resulting type after applying the & operator.

fn bitand(self, other: Interval) -> Interval

Performs the & operation.

impl BitAndAssign<Interval> for Interval

fn bitand_assign(&mut self, other: Interval)

Performs the &= operation.

impl Clone for Interval

fn clone(&self) -> Interval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Interval

impl Debug for Interval

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

Formats the value using the given formatter.

impl Default for Interval

fn default() -> Interval

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Interval

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Interval

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

Formats the value using the given formatter.

impl From<Interval> for JsValue

fn from(value: Interval) -> Self

Performs the conversion.

impl FromWasmAbi for Interval

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Interval

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl Neg for Interval

type Output = Interval

The resulting type after applying the - operator.

fn neg(self) -> Interval

Performs the unary - operation.

impl OptionFromWasmAbi for Interval

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Interval

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl PartialEq<Interval> for Interval

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl RefFromWasmAbi for Interval

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Interval>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Interval

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Interval>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Serialize for Interval

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Interval

impl Sub<Interval> for Interval

type Output = Interval

The resulting type after applying the - operator.

fn sub(self, other: Interval) -> Interval

Performs the - operation.

impl SubAssign<Interval> for Interval

fn sub_assign(&mut self, other: Interval)

Performs the -= operation.

impl WasmDescribe for Interval

fn describe()