Skip to content

Commit 7475400

Browse files
committed
docs: move content to 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: na - 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 e99cdea commit 7475400

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

  • lib/node_modules/@stdlib/ndarray/base/fill

lib/node_modules/@stdlib/ndarray/base/fill/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,6 @@ The function accepts the following arguments:
6060
- **x**: input ndarray.
6161
- **value**: scalar value.
6262

63-
A provided ndarray should be an object with the following properties:
64-
65-
- **dtype**: data type.
66-
- **data**: data buffer.
67-
- **shape**: dimensions.
68-
- **strides**: stride lengths.
69-
- **offset**: index offset.
70-
- **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
71-
7263
</section>
7364

7465
<!-- /.usage -->
@@ -77,8 +68,19 @@ A provided ndarray should be an object with the following properties:
7768

7869
## Notes
7970

71+
- A provided ndarray should be an object with the following properties:
72+
73+
- **dtype**: data type.
74+
- **data**: data buffer.
75+
- **shape**: dimensions.
76+
- **strides**: stride lengths.
77+
- **offset**: index offset.
78+
- **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
79+
8080
- If `value` is a number and `x` has a complex [data type][@stdlib/ndarray/dtypes], the function fills an input ndarray with a complex number whose real component equals the provided scalar `value` and whose imaginary component is zero.
81+
8182
- A `value` must be able to safely cast to the input ndarray [data type][@stdlib/ndarray/dtypes]. Scalar values having floating-point data types (both real and complex) are allowed to downcast to a lower precision data type of the same kind (e.g., a scalar double-precision floating-point number can be used to fill a `'float32'` input ndarray).
83+
8284
- The function **mutates** the input ndarray.
8385

8486
</section>

0 commit comments

Comments
 (0)