Enum rcalc_lib::value::Value

pub enum Value {
    Int(BigInt),
    Float(f64),
    Ratio(BigRational),
    Complex(Complex<f64>),
}

Supported value types (Float is used for angles in degrees)

Variants

Int(BigInt)

Big integer number

Float(f64)

Float number

Ratio(BigRational)

Rational number (numerator and denominator are big integers)

Complex(Complex<f64>)

Complex number

Implementations

impl Value

pub fn new() -> Self

pub fn from_str_integer(s: &str) -> CalcResult

Convert &str to big integer number Supported formats:

• Raw integer number - 1234
• Integer number and exponent (it must not include decimal point) - 12e2 = 1200
• Hexadecimal number - 0x12 or 0X12
• Octal number - 0o12 or 0O12
• Binary number - 0b101 or 0B101

For convenience digits can be separated with underscores: 3_00_1 is the same as 3001

pub fn from_str_float(s: &str) -> CalcResult

Convert &str to float number Supported formats:

• Without exponent - 1.023
• With exponent - 1.02e-5

Comma(,) can be used instead of decimal point(.): 1.25 is the same as 1,25

For convenience digits can be separated with underscores: 3_005.245_1 is the same as 3005.2451

pub fn from_str_ratio(st: &str) -> CalcResult

Convert &str to rational number Supported formats:

• Numerator and denominator only: 1\2 = one half
• With integer part: 3\1\2 = three and a half

For convenience digits can be separated with underscores: 3_005\1_988 is the same as 3005\1988

pub fn from_str_angle(s: &str) -> CalcResult

Convert &str that represents angle in degrees to float number Supported formats:

• Full form with letters - 30d20m50s - 30 degress, 20 angular minutes and 30 angular seconds
• Full form with special characters - 30°20'50"
• Short form - degrees only - 30.25d or 30.25°

Characters can be mixed: 30d20'50". Letters can be either lowercase or capital ones.

Comma(,) can be used instead of decimal point(.): 1.25d is the same as 1,25d

For convenience digits can be separated with underscores: 3_005.245_1d is the same as 3005.2451d

pub fn from_str_complex(s: &str) -> CalcResult

Convert &str to complex number Supported formats:

• “post” marker - 1+2i
• *pre“ marker - 1+i2

i can be capital one. Instead of i letter j can be used.

Note: while omitting real part is supported by this converter(e.g, it parses 2i to 0+2i), it is discouraged. Because a parser that parses the entire expression cannot detect such cases and may generate an error.

Comma(,) can be used instead of decimal point(.): 1.25d is the same as 1,25d

For convenience digits can be separated with underscores: 3_005.245_1d is the same as 3005.2451d

pub fn is_zero(&self) -> bool

Returns true if the value is zero

pub fn is_positive(&self) -> bool

Returns true if the value is zero or greater

pub fn addition(self, rhs: Value) -> CalcResult

pub fn subtract(self, rhs: Value) -> CalcResult

pub fn multiply(self, rhs: Value) -> CalcResult

pub fn divide(self, rhs: Value) -> CalcResult

pub fn reminder(self, rhs: Value) -> CalcResult

pub fn div_int(self, rhs: Value) -> CalcResult

Divides and truncates the result. Note: the result is always big integer number even if two complex numbers are divided. It means in that the result for complex numbers may be incorrect or strange

pub fn negate(self) -> CalcResult

Inverts the sign of the value

pub fn norm(self) -> CalcResult

Calculates modulus of a complex number

pub fn conj(self) -> CalcResult

Conjugates a complex number

pub fn im(self) -> CalcResult

Returns imaginary part of a complex number

pub fn re(self) -> CalcResult

Returns real part of a complex number

pub fn eq(self, rhs: Value) -> CalcResult

pub fn less(self, rhs: Value) -> CalcResult

pub fn lesseq(self, rhs: Value) -> CalcResult

pub fn neq(self, rhs: Value) -> CalcResult

pub fn greater(self, rhs: Value) -> CalcResult

pub fn greatereq(self, rhs: Value) -> CalcResult

pub fn logical_not(self) -> CalcResult

Inverts value as if it is a boolean one. Since the library does not have dedicated type for boolean values, big integers play their role. Rules of inversion:

• Any zero value -> 1
• 0 in all other cases

pub fn logical_and(self, rhs: Value) -> CalcResult

pub fn logical_or(self, rhs: Value) -> CalcResult

pub fn fract(self) -> CalcResult

Extract fractional part of a float number

pub fn abs(self) -> CalcResult

Returns absolute value of a number For complex numbers only its real part changes

pub fn floor(self) -> CalcResult

pub fn ceil(self) -> CalcResult

pub fn round(self) -> CalcResult

pub fn trunc(self) -> CalcResult

pub fn sqr(self) -> CalcResult

Squares the value. Automatically converts complex number into float one if imaginary part of the result is zero

pub fn signum(self) -> CalcResult

Returns sign of the number (for complex number it is a sign of real part):

• 1 for a number greater than 0
• 0 for zero number
• -1 for number less than 0

pub fn sqrt(self) -> CalcResult

Returns square root of a number. Automatically converts a negative number into complex one before calculation

pub fn cbrt(self) -> CalcResult

Returns cubic root of a number.

pub fn power(self, rhs: Value) -> CalcResult

Raises a number into arbitrary power. Automatic conversion as sqrt does is not not supported yet. For integer power degrees the fast and accurate algorithm is used. For float degrees the power is calculated using exp

pub fn fact(self) -> CalcResult

Returns factorial of a number. Complex numbers generates an error. Calculation factorial of negative or float number using gamma function is not supported yet

pub fn bit_or(self, rhs: Value) -> CalcResult

pub fn bit_and(self, rhs: Value) -> CalcResult

pub fn bit_xor(self, rhs: Value) -> CalcResult

pub fn bit_shl(self, rhs: Value) -> CalcResult

pub fn bit_shr(self, rhs: Value) -> CalcResult

pub fn bit_not(self) -> CalcResult

pub fn sin(self) -> CalcResult

pub fn cos(self) -> CalcResult

pub fn tan(self) -> CalcResult

pub fn asin(self) -> CalcResult

pub fn acos(self) -> CalcResult

pub fn atan(self) -> CalcResult

pub fn sinh(self) -> CalcResult

pub fn cosh(self) -> CalcResult

pub fn tanh(self) -> CalcResult

pub fn asinh(self) -> CalcResult

pub fn acosh(self) -> CalcResult

pub fn exp(self) -> CalcResult

pub fn atanh(self) -> CalcResult

pub fn ln(self) -> CalcResult

Returns natural logarithm of a number. Automatically converts a negative number to a complex one before calculation

pub fn ratio(self) -> CalcResult

Converts float or integer number into rational one. Complex numbers generate an error

pub fn gcd(self, rhs: Value) -> CalcResult

Greatest common divisor

pub fn lcm(self, rhs: Value) -> CalcResult

Least Common Multiple

pub fn prime(self) -> CalcResult

Is Value a prime number. Returns error if a value is not integer Naive and slow algorithm for large integers

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl Display for Value

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

Formats the value using the given formatter.

impl PartialEq<Value> for Value

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

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

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

This method tests for !=.