Merge pull request #144 from chr1st0scli/ceiling-floor-primitives

Ceiling floor primitives

Author: chr1st0scli

CHANGELOG.md

@@ -16,6 +16,17 @@ Semantic versioning is followed.
 
 ### Removed
 
+## [1.1.0] - 2024-01-28
+
+### Added
+- Ceiling and floor primitive procedures.
+
+### Fixed
+
+### Changed
+
+### Removed
+
 ## [1.0.0] - 2023-07-20
 
 Initial release.

RainLisp/Docs/primitives.md

@@ -18,6 +18,7 @@
 - [add-years](primitives/add-years.md)
 - [car](primitives/car.md)
 - [cdr](primitives/cdr.md)
+- [ceiling](primitives/ceiling.md)
 - [cons](primitives/cons.md)
 - [datetime-to-string](primitives/datetime-to-string.md)
 - [day](primitives/day.md)
@@ -26,6 +27,7 @@
 - [display](primitives/display.md)
 - [error](primitives/error.md)
 - [eval](primitives/eval.md)
+- [floor](primitives/floor.md)
 - [hour](primitives/hour.md)
 - [hours-diff](primitives/hours-diff.md)
 - [index-of-string](primitives/index-of-string.md)

RainLisp/Docs/primitives/ceiling.md

@@ -0,0 +1,18 @@
+# ceiling
+```scheme
+(ceiling num)
+```
+Rounds a numeric value to the smallest integral that is greater than or equal to it.
+
+> *num* is a numeric value to round.
+
+## Examples
+```scheme
+(ceiling 231.23456)
+```
+-> *232*
+
+```scheme
+(ceiling 231.56789)
+```
+-> *232*

RainLisp/Docs/primitives/floor.md

@@ -0,0 +1,18 @@
+# floor
+```scheme
+(floor num)
+```
+Rounds a numeric value to the largest integral that is less than or equal to it.
+
+> *num* is a numeric value to round.
+
+## Examples
+```scheme
+(floor 231.23456)
+```
+-> *231*
+
+```scheme
+(floor 231.56789)
+```
+-> *231*

RainLisp/Docs/quick-start/numbers.md

@@ -52,6 +52,8 @@ The operations that relate to numbers are:
 - [=](../primitives/equal.md)
 - [>](../primitives/greater.md)
 - [>=](../primitives/greater-or-equal.md)
+- [ceiling](../primitives/ceiling.md)
+- [floor](../primitives/floor.md)
 - [number-to-string](../primitives/number-to-string.md)
 - [parse-number](../primitives/parse-number.md)
 - [round](../primitives/round.md)

RainLisp/Evaluation/PrimitiveOperation.cs

@@ -731,6 +731,26 @@ public static EvaluationResult ParseNumber(EvaluationResult[]? values)
         public static EvaluationResult Round(EvaluationResult[]? values)
             => ApplyBinaryOperator(AsDouble, (val, decimals) => ValueOrThrowInvalid(() => new NumberDatum((double)Math.Round((decimal)val, (int)decimals, MidpointRounding.AwayFromZero))), values);
 
+        /// <summary>
+        /// Rounds a numeric value to the smallest integral that is greater than or equal to it.
+        /// </summary>
+        /// <param name="values">A numeric value to round.</param>
+        /// <returns>The integral numeric value that is greater than or equal to the specified one.</returns>
+        /// <exception cref="WrongNumberOfArgumentsException">The given arguments are not one.</exception>
+        /// <exception cref="WrongTypeOfArgumentException">The argument is not a numeric value.</exception>
+        public static EvaluationResult Ceiling(EvaluationResult[]? values)
+            => ApplyUnaryOperator(AsDouble, val => new NumberDatum(Math.Ceiling(val)), values);
+
+        /// <summary>
+        /// Rounds a numeric value to the largest integral that is less than or equal to it.
+        /// </summary>
+        /// <param name="values">A numeric value to round.</param>
+        /// <returns>The integral numeric value that is less than or equal to the specified one.</returns>
+        /// <exception cref="WrongNumberOfArgumentsException">The given arguments are not one.</exception>
+        /// <exception cref="WrongTypeOfArgumentException">The argument is not a numeric value.</exception>
+        public static EvaluationResult Floor(EvaluationResult[]? values)
+            => ApplyUnaryOperator(AsDouble, val => new NumberDatum(Math.Floor(val)), values);
+
         /// <summary>
         /// Returns a result by evaluating a quote symbol or a non-empty list of quote symbols as user code.
         /// </summary>

RainLisp/Grammar/Primitives.cs

@@ -320,6 +320,16 @@ public static class Primitives
         /// </summary>
         public const string ROUND = "round";
 
+        /// <summary>
+        /// Rounds a numeric value to the smallest integral that is greater than or equal to it.
+        /// </summary>
+        public const string CEILING = "ceiling";
+
+        /// <summary>
+        /// Rounds a numeric value to the largest integral that is less than or equal to it.
+        /// </summary>
+        public const string FLOOR = "floor";
+
         /// <summary>
         /// Returns a result by evaluating a quote symbol or a non-empty list of quote symbols as user code.
         /// </summary>

RainLisp/Interpreter.cs

@@ -336,6 +336,8 @@ void Install(string procedureName, Func<EvaluationResult[]?, EvaluationResult> i
             Install(NUMBER_TO_STRING, PrimitiveOperation.NumberToString);
             Install(PARSE_NUMBER, PrimitiveOperation.ParseNumber);
             Install(ROUND, PrimitiveOperation.Round);
+            Install(CEILING, PrimitiveOperation.Ceiling);
+            Install(FLOOR, PrimitiveOperation.Floor);
 
             _mostRecentGlobalEnvironment.DefineIdentifier(EVAL, new PrimitiveProcedure(EVAL, values => PrimitiveOperation.Eval(values, EvalPrimitiveCallback)));
             _mostRecentGlobalEnvironment.DefineIdentifier(NIL, Nil.GetNil());

RainLisp/RainLisp.csproj

@@ -6,7 +6,7 @@
     <Nullable>enable</Nullable>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <Title>RainLisp a .NET LISP implementation</Title>
-    <Version>1.0.0</Version>
+    <Version>1.1.0</Version>
     <Description>RainLisp a .NET LISP implementation.</Description>
     <Copyright>2023</Copyright>
     <PackageProjectUrl>https://github.com/chr1st0scli/RainLisp</PackageProjectUrl>
@@ -18,7 +18,7 @@
     <Authors>Christos Giamouridis</Authors>
     <Company>Rainsoft</Company>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
-    <PackageReleaseNotes>Initial release.</PackageReleaseNotes>
+    <PackageReleaseNotes>Add ceiling and floor primitive procedures.</PackageReleaseNotes>
   </PropertyGroup>
 
   <ItemGroup>

RainLispTests/EvaluatorErrorTests.cs

@@ -85,7 +85,7 @@ public void Evaluate_CallExpectingOneWithWrongNumberOfArguments_Throws(string ex
                 {
                     "not", "car", "cdr", "null?", "display", "debug", "trace", "error", "string-length", "to-lower", "to-upper",
                     "year", "month", "day", "hour", "minute", "second", "millisecond", "utc?", "to-local", "to-utc", "parse-number",
-                    "eval", "pair?"
+                    "eval", "pair?", "ceiling", "floor"
                 }, expression, expected, false, actual);
         }
 
@@ -218,6 +218,21 @@ public void Evaluate_CallExpectingNumbersOrStringsWithWrongTypeOfArgument_Throws
             Evaluate_CallsWithWrongExpression_Throws(new[] { "+" }, expression, actual, expected);
         }
 
+        [Theory]
+        [InlineData("({0} \"hi\")", typeof(StringDatum))]
+        [InlineData("({0} false)", typeof(BoolDatum))]
+        [InlineData("({0} true)", typeof(BoolDatum))]
+        [InlineData("({0} nil)", typeof(Nil))]
+        [InlineData("({0} (cons 1 2))", typeof(Pair))]
+        [InlineData("({0} (lambda(x) x))", typeof(UserProcedure))]
+        [InlineData("({0} -)", typeof(PrimitiveProcedure))]
+        [InlineData("({0} (now))", typeof(DateTimeDatum))]
+        [InlineData("({0} (newline))", typeof(Unspecified))]
+        public void Evaluate_CallExpectingNumberWithWrongTypeOfArgument_Throws(string expression, Type actual)
+        {
+            Evaluate_CallsWithWrongExpression_Throws(new[] { "ceiling", "floor" }, expression, actual, typeof(NumberDatum));
+        }
+
         [Theory]
         [InlineData("({0} \"hi\" 1)", typeof(StringDatum))]
         [InlineData("({0} 1 \"hi\")", typeof(StringDatum))]

RainLispTests/EvaluatorTests.cs

@@ -104,6 +104,16 @@ public void Evaluate_StringLiteral_Correctly(string expression, string expectedR
         [InlineData("(round 2.4 0)", 2d)]
         [InlineData("(round 21.423 2)", 21.42d)]
         [InlineData("(round 21.425 2)", 21.43d)]
+        [InlineData("(ceiling 2)", 2d)]
+        [InlineData("(ceiling 2.5)", 3d)]
+        [InlineData("(ceiling 2.4)", 3d)]
+        [InlineData("(ceiling 21.423)", 22d)]
+        [InlineData("(ceiling 21.825)", 22d)]
+        [InlineData("(floor 2)", 2d)]
+        [InlineData("(floor 2.5)", 2d)]
+        [InlineData("(floor 2.4)", 2d)]
+        [InlineData("(floor 21.423)", 21d)]
+        [InlineData("(floor 21.825)", 21d)]
         public void Evaluate_NumericExpression_Correctly(string expression, double expectedResult)
         {
             // Arrange