Skip to content

Commit 524b0ff

Browse files
committed
docs: add use cases and notes
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent de5763c commit 524b0ff

File tree

4 files changed

+20
-4
lines changed

4 files changed

+20
-4
lines changed

lib/node_modules/@stdlib/ndarray/input-casting-policies/README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ var out = policies();
5151

5252
The output array contains the following policies:
5353

54-
- `none`: do not cast an input ndarray.
54+
- `none`: no guidance on specific casting behavior. An input ndarray may or may not be cast depending on the needs of an implementation.
5555
- `promoted`: cast an input ndarray to a promoted data type.
5656
- `accumulation`: cast an input ndarray to a data type amenable to accumulation.
5757
- `output`: cast an input ndarray to the data type of the output ndarray.
@@ -64,6 +64,17 @@ The output array contains the following policies:
6464

6565
<section class="notes">
6666

67+
## Notes
68+
69+
- The following is some general guidance for the casting policies listed above:
70+
71+
- **none**: applies whenever an input ndarray casting behavior should be entirely left up to an implementation. For example, an implementation may choose to cast internally in order to take advantage of specialized algorithms operating on specific data types.
72+
- **promoted**: applies whenever an input ndarray should be cast to the data type resolved from applying the rules of [type promotion][@stdlib/ndarray/promotion-rules] to an implementation's input and output ndarrays. For example, suppose an implementation is computing the sum and the data type of the input ndarray is `int32` and the data type of the output ndarray is `float32`. In this scenario, casting `int32` to `float32` is not desirable as not all `int32` values can be safely represented in `float32`, thus potentially leading to significant accumulated numerical error. Instead, we can promote `int32` to `float64`, compute the sum, and then downcast the result for more accurate summation.
73+
- **accumulation**: applies whenever an input ndarray should be cast to a data type amenable to accumulation, irrespective of the output ndarray or other input ndarrays. For example, suppose an implementation is computing the sum and determining whether the sum passes a threshold, and further suppose that the data type of the input ndarray is `int8` and the data type of the output ndarray is `bool`. In this scenario, as `int8` has a small range of values, computing the sum has a high risk of overflow, rending the results potentially meaningless, and type promotion is not applicable. As such, an implementation may prefer to internally cast `int8` to a data type more amenable to accumulation, such as `int32`.
74+
- **output**: applies whenever an input ndarray should always be cast to the data type of the output ndarray. This might apply whenever an implementation wraps a type homogeneous interface, such as those commonly found in BLAS/LAPACK routines.
75+
76+
- Whether an implementation supports a casting policy depends on the implementation. Supporting casting policies is mainly envisioned for generalized utilities wrapping lower-level APIs and needing to accommodate varied use cases (e.g., [`@stdlib/ndarray/base/unary-reduce-strided1d-dispatch`][@stdlib/ndarray/base/unary-reduce-strided1d-dispatch]). Exposing casting policies as part of user-facing APIs is generally not a good idea.
77+
6778
</section>
6879

6980
<!-- /.notes -->
@@ -126,6 +137,10 @@ bool = isPolicy( 'beep' );
126137

127138
<section class="links">
128139

140+
[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules
141+
142+
[@stdlib/ndarray/base/unary-reduce-strided1d-dispatch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-strided1d-dispatch
143+
129144
</section>
130145

131146
<!-- /.links -->

lib/node_modules/@stdlib/ndarray/input-casting-policies/docs/repl.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
The output array contains the following policies:
66

7-
- none: do not cast an input ndarray.
7+
- none: no guidance on specific casting behavior. An input ndarray may or
8+
may not be cast depending on the needs of an implementation.
89
- promoted: cast an input ndarray to a promoted data type.
910
- accumulation: cast an input ndarray to a data type amenable to
1011
accumulation.

lib/node_modules/@stdlib/ndarray/input-casting-policies/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ type Policies = [
3535
*
3636
* - The output array contains the following policies:
3737
*
38-
* - `none`: do not cast an input ndarray.
38+
* - `none`: no guidance on specific casting behavior. An input ndarray may or may not be cast depending on the needs of an implementation.
3939
* - `promoted`: cast an input ndarray to a promoted data type.
4040
* - `accumulation`: cast an input ndarray to a data type amenable to accumulation.
4141
* - `output`: cast an input ndarray to the data type of the output ndarray.

lib/node_modules/@stdlib/ndarray/input-casting-policies/include/stdlib/ndarray/input_casting_policies.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ extern "C" {
3030
* Enumeration of input ndarray casting policies.
3131
*/
3232
enum STDLIB_NDARRAY_INPUT_CASTING_POLICY {
33-
// Do not cast an input ndarray:
33+
// No guidance on specific casting behavior, as an input ndarray may or may not be cast depending on the needs of an implementation:
3434
STDLIB_NDARRAY_INPUT_CASTING_POLICY_NONE = 0,
3535

3636
// Cast an input ndarray to a promoted data type:

0 commit comments

Comments
 (0)