From 7b08881e0e69b76a54ed97632143d06a4eada7c1 Mon Sep 17 00:00:00 2001 From: Diyan Date: Wed, 14 Jan 2026 22:49:54 +0530 Subject: [PATCH] docs: improve doctests for ndarray instances in ndarray/dcusum --- 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: 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/ndarray/dcusum/README.md | 6 +----- .../blas/ext/base/ndarray/dcusum/docs/types/index.d.ts | 6 +----- .../@stdlib/blas/ext/base/ndarray/dcusum/lib/index.js | 6 +----- .../@stdlib/blas/ext/base/ndarray/dcusum/lib/main.js | 6 +----- 4 files changed, 4 insertions(+), 20 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/README.md index bed027df2af0..f53f6e0e2889 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/README.md @@ -42,7 +42,6 @@ Computes the cumulative sum of a one-dimensional double-precision floating-point ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); @@ -55,13 +54,10 @@ var y = new ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); var initial = scalar2ndarray( 0.0, 'float64', 'row-major' ); var v = dcusum( [ x, y, initial ] ); -// returns +// returns [ 1.0, 4.0, 8.0, 10.0 ] var bool = ( v === y ); // returns true - -var arr = ndarray2array( v ); -// returns [ 1.0, 4.0, 8.0, 10.0 ] ``` The function has the following parameters: diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/types/index.d.ts index cf0493a57043..2df47fccaf77 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/types/index.d.ts @@ -30,7 +30,6 @@ import { float64ndarray } from '@stdlib/types/ndarray'; * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * @@ -43,13 +42,10 @@ import { float64ndarray } from '@stdlib/types/ndarray'; * var initial = scalar2ndarray( 0.0, 'float64', 'row-major' ); * * var v = dcusum( [ x, y, initial ] ); -* // returns +* // returns [ 1.0, 4.0, 8.0, 10.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 4.0, 8.0, 10.0 ] */ declare function dcusum( arrays: [ float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/index.js index cb478fa2ff7c..b35787f00621 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/index.js @@ -25,7 +25,6 @@ * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * var dcusum = require( '@stdlib/blas/ext/base/ndarray/dcusum' ); @@ -39,13 +38,10 @@ * var initial = scalar2ndarray( 0.0, 'float64', 'row-major' ); * * var v = dcusum( [ x, y, initial ] ); -* // returns +* // returns [ 1.0, 4.0, 8.0, 10.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 4.0, 8.0, 10.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/main.js index 67b6dd1f0741..b5239dd99d66 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/lib/main.js @@ -38,7 +38,6 @@ var strided = require( '@stdlib/blas/ext/base/dcusum' ).ndarray; * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * @@ -51,13 +50,10 @@ var strided = require( '@stdlib/blas/ext/base/dcusum' ).ndarray; * var initial = scalar2ndarray( 0.0, 'float64', 'row-major' ); * * var v = dcusum( [ x, y, initial ] ); -* // returns +* // returns [ 1.0, 4.0, 8.0, 10.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 4.0, 8.0, 10.0 ] */ function dcusum( arrays ) { var x = arrays[ 0 ];