docs: finished comments for order api

halcwb · Nov 3, 2023 · c9b4ae8 · c9b4ae8
1 parent ed937a9
commit c9b4ae8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 29 deletions.
diff --git a/src/Informedica.GenOrder.Lib/Api.fs b/src/Informedica.GenOrder.Lib/Api.fs
@@ -1,7 +1,6 @@
 namespace Informedica.GenOrder.Lib
 
 
-
 module Api =
 
     open MathNet.Numerics
@@ -276,6 +275,15 @@ module Api =
     let increaseIncrements logger ord = Order.increaseIncrements logger 10N 50N ord
 
 
+    /// <summary>
+    /// Evaluate a PrescriptionRule. The PrescriptionRule can result in
+    /// multiple Orders, depending on the SolutionRules.
+    /// </summary>
+    /// <param name="logger"></param>
+    /// <param name="rule"></param>
+    /// <returns>
+    /// An array of Results, containing the Order and the PrescriptionRule.
+    /// </returns>
     let evaluate logger (rule : PrescriptionRule) =
         let rec solve retry sr pr =
             pr
@@ -348,29 +356,9 @@ module Api =
             |> Array.map (fun sr -> solve true (Some sr) rule)
 
 
-    // print an order list
-    let toScenarios ind sn (ords : Order[]) =
-        ords
-        |> Array.mapi (fun i o ->
-            o
-            |> Order.Print.printOrderToString sn
-            |> fun (pres, prep, adm) ->
-                {
-                    No = i
-                    Indication = ind
-                    DoseType = ""
-                    Name = o.Orderable.Name |> Informedica.GenSolver.Lib.Variable.Name.toString
-                    Shape = o.Orderable.Components[0].Shape
-                    Route = o.Route
-                    Prescription = pres
-                    Preparation = prep
-                    Administration = adm
-                    Order = Some o
-                }
-        )
-
-
-
+    /// <summary>
+    /// Create an initial ScenarioResult for a Patient.
+    /// </summary>
     let scenarioResult pat =
         let rules = pat |> PrescriptionRule.get
         {
@@ -395,9 +383,11 @@ module Api =
         |> String.replace ">" ""
 
 
+    /// <summary>
+    /// Use a Filter and a ScenarioResult to create a new ScenarioResult.
+    /// </summary>
     let filter (sc : ScenarioResult) =
 
-
         if Env.getItem "GENPRES_PROD" |> Option.isNone then
             let path = $"{__SOURCE_DIRECTORY__}/log.txt"
             OrderLogger.logger.Start (Some path) OrderLogger.Level.Informative

diff --git a/src/Informedica.GenSolver.Lib/Api.fs b/src/Informedica.GenSolver.Lib/Api.fs
@@ -1,7 +1,7 @@
 namespace Informedica.GenSolver.Lib
 
 
-/// Public funtions to use the library
+/// Public functions to use the library
 module Api =
 
     open System
@@ -63,9 +63,6 @@ module Api =
     /// <summary>
     /// Solve an `Equations` list
     /// </summary>
-    /// <param name="onlyMinIncrMax">True if only min, incr and max values are to be used</param>
-    /// <param name="log">The logger to log operations</param>
-    /// <param name="eqs">List of equations to solve</param>
     /// <returns>A result type of the solved equations</returns>
     /// <remarks>
     /// This function is a wrapper around `Solver.solveAll`