Enum SNumber 

pub enum SNumber {
    Int(i64),
    Float(f64),
}

This models a numeric Scratch value and is therefore returned by numeric operations or where it is known a value is neither a text nor a boolean.

Variants

Int(i64)

Float(f64)

Implementations

impl SNumber

pub fn q_add_numbers<Q>(&self, other: &SNumber, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ> + QuirkSink<IntegerAddWouldFailQ>,

If both numbers are finite integers numbers are added as integers if the result fits into an i64.

Otherwise, the below table applys. p and q are arbitraty finite floats.

(line + column is shown in cell)

+		NaN	+∞	-∞	+q	-q	+0	-0
NaN		0	+∞	-∞	+q	-q	+0	-0
+∞		+∞	+∞	NaN	+∞	+∞	+∞	-∞
-∞		-∞	NaN	-∞	-∞	-∞	-∞	-∞
+p		+p	+∞	-∞	+p+q	+p+(-q)	+p	+p
-p		-p	+∞	-∞	-p+q	-p+(-q)	-p	-p
+0		+0	+∞	-∞	+q	-q	0	0
-0		-0	+∞	-∞	+q	-q	0	0

impl SNumber

pub fn q_div_numbers<Q>(&self, other: &SNumber, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

Integers are automatically divided as floats (if the remainder != 0) but I think this shouldn’t be considered a quirk as some people would actually like it (?)

The division rules are not necessarily identical to IEEE 754.

• n·m / m → n (integer division without remainder)

If both numbers are finite integers and the division would have a remainder of 0 the numbers are divided as integers. Otherwise, the below table applys. p and q are arbitraty finite floats.

(line / column is shown in cell)

/		NaN	+∞	-∞	+q	-q	+0	-0
NaN		NaN	+0	-0	+0	-0	NaN	NaN
+∞		+∞	NaN	NaN	+∞	-∞	+∞	-∞
-∞		-∞	NaN	NaN	-∞	+∞	-∞	+∞
+p		+∞	+0	-0	p/q	-p/q	+∞	-∞
-p		-∞	-0	+0	-p/q	p/q	-∞	+∞
+0		NaN	+0	-0	+0	-0	NaN	NaN
-0		NaN	-0	+0	-0	+0	NaN	NaN

impl SNumber

pub fn q_mul_numbers<Q>(&self, other: &SNumber, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ> + QuirkSink<IntegerMulWouldFailQ>,

If both numbers are finite integers numbers are multiplied as integers if the result fits into an i64.

Otherwise, the below table applys. p and q are arbitraty finite floats.

(line * column is shown in cell)

*		NaN	+∞	-∞	+q	-q	+0	-0
NaN		0	0	0	0	0	0	0
+∞		0	+∞	-∞	+∞	-∞	NaN	NaN
-∞		0	-∞	+∞	-∞	+∞	NaN	NaN
+p		0	+∞	-∞	(+p)*(+q)	(+p)*(-q)	0	0
-p		0	-∞	+∞	(-p)*(+q)	(-p)*(-q)	0	0
+0		0	NaN	NaN	0	0	0	0
-0		0	NaN	NaN	0	0	0	0

impl SNumber

pub fn q_sub_numbers<Q>(&self, other: &SNumber, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ> + QuirkSink<IntegerSubWouldFailQ>,

If both numbers are finite integers numbers are subtracted as integers if the result fits into an i64.

Otherwise, the below table applys. p and q are arbitraty finite floats.

(line - column is shown in cell)

-		NaN	+∞	-∞	+q	-q	+0	-0
NaN		0	-∞	+∞	-q	+q	-0	+0
+∞		+∞	NaN	+∞	+∞	+∞	+∞	-∞
-∞		-∞	-∞	NaN	-∞	-∞	-∞	-∞
+p		+p	-∞	+∞	+p-(+q)	+p-(-q)	+p	+p
-p		-p	-∞	+∞	-p-(+q)	-p-(-q)	-p	-p
+0		+0	-∞	+∞	-q	+q	0	0
-0		-0	-∞	+∞	-q	+q	0	0

impl SNumber

pub fn q_eq<Q>(&self, other: &SNumber, sink: &mut Q) -> bool

where Q: QuirkSink<SNumberToFloatQ>,

Compares two Scratch numbers for equality

• [t] -∞ == -∞ → true
• [f] -∞ == +∞ → false
• [f] +∞ == -∞ → false
• [t] +∞ == +∞ → true
• [t] NaN == NaN → true
• [f] NaN == number → false
• [f] number == NaN → false

If both values are integers, integer equality is used. If both values are finite floating point numbers, floating point equality is used.

NaN is only equal to NaN.

(short value in [] for easy reference)

impl SNumber

pub fn q_lt<Q>(&self, other: &SNumber, sink: &mut Q) -> bool

where Q: QuirkSink<SNumberToFloatQ>,

Compares two numbers and checks if the first is smaller than the second

The ordering seems to be: -∞ < number < +∞ < NaN < NaN (NaN is smaller than itself)

• [t] NaN < NaN → true
• [f] NaN < ±∞ → false
• [f] NaN < number → false
• [t] -∞ < NaN → true
• [f] -∞ < -∞ → false
• [t] -∞ < +∞ → true
• [t] -∞ < number → true
• [t] +∞ < NaN → true
• [f] +∞ < other than NaN → false
• [t] number < NaN → true
• [t] number < +∞ → true
• [f] number < -∞ → false

(short value in [] for easy reference)

pub fn q_gt<Q>(&self, other: &SNumber, sink: &mut Q) -> bool

where Q: QuirkSink<SNumberToFloatQ>,

like Self::q_lt with swapped arguments

impl SNumber

pub const fn svalue(self) -> SValue

impl SNumber

pub fn q_as_float<Q>(&self, sink: &mut Q) -> f64

where Q: QuirkSink<SNumberToFloatQ>,

impl SNumber

pub fn int_or_border<Q>(&self, sink: &mut Q) -> i64

where Q: QuirkSink<NumberTooBigForIntQ>,

impl SNumber

pub fn q_exp<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_ln<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_log10<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_power_of_10<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

This computes 10^value where value is the number in self

If the stored number is an integer, the exponent can losslessly be interpreted as u32 and the result fits into i64 the integer function i64::checked_pow is used.

Otherwise f64::powf is used, NaN will be treated as 0.

impl SNumber

pub fn q_modulo<Q>(&self, other: &SNumber, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

This mimics the JS remainder operator https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Remainder

impl SNumber

pub fn floor(&self) -> SNumber

pub fn ceil(&self) -> SNumber

pub fn round(&self) -> SNumber

impl SNumber

pub fn sqrt(&self) -> SNumber

impl SNumber

pub fn q_cos<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_sin<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_tan<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_acos<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_asin<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

pub fn q_atan<Q>(&self, sink: &mut Q) -> SNumber

where Q: QuirkSink<SNumberToFloatQ>,

impl SNumber

pub fn abs(&self) -> SNumber

Trait Implementations

impl Clone for SNumber

fn clone(&self) -> SNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SNumber

impl Debug for SNumber

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

Formats the value using the given formatter.

impl Display for SNumber

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

Formats the value using the given formatter.

impl From<Number> for SNumber

Available on crate feature serde_json only.

fn from(value: Number) -> SNumber

Converts to this type from the input type.

impl From<SNumber> for SValue

fn from(value: SNumber) -> Self

Converts to this type from the input type.

impl PartialEq for SNumber

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SNumber

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.