Updated to version 0.1.8 (Under Development)

Author: tony-aw

R/aaa00_broadcast_help.R

@@ -79,7 +79,9 @@
 #' \link[=sd_lc]{simple linear algebra functions for statistics}. \cr
 #' \cr
 #' And 'broadcast' comes with some helper functions: \cr
-#' \link{bc_dim}, \link{ndim}, \link{lst.ndim}, \link{rep_dim}, \link{vector2array}. \cr \cr
+#' \link{checkNA}, \link{checkNULL}, \cr
+#' \link{bc_dim}, \link{ndim}, \link{lst.ndim}, \link{rep_dim}, \cr
+#' \link{vector2array}. \cr \cr
 #' 
 #' 
 #' @section Supported Structures:

R/linear_algebra_stats.R

@@ -46,23 +46,31 @@ ecumprob <- function(y, sim, eps = 0.0) {
     return(numeric(0L))
   }
 
+  intmax <- 2^31 - 1L
+  
   if(is.null(dim(sim))) {
     message("`sim` is given as a dimensionless vector, and will be treated as a matrix with 1 row and `length(sim)` columns")
   }
   else if(ndim(sim) != 2L) {
     stop("`sim` must be a matrix (or data.frame)")
   }
 
-  if(.nsim(sim) < 500L) {
+  if(.ecp_nsim(sim) < 500L) {
     stop("at least 500 columns of simulated values must be provided")
   }
+  if(.ecp_nsim(sim) >= intmax) {
+    stop("long vectors not supported")
+  }
 
   if(!is.numeric(y) && !is.logical(y)) {
     stop("`y` must be numeric or logical")
   }
   if(!is.null(dim(y))) {
     stop("`y` must be a vector")
   }
+  if(.ecp_nobs(y, sim) > intmax) {
+    stop("long vectors not supported")
+  }
 
   if(!is.numeric(eps) || length(eps) != 1L) {
     stop("`eps` must be a numeric scalar")
@@ -146,11 +154,27 @@ ecumprob <- function(y, sim, eps = 0.0) {
 
 #' @keywords internal
 #' @noRd
-.nsim <- function(x) {
-  if(is.null(dim(x))) {
-    return(length(x))
+.ecp_nsim <- function(sim) {
+  if(is.null(dim(sim))) {
+    return(length(sim))
+  }
+  else {
+    return(ncol(sim))
+  }
+}
+
+#' @keywords internal
+#' @noRd
+.ecp_nobs <- function(y, sim) {
+  if(is.null(dim(sim))) {
+    sim.nobs <- 1L
   }
   else {
-    return(ncol(x))
+    sim.nobs <- nrow(sim)
   }
+  
+  y.nobs <- length(y)
+  
+  nobs <- max(y.nobs, sim.nobs)
+  return(nobs)
 }

broadcast_0.1.8.pdf

@@ -204,7 +204,7 @@ <h1 class="title">Unit Test Coverage Report</h1>
 <p>&nbsp;</p>
 <p>The unit tests employed by the ‘broadcast’ package have a test coverage of over 95%.<br>
 For the sake of transparency, the unit tests coverage report, produced by the <a href="https://github.com/r-lib/covr">covr</a> package, is provided here:</p>
-<pre><code>broadcast Coverage: 96.55%
+<pre><code>broadcast Coverage: 96.51%
 R/internal_typefuns.R: 79.66%
 src/C_arraysize_overflow.c: 85.71%
 src/rcpp_bc_ifelse.cpp: 85.71%
@@ -213,6 +213,7 @@ <h1 class="title">Unit Test Coverage Report</h1>
 src/rcpp_any_nonarray.cpp: 90.00%
 R/hier2dim.R: 90.32%
 src/rcpp_bc_bit.cpp: 91.43%
+R/linear_algebra_stats.R: 92.00%
 R/internal_acast.R: 92.11%
 src/rcpp_hier2dim.cpp: 92.20%
 R/internal_bind.R: 92.31%
@@ -222,7 +223,6 @@ <h1 class="title">Unit Test Coverage Report</h1>
 R/rep_dim.R: 93.33%
 R/broadcaster.R: 93.62%
 R/internal_functions.R: 93.75%
-R/linear_algebra_stats.R: 93.75%
 src/C_make_dcp.c: 93.75%
 src/rcpp_bcRel_bit.cpp: 94.12%
 R/typecast.R: 94.64%

docs/about/g_unit_test_covr.html

@@ -272,8 +272,8 @@ <h2 data-number="2.1" class="anchored" data-anchor-id="regular-arithmetic-operat
 
     <script>
 
-      function styleCell_vut2qfwzzxzm8lsowziq(i, j, css_id) {
-          var table = document.getElementById("tinytable_vut2qfwzzxzm8lsowziq");
+      function styleCell_reut6rq3nqfx9z96j4bu(i, j, css_id) {
+          var table = document.getElementById("tinytable_reut6rq3nqfx9z96j4bu");
           var cell = table.rows[i]?.cells[j];  // Safe navigation to avoid errors
           if (cell) {
               console.log(`Styling cell at (${i}, ${j}) with class ${css_id}`);
@@ -283,16 +283,16 @@ <h2 data-number="2.1" class="anchored" data-anchor-id="regular-arithmetic-operat
           }
       }
       function insertSpanRow(i, colspan, content) {
-        var table = document.getElementById('tinytable_vut2qfwzzxzm8lsowziq');
+        var table = document.getElementById('tinytable_reut6rq3nqfx9z96j4bu');
         var newRow = table.insertRow(i);
         var newCell = newRow.insertCell(0);
         newCell.setAttribute("colspan", colspan);
         // newCell.innerText = content;
         // this may be unsafe, but innerText does not interpret <br>
         newCell.innerHTML = content;
       }
-      function spanCell_vut2qfwzzxzm8lsowziq(i, j, rowspan, colspan) {
-        var table = document.getElementById("tinytable_vut2qfwzzxzm8lsowziq");
+      function spanCell_reut6rq3nqfx9z96j4bu(i, j, rowspan, colspan) {
+        var table = document.getElementById("tinytable_reut6rq3nqfx9z96j4bu");
         const targetRow = table.rows[i];
         const targetCell = targetRow.cells[j];
         for (let r = 0; r < rowspan; r++) {
@@ -322,26 +322,26 @@ <h2 data-number="2.1" class="anchored" data-anchor-id="regular-arithmetic-operat
       window.addEventListener('load', function () {
           var cellsToStyle = [
             // tinytable style arrays after
-          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_vicd8fa2t7spqe4u0mml',}, 
-          { positions: [ { i: 7, j: 0 }, { i: 7, j: 1 }, { i: 7, j: 2 },  ], css_id: 'tinytable_css_pixtxwqho24m79oun7d7',}, 
+          { positions: [ { i: 7, j: 0 }, { i: 7, j: 1 }, { i: 7, j: 2 },  ], css_id: 'tinytable_css_trarlh6z6t33q2w4bjb7',}, 
+          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_632c4tabyx1bke2qibod',}, 
           ];
 
           // Loop over the arrays to style the cells
           cellsToStyle.forEach(function (group) {
               group.positions.forEach(function (cell) {
-                  styleCell_vut2qfwzzxzm8lsowziq(cell.i, cell.j, group.css_id);
+                  styleCell_reut6rq3nqfx9z96j4bu(cell.i, cell.j, group.css_id);
               });
           });
       });
     </script>
 
     <style>
       /* tinytable css entries after */
-      .table td.tinytable_css_vicd8fa2t7spqe4u0mml, .table th.tinytable_css_vicd8fa2t7spqe4u0mml { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
-      .table td.tinytable_css_pixtxwqho24m79oun7d7, .table th.tinytable_css_pixtxwqho24m79oun7d7 { border-bottom: solid #d3d8dc 0.1em; }
+      .table td.tinytable_css_trarlh6z6t33q2w4bjb7, .table th.tinytable_css_trarlh6z6t33q2w4bjb7 { border-bottom: solid #d3d8dc 0.1em; }
+      .table td.tinytable_css_632c4tabyx1bke2qibod, .table th.tinytable_css_632c4tabyx1bke2qibod { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
     </style>
     <div class="container">
-      <table class="table table-borderless" id="tinytable_vut2qfwzzxzm8lsowziq" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
+      <table class="table table-borderless" id="tinytable_reut6rq3nqfx9z96j4bu" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
         <thead>
 
               <tr>
@@ -405,8 +405,8 @@ <h2 data-number="2.2" class="anchored" data-anchor-id="complex-arithmetic-operat
 
     <script>
 
-      function styleCell_bkv1q093th12zd3pcqyf(i, j, css_id) {
-          var table = document.getElementById("tinytable_bkv1q093th12zd3pcqyf");
+      function styleCell_799q35p7q139atpkre5m(i, j, css_id) {
+          var table = document.getElementById("tinytable_799q35p7q139atpkre5m");
           var cell = table.rows[i]?.cells[j];  // Safe navigation to avoid errors
           if (cell) {
               console.log(`Styling cell at (${i}, ${j}) with class ${css_id}`);
@@ -416,16 +416,16 @@ <h2 data-number="2.2" class="anchored" data-anchor-id="complex-arithmetic-operat
           }
       }
       function insertSpanRow(i, colspan, content) {
-        var table = document.getElementById('tinytable_bkv1q093th12zd3pcqyf');
+        var table = document.getElementById('tinytable_799q35p7q139atpkre5m');
         var newRow = table.insertRow(i);
         var newCell = newRow.insertCell(0);
         newCell.setAttribute("colspan", colspan);
         // newCell.innerText = content;
         // this may be unsafe, but innerText does not interpret <br>
         newCell.innerHTML = content;
       }
-      function spanCell_bkv1q093th12zd3pcqyf(i, j, rowspan, colspan) {
-        var table = document.getElementById("tinytable_bkv1q093th12zd3pcqyf");
+      function spanCell_799q35p7q139atpkre5m(i, j, rowspan, colspan) {
+        var table = document.getElementById("tinytable_799q35p7q139atpkre5m");
         const targetRow = table.rows[i];
         const targetCell = targetRow.cells[j];
         for (let r = 0; r < rowspan; r++) {
@@ -455,26 +455,26 @@ <h2 data-number="2.2" class="anchored" data-anchor-id="complex-arithmetic-operat
       window.addEventListener('load', function () {
           var cellsToStyle = [
             // tinytable style arrays after
-          { positions: [ { i: 4, j: 0 }, { i: 4, j: 1 }, { i: 4, j: 2 },  ], css_id: 'tinytable_css_fxy7kj71njfu0ni23wrl',}, 
-          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_2e5ndbferf280d651b3m',}, 
+          { positions: [ { i: 4, j: 0 }, { i: 4, j: 1 }, { i: 4, j: 2 },  ], css_id: 'tinytable_css_nkznb59bct5rfuizrl3n',}, 
+          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_5ux76j1oos0z554ufpog',}, 
           ];
 
           // Loop over the arrays to style the cells
           cellsToStyle.forEach(function (group) {
               group.positions.forEach(function (cell) {
-                  styleCell_bkv1q093th12zd3pcqyf(cell.i, cell.j, group.css_id);
+                  styleCell_799q35p7q139atpkre5m(cell.i, cell.j, group.css_id);
               });
           });
       });
     </script>
 
     <style>
       /* tinytable css entries after */
-      .table td.tinytable_css_fxy7kj71njfu0ni23wrl, .table th.tinytable_css_fxy7kj71njfu0ni23wrl { border-bottom: solid #d3d8dc 0.1em; }
-      .table td.tinytable_css_2e5ndbferf280d651b3m, .table th.tinytable_css_2e5ndbferf280d651b3m { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
+      .table td.tinytable_css_nkznb59bct5rfuizrl3n, .table th.tinytable_css_nkznb59bct5rfuizrl3n { border-bottom: solid #d3d8dc 0.1em; }
+      .table td.tinytable_css_5ux76j1oos0z554ufpog, .table th.tinytable_css_5ux76j1oos0z554ufpog { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
     </style>
     <div class="container">
-      <table class="table table-borderless" id="tinytable_bkv1q093th12zd3pcqyf" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
+      <table class="table table-borderless" id="tinytable_799q35p7q139atpkre5m" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
         <thead>
 
               <tr>
@@ -523,8 +523,8 @@ <h2 data-number="2.3" class="anchored" data-anchor-id="logical-operators"><span
 
     <script>
 
-      function styleCell_ul7qtlwuxsmdwevqemss(i, j, css_id) {
-          var table = document.getElementById("tinytable_ul7qtlwuxsmdwevqemss");
+      function styleCell_49uf2h84pwbc1ic63yhi(i, j, css_id) {
+          var table = document.getElementById("tinytable_49uf2h84pwbc1ic63yhi");
           var cell = table.rows[i]?.cells[j];  // Safe navigation to avoid errors
           if (cell) {
               console.log(`Styling cell at (${i}, ${j}) with class ${css_id}`);
@@ -534,16 +534,16 @@ <h2 data-number="2.3" class="anchored" data-anchor-id="logical-operators"><span
           }
       }
       function insertSpanRow(i, colspan, content) {
-        var table = document.getElementById('tinytable_ul7qtlwuxsmdwevqemss');
+        var table = document.getElementById('tinytable_49uf2h84pwbc1ic63yhi');
         var newRow = table.insertRow(i);
         var newCell = newRow.insertCell(0);
         newCell.setAttribute("colspan", colspan);
         // newCell.innerText = content;
         // this may be unsafe, but innerText does not interpret <br>
         newCell.innerHTML = content;
       }
-      function spanCell_ul7qtlwuxsmdwevqemss(i, j, rowspan, colspan) {
-        var table = document.getElementById("tinytable_ul7qtlwuxsmdwevqemss");
+      function spanCell_49uf2h84pwbc1ic63yhi(i, j, rowspan, colspan) {
+        var table = document.getElementById("tinytable_49uf2h84pwbc1ic63yhi");
         const targetRow = table.rows[i];
         const targetCell = targetRow.cells[j];
         for (let r = 0; r < rowspan; r++) {
@@ -573,26 +573,26 @@ <h2 data-number="2.3" class="anchored" data-anchor-id="logical-operators"><span
       window.addEventListener('load', function () {
           var cellsToStyle = [
             // tinytable style arrays after
-          { positions: [ { i: 2, j: 0 }, { i: 2, j: 1 }, { i: 2, j: 2 },  ], css_id: 'tinytable_css_qr7h3a2n8efgkiq408tc',}, 
-          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_p7y17jmubcjh8ha7zn48',}, 
+          { positions: [ { i: 2, j: 0 }, { i: 2, j: 1 }, { i: 2, j: 2 },  ], css_id: 'tinytable_css_sd5qptc5rk71qshsk8pz',}, 
+          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_e7o1jwaujwtquh1q690u',}, 
           ];
 
           // Loop over the arrays to style the cells
           cellsToStyle.forEach(function (group) {
               group.positions.forEach(function (cell) {
-                  styleCell_ul7qtlwuxsmdwevqemss(cell.i, cell.j, group.css_id);
+                  styleCell_49uf2h84pwbc1ic63yhi(cell.i, cell.j, group.css_id);
               });
           });
       });
     </script>
 
     <style>
       /* tinytable css entries after */
-      .table td.tinytable_css_qr7h3a2n8efgkiq408tc, .table th.tinytable_css_qr7h3a2n8efgkiq408tc { border-bottom: solid #d3d8dc 0.1em; }
-      .table td.tinytable_css_p7y17jmubcjh8ha7zn48, .table th.tinytable_css_p7y17jmubcjh8ha7zn48 { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
+      .table td.tinytable_css_sd5qptc5rk71qshsk8pz, .table th.tinytable_css_sd5qptc5rk71qshsk8pz { border-bottom: solid #d3d8dc 0.1em; }
+      .table td.tinytable_css_e7o1jwaujwtquh1q690u, .table th.tinytable_css_e7o1jwaujwtquh1q690u { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
     </style>
     <div class="container">
-      <table class="table table-borderless" id="tinytable_ul7qtlwuxsmdwevqemss" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
+      <table class="table table-borderless" id="tinytable_49uf2h84pwbc1ic63yhi" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
         <thead>
 
               <tr>
@@ -631,8 +631,8 @@ <h2 data-number="2.4" class="anchored" data-anchor-id="bit-wise-operators"><span
 
     <script>
 
-      function styleCell_b695q5asxidfoyfipc3r(i, j, css_id) {
-          var table = document.getElementById("tinytable_b695q5asxidfoyfipc3r");
+      function styleCell_ckl8o2gdhex01cj18zne(i, j, css_id) {
+          var table = document.getElementById("tinytable_ckl8o2gdhex01cj18zne");
           var cell = table.rows[i]?.cells[j];  // Safe navigation to avoid errors
           if (cell) {
               console.log(`Styling cell at (${i}, ${j}) with class ${css_id}`);
@@ -642,16 +642,16 @@ <h2 data-number="2.4" class="anchored" data-anchor-id="bit-wise-operators"><span
           }
       }
       function insertSpanRow(i, colspan, content) {
-        var table = document.getElementById('tinytable_b695q5asxidfoyfipc3r');
+        var table = document.getElementById('tinytable_ckl8o2gdhex01cj18zne');
         var newRow = table.insertRow(i);
         var newCell = newRow.insertCell(0);
         newCell.setAttribute("colspan", colspan);
         // newCell.innerText = content;
         // this may be unsafe, but innerText does not interpret <br>
         newCell.innerHTML = content;
       }
-      function spanCell_b695q5asxidfoyfipc3r(i, j, rowspan, colspan) {
-        var table = document.getElementById("tinytable_b695q5asxidfoyfipc3r");
+      function spanCell_ckl8o2gdhex01cj18zne(i, j, rowspan, colspan) {
+        var table = document.getElementById("tinytable_ckl8o2gdhex01cj18zne");
         const targetRow = table.rows[i];
         const targetCell = targetRow.cells[j];
         for (let r = 0; r < rowspan; r++) {
@@ -681,26 +681,26 @@ <h2 data-number="2.4" class="anchored" data-anchor-id="bit-wise-operators"><span
       window.addEventListener('load', function () {
           var cellsToStyle = [
             // tinytable style arrays after
-          { positions: [ { i: 2, j: 0 }, { i: 2, j: 1 }, { i: 2, j: 2 },  ], css_id: 'tinytable_css_bf6yubde2t4bab7e7jb9',}, 
-          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_8o3ltu0459mtm7y0bxh1',}, 
+          { positions: [ { i: 2, j: 0 }, { i: 2, j: 1 }, { i: 2, j: 2 },  ], css_id: 'tinytable_css_ptkl3ggmpftmhbpoae5s',}, 
+          { positions: [ { i: 0, j: 0 }, { i: 0, j: 1 }, { i: 0, j: 2 },  ], css_id: 'tinytable_css_cxjgpvdijc2z4kvz8wvz',}, 
           ];
 
           // Loop over the arrays to style the cells
           cellsToStyle.forEach(function (group) {
               group.positions.forEach(function (cell) {
-                  styleCell_b695q5asxidfoyfipc3r(cell.i, cell.j, group.css_id);
+                  styleCell_ckl8o2gdhex01cj18zne(cell.i, cell.j, group.css_id);
               });
           });
       });
     </script>
 
     <style>
       /* tinytable css entries after */
-      .table td.tinytable_css_bf6yubde2t4bab7e7jb9, .table th.tinytable_css_bf6yubde2t4bab7e7jb9 { border-bottom: solid #d3d8dc 0.1em; }
-      .table td.tinytable_css_8o3ltu0459mtm7y0bxh1, .table th.tinytable_css_8o3ltu0459mtm7y0bxh1 { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
+      .table td.tinytable_css_ptkl3ggmpftmhbpoae5s, .table th.tinytable_css_ptkl3ggmpftmhbpoae5s { border-bottom: solid #d3d8dc 0.1em; }
+      .table td.tinytable_css_cxjgpvdijc2z4kvz8wvz, .table th.tinytable_css_cxjgpvdijc2z4kvz8wvz { border-top: solid #d3d8dc 0.1em; border-bottom: solid #d3d8dc 0.05em; }
     </style>
     <div class="container">
-      <table class="table table-borderless" id="tinytable_b695q5asxidfoyfipc3r" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
+      <table class="table table-borderless" id="tinytable_ckl8o2gdhex01cj18zne" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
         <thead>
 
               <tr>

docs/about/h_technical_details.html

@@ -430,7 +430,7 @@ <h3 class="anchored" data-anchor-id="functions">Functions</h3>
 <p><a href="../man/bc_strrep.html">bc_strrep</a>: Broadcasted version of strrep. <br> <br></p>
 </li>
 </ul>
-<p><b>Other functions</b> <br> ‘broadcast’ provides <a href="../man/typecast.html">type-casting</a> functions, which preserve names and dimensions - convenient for arrays. <br> <br> ‘broadcast’ also provides <a href="../man/linear_algebra_stats.html">simple linear algebra functions for statistics</a>. <br> <br> And ‘broadcast’ comes with some helper functions: <br> <a href="../man/bc_dim.html">bc_dim</a>, <a href="../man/ndim.html">ndim</a>, <a href="../man/ndim.html">lst.ndim</a>, <a href="../man/rep_dim.html">rep_dim</a>, <a href="../man/vector2array.html">vector2array</a>. <br> <br></p>
+<p><b>Other functions</b> <br> ‘broadcast’ provides <a href="../man/typecast.html">type-casting</a> functions, which preserve names and dimensions - convenient for arrays. <br> <br> ‘broadcast’ also provides <a href="../man/linear_algebra_stats.html">simple linear algebra functions for statistics</a>. <br> <br> And ‘broadcast’ comes with some helper functions: <br> <a href="../man/checkmissing.html">checkNA</a>, <a href="../man/checkmissing.html">checkNULL</a>, <br> <a href="../man/bc_dim.html">bc_dim</a>, <a href="../man/ndim.html">ndim</a>, <a href="../man/ndim.html">lst.ndim</a>, <a href="../man/rep_dim.html">rep_dim</a>, <br> <a href="../man/vector2array.html">vector2array</a>. <br> <br></p>
 </section>
 <section id="supported-structures" class="level3">
 <h3 class="anchored" data-anchor-id="supported-structures">Supported Structures</h3>