Merge pull request #693 from sys27/feature/rational-number

#175 - Support rational numbers
sys27 · Aug 27, 2023 · ff712e6 · ff712e6
2 parents e93f13e + 44396df
commit ff712e6
Show file tree

Hide file tree

Showing 61 changed files with 2,152 additions and 261 deletions.
diff --git a/docs/articles/change-log.md b/docs/articles/change-log.md
@@ -4,6 +4,7 @@
 
 * [#680](https://github.com/sys27/xFunc/issues/680) - Remove Moq. ([#651](https://github.com/sys27/xFunc/pull/651)).
 * [#688](https://github.com/sys27/xFunc/issues/688) - DocFx Documentation.
+* [#175](https://github.com/sys27/xFunc/pull/175) - Support rational numbers ([#693](https://github.com/sys27/xFunc/pull/693)).
 
 ## xFunc v4.3.0
 

diff --git a/docs/articles/supported-functions-and-operations.md b/docs/articles/supported-functions-and-operations.md
diff --git a/xFunc.Maths/Analyzers/Analyzer{TResult,TContext}.cs b/xFunc.Maths/Analyzers/Analyzer{TResult,TContext}.cs
@@ -225,6 +225,14 @@ public virtual TResult Analyze(StringExpression exp, TContext context)
     public virtual TResult Analyze(Expressions.Units.Convert exp, TContext context)
         => Analyze(exp as IExpression, context);
 
+    /// <inheritdoc />
+    public virtual TResult Analyze(Rational exp, TContext context)
+        => Analyze(exp as IExpression, context);
+
+    /// <inheritdoc />
+    public virtual TResult Analyze(ToRational exp, TContext context)
+        => Analyze(exp as IExpression, context);
+
     #endregion Standard
 
     #region Matrix

diff --git a/xFunc.Maths/Analyzers/Analyzer{TResult}.cs b/xFunc.Maths/Analyzers/Analyzer{TResult}.cs
@@ -224,6 +224,14 @@ public virtual TResult Analyze(StringExpression exp)
     public virtual TResult Analyze(Expressions.Units.Convert exp)
         => Analyze(exp as IExpression);
 
+    /// <inheritdoc />
+    public virtual TResult Analyze(Rational exp)
+        => Analyze(exp as IExpression);
+
+    /// <inheritdoc />
+    public virtual TResult Analyze(ToRational exp)
+        => Analyze(exp as IExpression);
+
     #endregion Standard
 
     #region Matrix

diff --git a/xFunc.Maths/Analyzers/Formatters/CommonFormatter.cs b/xFunc.Maths/Analyzers/Formatters/CommonFormatter.cs
@@ -287,6 +287,14 @@ public virtual string Analyze(Expressions.Units.Convert exp)
         return $"convert({value}, {unit})";
     }
 
+    /// <inheritdoc />
+    public virtual string Analyze(Rational exp)
+        => ToString(exp, "{0} // {1}");
+
+    /// <inheritdoc />
+    public virtual string Analyze(ToRational exp)
+        => ToString(exp, "torational({0})");
+
     #endregion Standard
 
     #region Matrix

diff --git a/xFunc.Maths/Analyzers/IAnalyzer{TResult,TContext}.cs b/xFunc.Maths/Analyzers/IAnalyzer{TResult,TContext}.cs
@@ -428,6 +428,22 @@ public interface IAnalyzer<out TResult, in TContext>
     /// <returns>The result of analysis.</returns>
     TResult Analyze(Expressions.Units.Convert exp, TContext context);
 
+    /// <summary>
+    /// Analyzes the specified expression.
+    /// </summary>
+    /// <param name="exp">The expression.</param>
+    /// <param name="context">The context.</param>
+    /// <returns>The result of analysis.</returns>
+    TResult Analyze(Rational exp, TContext context);
+
+    /// <summary>
+    /// Analyzes the specified expression.
+    /// </summary>
+    /// <param name="exp">The expression.</param>
+    /// <param name="context">The context.</param>
+    /// <returns>The result of analysis.</returns>
+    TResult Analyze(ToRational exp, TContext context);
+
     #endregion Standard
 
     #region Matrix

diff --git a/xFunc.Maths/Analyzers/IAnalyzer{TResult}.cs b/xFunc.Maths/Analyzers/IAnalyzer{TResult}.cs
@@ -375,6 +375,20 @@ public interface IAnalyzer<out TResult>
     /// <returns>The result of analysis.</returns>
     TResult Analyze(Expressions.Units.Convert exp);
 
+    /// <summary>
+    /// Analyzes the specified expression.
+    /// </summary>
+    /// <param name="exp">The expression.</param>
+    /// <returns>The result of analysis.</returns>
+    TResult Analyze(Rational exp);
+
+    /// <summary>
+    /// Analyzes the specified expression.
+    /// </summary>
+    /// <param name="exp">The expression.</param>
+    /// <returns>The result of analysis.</returns>
+    TResult Analyze(ToRational exp);
+
     #endregion Standard
 
     #region Matrix

diff --git a/xFunc.Maths/Analyzers/TypeAnalyzers/ResultTypes.cs b/xFunc.Maths/Analyzers/TypeAnalyzers/ResultTypes.cs
@@ -95,4 +95,9 @@ public enum ResultTypes
     /// The expression returns a volume number.
     /// </summary>
     VolumeNumber = 1 << 15,
+
+    /// <summary>
+    /// The returns a rational number.
+    /// </summary>
+    RationalNumber = 1 << 16,
 }
diff --git a/xFunc.Maths/Analyzers/TypeAnalyzers/TypeAnalyzer.cs b/xFunc.Maths/Analyzers/TypeAnalyzers/TypeAnalyzer.cs
@@ -422,6 +422,7 @@ public virtual ResultTypes Analyze(Abs exp)
             ResultTypes.TimeNumber => ResultTypes.TimeNumber,
             ResultTypes.AreaNumber => ResultTypes.AreaNumber,
             ResultTypes.VolumeNumber => ResultTypes.VolumeNumber,
+            ResultTypes.RationalNumber => ResultTypes.RationalNumber,
             _ => NumbersOrComplexOrVector.ThrowFor(result),
         };
     }
@@ -488,6 +489,11 @@ public virtual ResultTypes Analyze(Add exp)
                 (ResultTypes.ComplexNumber, ResultTypes.ComplexNumber)
                 => ResultTypes.ComplexNumber,
 
+            (ResultTypes.RationalNumber, ResultTypes.RationalNumber) or
+                (ResultTypes.Number, ResultTypes.RationalNumber) or
+                (ResultTypes.RationalNumber, ResultTypes.Number)
+                => ResultTypes.RationalNumber,
+
             (ResultTypes.Vector, ResultTypes.Vector) => ResultTypes.Vector,
             (ResultTypes.Matrix, ResultTypes.Matrix) => ResultTypes.Matrix,
 
@@ -631,6 +637,11 @@ public virtual ResultTypes Analyze(Div exp)
                 (ResultTypes.ComplexNumber, ResultTypes.ComplexNumber)
                 => ResultTypes.ComplexNumber,
 
+            (ResultTypes.RationalNumber, ResultTypes.RationalNumber) or
+                (ResultTypes.Number, ResultTypes.RationalNumber) or
+                (ResultTypes.RationalNumber, ResultTypes.Number)
+                => ResultTypes.RationalNumber,
+
             (_, ResultTypes.Number) => NumbersOrComplex.ThrowForLeft(leftResult),
             (ResultTypes.Number, _) => NumbersOrComplex.ThrowForRight(rightResult),
 
@@ -779,10 +790,10 @@ public virtual ResultTypes Analyze(Lb exp)
             throw new ArgumentNullException(nameof(exp));
 
         var result = exp.Argument.Analyze(this);
-        if (result is ResultTypes.Undefined or ResultTypes.Number)
+        if (result is ResultTypes.Undefined or ResultTypes.Number or ResultTypes.RationalNumber)
             return ResultTypes.Number;
 
-        return ResultTypes.Number.ThrowFor(result);
+        return (ResultTypes.Number | ResultTypes.RationalNumber).ThrowFor(result);
     }
 
     /// <inheritdoc />
@@ -817,6 +828,8 @@ public virtual ResultTypes Analyze(Lg exp)
             ResultTypes.Undefined => ResultTypes.Undefined,
             ResultTypes.Number => ResultTypes.Number,
             ResultTypes.ComplexNumber => ResultTypes.ComplexNumber,
+            ResultTypes.RationalNumber => ResultTypes.Number,
+
             _ => NumberOrComplex.ThrowFor(result),
         };
     }
@@ -834,6 +847,8 @@ public virtual ResultTypes Analyze(Ln exp)
             ResultTypes.Undefined => ResultTypes.Undefined,
             ResultTypes.Number => ResultTypes.Number,
             ResultTypes.ComplexNumber => ResultTypes.ComplexNumber,
+            ResultTypes.RationalNumber => ResultTypes.Number,
+
             _ => NumberOrComplex.ThrowFor(result),
         };
     }
@@ -855,6 +870,7 @@ public virtual ResultTypes Analyze(Log exp)
 
             (ResultTypes.Number, ResultTypes.Number) => ResultTypes.Number,
             (ResultTypes.Number, ResultTypes.ComplexNumber) => ResultTypes.ComplexNumber,
+            (ResultTypes.Number, ResultTypes.RationalNumber) => ResultTypes.Number,
 
             (ResultTypes.Number, _) => NumberOrComplex.ThrowForRight(rightResult),
 
@@ -949,6 +965,11 @@ public virtual ResultTypes Analyze(Mul exp)
                 (ResultTypes.ComplexNumber, ResultTypes.ComplexNumber)
                 => ResultTypes.ComplexNumber,
 
+            (ResultTypes.RationalNumber, ResultTypes.RationalNumber) or
+                (ResultTypes.Number, ResultTypes.RationalNumber) or
+                (ResultTypes.RationalNumber, ResultTypes.Number)
+                => ResultTypes.RationalNumber,
+
             (ResultTypes.Vector, ResultTypes.Number) or
                 (ResultTypes.Number, ResultTypes.Vector) or
                 (ResultTypes.Vector, ResultTypes.Vector)
@@ -1071,7 +1092,8 @@ ResultTypes.MassNumber or
                 ResultTypes.LengthNumber or
                 ResultTypes.TimeNumber or
                 ResultTypes.AreaNumber or
-                ResultTypes.VolumeNumber
+                ResultTypes.VolumeNumber or
+                ResultTypes.RationalNumber
                 => ResultTypes.Number,
             _ => Units.ThrowFor(result),
         };
@@ -1101,6 +1123,9 @@ public virtual ResultTypes Analyze(Pow exp)
             (ResultTypes.Number, ResultTypes.Number)
                 => ResultTypes.Undefined,
 
+            (ResultTypes.RationalNumber, ResultTypes.Number)
+                => ResultTypes.RationalNumber,
+
             _ => ResultTypes.Number.ThrowForLeft(leftResult),
         };
     }
@@ -1237,6 +1262,11 @@ public virtual ResultTypes Analyze(Sub exp)
                 (ResultTypes.ComplexNumber, ResultTypes.ComplexNumber)
                 => ResultTypes.ComplexNumber,
 
+            (ResultTypes.RationalNumber, ResultTypes.RationalNumber) or
+                (ResultTypes.Number, ResultTypes.RationalNumber) or
+                (ResultTypes.RationalNumber, ResultTypes.Number)
+                => ResultTypes.RationalNumber,
+
             (ResultTypes.Vector, ResultTypes.Vector) => ResultTypes.Vector,
             (ResultTypes.Matrix, ResultTypes.Matrix) => ResultTypes.Matrix,
 
@@ -1301,6 +1331,7 @@ public virtual ResultTypes Analyze(UnaryMinus exp)
             ResultTypes.AreaNumber => ResultTypes.AreaNumber,
             ResultTypes.VolumeNumber => ResultTypes.VolumeNumber,
             ResultTypes.ComplexNumber => ResultTypes.ComplexNumber,
+            ResultTypes.RationalNumber => ResultTypes.RationalNumber,
             _ => NumberOrComplex.ThrowFor(result),
         };
     }
@@ -1392,6 +1423,50 @@ ResultTypes.Undefined or
         };
     }
 
+    /// <inheritdoc />
+    public virtual ResultTypes Analyze(Rational exp)
+    {
+        if (exp is null)
+            throw new ArgumentNullException(nameof(exp));
+
+        var leftResult = exp.Left.Analyze(this);
+        var rightResult = exp.Right.Analyze(this);
+
+        return (leftResult, rightResult) switch
+        {
+            (ResultTypes.Undefined, _) or (_, ResultTypes.Undefined)
+                => ResultTypes.Undefined,
+
+            (ResultTypes.Number, ResultTypes.Number)
+                => ResultTypes.RationalNumber,
+
+            (ResultTypes.Number, _)
+                => ResultTypes.Number.ThrowForRight(rightResult),
+
+            (_, ResultTypes.Number)
+                => ResultTypes.Number.ThrowForLeft(leftResult),
+
+            _ => throw new ParameterTypeMismatchException(),
+        };
+    }
+
+    /// <inheritdoc />
+    public virtual ResultTypes Analyze(ToRational exp)
+    {
+        if (exp is null)
+            throw new ArgumentNullException(nameof(exp));
+
+        var argumentResult = exp.Argument.Analyze(this);
+
+        return argumentResult switch
+        {
+            ResultTypes.Undefined => ResultTypes.Undefined,
+            ResultTypes.Number => ResultTypes.RationalNumber,
+
+            _ => throw new ParameterTypeMismatchException(ResultTypes.Number, argumentResult),
+        };
+    }
+
     #endregion Standard
 
     #region Matrix

diff --git a/xFunc.Maths/Expressions/Abs.cs b/xFunc.Maths/Expressions/Abs.cs
@@ -54,6 +54,7 @@ public override object Execute(ExpressionParameters? parameters)
             VolumeValue volume => VolumeValue.Abs(volume),
             Complex complex => Complex.Abs(complex),
             VectorValue vector => VectorValue.Abs(vector),
+            RationalValue rationalValue => RationalValue.Abs(rationalValue),
             _ => throw new ResultIsNotSupportedException(this, result),
         };
     }

diff --git a/xFunc.Maths/Expressions/Add.cs b/xFunc.Maths/Expressions/Add.cs
@@ -85,6 +85,10 @@ public override object Execute(ExpressionParameters? parameters)
             (Complex left, NumberValue right) => left + right,
             (Complex left, Complex right) => left + right,
 
+            (NumberValue left, RationalValue right) => left + right,
+            (RationalValue left, NumberValue right) => left + right,
+            (RationalValue left, RationalValue right) => left + right,
+
             (VectorValue left, VectorValue right) => left + right,
             (MatrixValue left, MatrixValue right) => left + right,
 

diff --git a/xFunc.Maths/Expressions/Div.cs b/xFunc.Maths/Expressions/Div.cs
@@ -61,6 +61,10 @@ public override object Execute(ExpressionParameters? parameters)
             (Complex left, NumberValue right) => left / right,
             (Complex left, Complex right) => left / right,
 
+            (NumberValue left, RationalValue right) => left / right,
+            (RationalValue left, NumberValue right) => left / right,
+            (RationalValue left, RationalValue right) => left / right,
+
             _ => throw new ResultIsNotSupportedException(this, leftResult, rightResult),
         };
     }

diff --git a/xFunc.Maths/Expressions/Lb.cs b/xFunc.Maths/Expressions/Lb.cs
@@ -43,6 +43,8 @@ public override object Execute(ExpressionParameters? parameters)
         return result switch
         {
             NumberValue number => NumberValue.Lb(number),
+            RationalValue rationalValue => RationalValue.Lb(rationalValue),
+
             _ => throw new ResultIsNotSupportedException(this, result),
         };
     }

diff --git a/xFunc.Maths/Expressions/Lg.cs b/xFunc.Maths/Expressions/Lg.cs
@@ -45,6 +45,8 @@ public override object Execute(ExpressionParameters? parameters)
         {
             NumberValue number => NumberValue.Lg(number),
             Complex complex => Complex.Log10(complex),
+            RationalValue rationalValue => RationalValue.Lg(rationalValue),
+
             _ => throw new ResultIsNotSupportedException(this, result),
         };
     }

diff --git a/xFunc.Maths/Expressions/Ln.cs b/xFunc.Maths/Expressions/Ln.cs
@@ -45,6 +45,8 @@ public override object Execute(ExpressionParameters? parameters)
         {
             NumberValue number => NumberValue.Ln(number),
             Complex complex => Complex.Log(complex),
+            RationalValue rationalValue => RationalValue.Ln(rationalValue),
+
             _ => throw new ResultIsNotSupportedException(this, result),
         };
     }

diff --git a/xFunc.Maths/Expressions/Log.cs b/xFunc.Maths/Expressions/Log.cs
@@ -49,6 +49,7 @@ public override object Execute(ExpressionParameters? parameters)
         {
             (NumberValue left, NumberValue right) => NumberValue.Log(right, left),
             (NumberValue left, Complex complex) => NumberValue.Log(complex, left),
+            (NumberValue left, RationalValue right) => RationalValue.Log(right, left),
             _ => throw new ResultIsNotSupportedException(this, leftResult, rightResult),
         };
     }

diff --git a/xFunc.Maths/Expressions/Mul.cs b/xFunc.Maths/Expressions/Mul.cs
@@ -79,6 +79,10 @@ public override object Execute(ExpressionParameters? parameters)
             (Complex left, NumberValue right) => left * right,
             (Complex left, Complex right) => left * right,
 
+            (NumberValue left, RationalValue right) => left * right,
+            (RationalValue left, NumberValue right) => left * right,
+            (RationalValue left, RationalValue right) => left * right,
+
             (VectorValue left, VectorValue right) => left * right,
             (NumberValue left, VectorValue right) => right * left,
             (VectorValue left, NumberValue right) => left * right,

diff --git a/xFunc.Maths/Expressions/Parameters/ParameterValue.cs b/xFunc.Maths/Expressions/Parameters/ParameterValue.cs
@@ -107,6 +107,12 @@ public ParameterValue(Lambda lambda)
     {
     }
 
+    /// <inheritdoc cref="ParameterValue(object)"/>
+    public ParameterValue(RationalValue rationalValue)
+        : this(rationalValue as object)
+    {
+    }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="ParameterValue" /> struct.
     /// </summary>
@@ -131,7 +137,8 @@ or bool
                 or VectorValue
                 or MatrixValue
                 or string
-                or Lambda,
+                or Lambda
+                or RationalValue,
             "Unsupported parameter value.");
 
         Value = value;
@@ -205,6 +212,10 @@ or string
     public static implicit operator ParameterValue(Lambda value)
         => new ParameterValue(value);
 
+    /// <inheritdoc cref="ParameterValue.op_Implicit(double)"/>
+    public static implicit operator ParameterValue(RationalValue value)
+        => new ParameterValue(value);
+
     /// <inheritdoc />
     public bool Equals(ParameterValue other)
         => Value.Equals(other.Value);

diff --git a/xFunc.Maths/Expressions/Pow.cs b/xFunc.Maths/Expressions/Pow.cs
@@ -50,6 +50,7 @@ public override object Execute(ExpressionParameters? parameters)
             (NumberValue left, Complex right) => Complex.Pow(left.Number, right),
             (Complex left, NumberValue right) => NumberValue.Pow(left, right),
             (Complex left, Complex right) => Complex.Pow(left, right),
+            (RationalValue left, NumberValue right) => RationalValue.Pow(left, right),
             _ => throw new ResultIsNotSupportedException(this, leftResult, rightResult),
         };
     }