feat: Check status errors

Check returned status in running stats functions

Author: fraya

doc/source/gsl-ffi-running-statistics.rst

@@ -4,15 +4,15 @@ The GSL-FFI-RUNNING-STATISTICS module
 .. current-library:: dylan-gsl
 .. current-module:: gsl-ffi-running-statistics
 
-Classes
-=======
+Running statistics
+==================
 
 .. class:: <gsl-rstat-workspace>
 
   Accumulator used to store the running statistics.
 
 Initializing the Accumulator
-============================
+----------------------------
 
 .. function:: gsl-rstat-alloc
 
@@ -36,23 +36,26 @@ Initializing the Accumulator
 
 .. function:: gsl-rstat-reset
 
-   :signature: gsl-rstat-reset (workspace) => ()
+   :signature: gsl-rstat-reset (workspace) => (status)
 
    :parameter workspace: An instance of :class:`<gsl-rstat-workspace*>`.
+   :value status: An instance of :class:`<c-int>`                         
 
    :description: 
 
      Reset a :class:`<gsl-rstat-workspace>`.
 
 Adding Data to the Accumulator
-==============================
+------------------------------
 
 .. function:: gsl-rstat-add
 
    :signature: gsl-rstat-add (workspace x) => (status)
 
    :parameter workspace: An instance of :class:`<gsl-rstat-workspace*>`.
-   :parameter x: An instance of :class:`<double-float>`. 
+   :parameter x: An instance of :class:`<c-double>`.
+   :value status: An instance of :class:`<c-int>`.                 
+                 
 
    :description: 
 
@@ -70,7 +73,7 @@ Adding Data to the Accumulator
      Get the number of values so far added to the :class:`<gsl-rstat-workspace>`.
 
 Current Statistics
-==================
+------------------
 
 .. function:: gsl-rstat-min
 
@@ -180,4 +183,71 @@ Current Statistics
 
    :description: 
 
-     Get the norm value so far added to the :class:`<gsl-rstat-workspace>`.
+     Get the norm value so far added to the :class:`<gsl-rstat-workspace>`.
+
+Quantiles
+=========
+
+.. class:: <gsl-rstat-quantile>
+
+  Accumulator used to store the running quantiles.
+
+Initializing the Accumulator
+----------------------------
+
+.. function:: gsl-rstat-quantile-alloc
+
+  :signature: gsl-rstat-quantile-alloc (p) => (quantile)
+
+  :parameter p: The quantile to compute. 
+  :value quantile: An instance of :class:`<gsl-rstat-quantile*>`. 
+
+.. function:: gsl-rstat-quantile-free
+
+  :signature: gsl-rstat-quantile-free (quantile) => ()
+
+  :parameter quantile: An instance of :class:`<gsl-rstat-quantile*>`. 
+
+  :description: 
+
+    Free a :class:`<gsl-rstat-quantile*>`.
+
+.. function:: gsl-rstat-quantile-reset
+
+  :signature: gsl-rstat-quantile-reset (quantile) => (status)
+
+  :parameter quantile: An instance of :class:`<gsl-rstat-quantile*>`.
+  :value status: An instance of :class:`<c-int>`.
+
+  :description: 
+
+    Reset a :class:`<gsl-rstat-quantile*>`.
+
+Adding Data to the Accumulator
+------------------------------
+
+.. function:: gsl-rstat-quantile-add
+
+  :signature: gsl-rstat-quantile-add (x quantile) => (status)
+
+  :parameter x: An instance of :class:`<c-double>`.
+  :parameter quantile: An instance of :class:`<gsl-rstat-quantile*>`.
+  :value status: An instance of :class:`<c-int>`.
+
+  :description: 
+
+    Add a new value to the :class:`<gsl-rstat-quantile*>`.
+
+Current Statistics
+------------------
+
+.. function:: gsl-rstat-quantile-get
+
+  :signature: gsl-rstat-quantile-get (quantile) => (quantile)
+
+  :parameter quantile: An instance of :class:`<gsl-rstat-quantile*>`.
+  :value quantile: The quantile value in the accumulator.
+
+  :description: 
+
+    Get the quantile value so far added to the :class:`<gsl-rstat-quantile*>`.

src/lib/ffi/running-statistics.dylan

@@ -33,6 +33,7 @@ end;
 
 define c-function gsl-rstat-reset
   input parameter workspace :: <gsl-rstat-workspace*>;
+  result status :: <c-int>;
   c-name: "gsl_rstat_reset";
 end;
 
@@ -47,6 +48,7 @@ end;
 define c-function gsl-rstat-add
   input parameter workspace :: <gsl-rstat-workspace*>;
   input parameter x :: <c-double>;
+  result status :: <c-int>;
   c-name: "gsl_rstat_add";
 end;
 

src/lib/gsl/error/module.dylan

@@ -53,8 +53,9 @@ define module gsl-error-impl
 
   use common-dylan;
   use c-ffi;
-  use gsl-ffi-error;
+  use gsl-ffi-error,
+    export: { $gsl-success };
 
   use gsl-error;
 
-end module;
+end module;

src/lib/gsl/module-running-statistics.dylan

@@ -45,6 +45,8 @@ define module gsl-running-statistics-impl
   use common-dylan;
   use c-ffi;
   use gsl-error;
+  use gsl-error-impl,
+    import: { $gsl-success };
 
   use gsl-ffi-running-statistics,
     prefix: "ffi/";

src/lib/gsl/running-statistics.dylan

@@ -28,7 +28,10 @@ end;
 
 define function rstat-reset!
   (rstat :: <rstat>) => ()
-  ffi/gsl-rstat-reset(rstat.%rstat-workspace)
+  let status = ffi/gsl-rstat-reset(rstat.%rstat-workspace);
+  if (status ~= $gsl-success)
+    error(make(<gsl-error>, code: status))
+  end
 end;
 
 define method size
@@ -42,7 +45,10 @@ define generic rstat-add!
 define method rstat-add!
    (rstat :: <rstat>, x :: <double-float>) 
 => ()
-  ffi/gsl-rstat-add(rstat.%rstat-workspace, x)
+  let status = ffi/gsl-rstat-add(rstat.%rstat-workspace, x);
+  if (status ~= $gsl-success)
+    error(make(<gsl-error>, code: status))
+  end
 end;
 
 define method rstat-add!
@@ -127,15 +133,21 @@ end;
 
 define function quantile-rstat-reset!
   (quantile-rstat :: <quantile-rstat>) => ()
-  ffi/gsl-rstat-quantile-reset(quantile-rstat.%quantile-rstat-workspace)
+  let status = ffi/gsl-rstat-quantile-reset(quantile-rstat.%quantile-rstat-workspace);
+  if (status ~= $gsl-success)
+    error(make(<gsl-error>, code: status))
+  end
 end;
 
 define generic quantile-rstat-add!
   (quantile-rstat :: <quantile-rstat>, x :: <object>) => ();
 
 define method quantile-rstat-add!
   (quantile-rstat :: <quantile-rstat>, x :: <double-float>) => ()
-  ffi/gsl-rstat-quantile-add(x, quantile-rstat.%quantile-rstat-workspace)
+  let status = ffi/gsl-rstat-quantile-add(x, quantile-rstat.%quantile-rstat-workspace);
+  if (status ~= $gsl-success)
+    error(make(<gsl-error>, code: status))
+  end
 end;
 
 define method quantile-rstat-add!