feat: add boolean dtype support to strided/base/mskunary

PR-URL: #2520 Ref: #2500 Reviewed-by: Athan Reines <[email protected]>
stdlib-js · Jul 6, 2024 · dc36936 · dc36936 · stdlib-bot · Jul 6, 2024
1 parent 441d61c
commit dc36936
Show file tree

Hide file tree

Showing 295 changed files with 456 additions and 290 deletions.
diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/README.md b/lib/node_modules/@stdlib/strided/base/mskunary/README.md
@@ -202,6 +202,7 @@ Character codes for data types:
 
 <!-- charcodes -->
 
+-   **x**: `bool` (boolean).
 -   **c**: `complex64` (single-precision floating-point complex number).
 -   **z**: `complex128` (double-precision floating-point complex number).
 -   **f**: `float32` (single-precision floating-point number).
@@ -6149,6 +6150,48 @@ The function accepts the following arguments:
 void stdlib_strided_mask_u_z_as_z_z( uint8_t *arrays[], const int64_t *shape, const int64_t *strides, void *fcn );
 ```
 
+#### stdlib_strided_mask_x_x( \*arrays\[], \*shape, \*strides, \*fcn )
+
+Applies a unary callback to strided input array elements according to a strided mask array and assigns results to elements in a strided output array.
+
+```c
+#include <stdbool.h>
+#include <stdint.h>
+
+// Create underlying byte arrays:
+uint8_t x[] = { 0, 0, 0 };
+uint8_t m[] = { 0, 0, 0 };
+uint8_t out[] = { 0, 0, 0 };
+
+// Define a pointer to an array containing pointers to strided arrays:
+uint8_t *arrays[] = { x, m, out };
+
+// Define the strides:
+int64_t strides[] = { 1, 1, 1 };
+
+// Define the number of elements over which to iterate:
+int64_t shape[] = { 3 };
+
+// Define a callback:
+static bool fcn( bool x ) {
+    return x;
+}
+
+// Apply the callback:
+stdlib_strided_mask_x_x( arrays, shape, strides, (void *)fcn );
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: `[inout] uint8_t**` array whose first element is a pointer to a strided input array, whose second element is a pointer to a strided mask array, and whose last element is a pointer to a strided output array.
+-   **shape**: `[in] int64_t*` array whose only element is the number of elements over which to iterate.
+-   **strides**: `[in] int64_t*` array containing strides (in bytes) for each strided array.
+-   **fcn**: `[in] void*` a `bool (*f)(bool)` function to apply provided as a `void` pointer.
+
+```c
+void stdlib_strided_mask_x_x( uint8_t *arrays[], const int64_t *shape, const int64_t *strides, void *fcn );
+```
+
 #### stdlib_strided_mask_z_d_as_z_d( \*arrays\[], \*shape, \*strides, \*fcn )
 
 Applies a unary callback to strided input array elements according to a strided mask array and assigns results to elements in a strided output array.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary.h
@@ -178,6 +178,8 @@
 #include "mskunary/u_z_as_u_z.h"
 #include "mskunary/u_z_as_z_z.h"
 
+#include "mskunary/x_x.h"
+
 #include "mskunary/z_d_as_z_d.h"
 #include "mskunary/z_z.h"
 // END LOOPS

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_b.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_b.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_b_as_u_u.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_b_as_u_u.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c_as_b_c.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c_as_b_c.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c_as_c_c.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c_as_c_c.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c_as_z_z.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_c_as_z_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_d.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_d.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_d_as_b_d.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_d_as_b_d.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_d_as_d_d.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_d_as_d_d.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f_as_b_f.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f_as_b_f.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f_as_d_d.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f_as_d_d.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f_as_f_f.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_f_as_f_f.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_i.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_i.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_i_as_b_i.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_i_as_b_i.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_i_as_i_i.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_i_as_i_i.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k_as_b_k.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k_as_b_k.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k_as_i_i.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k_as_i_i.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k_as_k_k.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_k_as_k_k.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t_as_b_t.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t_as_b_t.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t_as_t_t.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t_as_t_t.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t_as_u_u.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_t_as_u_u.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_u.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_u.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_u_as_b_u.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_u_as_b_u.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_u_as_u_u.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_u_as_u_u.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_z.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_z_as_b_z.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_z_as_b_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_z_as_z_z.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/b_z_as_z_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_c.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_c.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_c_as_z_z.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_c_as_z_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_f_as_c_f.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_f_as_c_f.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_z.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_z_as_c_z.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_z_as_c_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_z_as_z_z.h b/...e_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/c_z_as_z_z.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/d_d.h b/lib/node_modules/@stdlib/strided/base/mskunary/include/stdlib/strided/base/mskunary/d_d.h
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.