docs: add examples

---
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: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - 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: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/fft/base/fftpack/lib/radb2.js

@@ -96,6 +96,8 @@
 *
 * ```text
 * | cc(0,0,0) ... cc(3,0,0) | cc(0,1,0) ... cc(3,1,0) | cc(0,0,1) ... cc(3,0,1) | ... | cc(0,1,2) ... cc(3,1,2) |
+*      ↑              ↑           ↑              ↑           ↑             ↑                ↑              ↑
+*      0             M-1          M            2M-1         2M           3M-1            (2L-1)M         2LM-1
 * ```
 *
 * @private
@@ -106,6 +108,30 @@
 * @param {integer} stride - stride length of the input array
 * @param {NonNegativeInteger} offset - index specifying the first indexed element in the input array
 * @returns {NonNegativeInteger} computed index
+*
+* @example
+* var stride = 1;
+* var offset = 0;
+*
+* var M = 4; // sub-sequence length
+* var L = 3; // number of sub-sequences
+*
+* var idx = iptr( 0, 0, 0, M, stride, offset );
+* // returns 0
+*
+* idx = iptr( 1, 0, 0, M, stride, offset );
+* // returns 1
+*
+* idx = iptr( M-1, 0, 0, M, stride, offset );
+* // returns 3
+*
+* idx = iptr( 0, 1, 0, M, stride, offset );
+* // returns 4
+*
+* // ...
+*
+* idx = iptr( M-1, 1, L-1, M, stride, offset );
+* // returns 23
 */
 function iptr( i, j, k, M, stride, offset ) {
 	var n = i + ( ( j+(k*2) ) * M );
@@ -142,6 +168,8 @@ function iptr( i, j, k, M, stride, offset ) {
 *
 * ```text
 * | out(0,0,0)...out(3,0,0) ... out(0,2,0)...out(3,2,0) | out(0,0,1)...out(3,0,1) ... out(0,2,1)...out(3,2,1) |
+*       ↑            ↑              ↑            ↑           ↑             ↑              ↑            ↑
+*       0           M-1            LM          LM-1         LM         (L+1)M-1        (2L-1)M        2LM-1
 * ```
 *
 * As may be observed, when resolving an index in the output array, the `j` and `k` dimensions are swapped. This stems from `radb2` being only one stage in a multi-stage driver which alternates between using `ch` and `out` as workspace buffers. After each stage, the next stage reads what the previous stage wrote.
@@ -157,6 +185,30 @@ function iptr( i, j, k, M, stride, offset ) {
 * @param {integer} stride - stride length of the output array
 * @param {NonNegativeInteger} offset - index specifying the first indexed element in the output array
 * @returns {NonNegativeInteger} computed index
+*
+* @example
+* var stride = 1;
+* var offset = 0;
+*
+* var M = 4; // sub-sequence length
+* var L = 3; // number of sub-sequences
+*
+* var idx = optr( 0, 0, 0, L, M, stride, offset );
+* // returns 0
+*
+* idx = optr( 1, 0, 0, L, M, stride, offset );
+* // returns 1
+*
+* idx = optr( M-1, 0, 0, L, M, stride, offset );
+* // returns 3
+*
+* idx = optr( 0, 1, 0, L, M, stride, offset );
+* // returns 4
+*
+* // ...
+*
+* idx = optr( M-1, L-1, 1, L, M, stride, offset );
+* // returns 23
 */
 function optr( i, k, j, L, M, stride, offset ) {
 	var n = i + ( ( k+(j*L) ) * M );