Skip to content

docs: improve doctests for complex number typed arrays in ndarray/base/nullary #12045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
May 10, 2026
Merged

docs: improve doctests for complex number typed arrays in ndarray/base/nullary #12045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/0d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -79,14 +77,7 @@
*
* // Apply the nullary function:
* nullary0d( x, fcn );
*
* var v = x.data.get( 1 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 0.0, 0.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary0d( x, fcn ) {
x.accessors[ 1 ]( x.data, x.offset, fcn() );
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/10d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
*
* // Apply the nullary function:
* nullary10d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary10d( x, fcn ) { // eslint-disable-line max-statements
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/10d_blocked_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
*
* // Apply the nullary function:
* blockednullary10d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function blockednullary10d( x, fcn ) { // eslint-disable-line max-statements, max-lines-per-function
var bsize;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/1d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -79,14 +77,7 @@
*
* // Apply the nullary function:
* nullary1d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary1d( x, fcn ) {
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/2d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -84,14 +82,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
*
* // Apply the nullary function:
* nullary2d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary2d( x, fcn ) {
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/2d_blocked_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -84,14 +82,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
*
* // Apply the nullary function:
* blockednullary2d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function blockednullary2d( x, fcn ) {
var bsize;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/3d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -84,14 +82,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
*
* // Apply the nullary function:
* nullary3d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary3d( x, fcn ) {
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/3d_blocked_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
*
* // Apply the nullary function:
* blockednullary3d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function blockednullary3d( x, fcn ) {
var bsize;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/4d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -84,14 +82,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
*
* // Apply the nullary function:
* nullary4d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary4d( x, fcn ) {
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/4d_blocked_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
*
* // Apply the nullary function:
* blockednullary4d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function blockednullary4d( x, fcn ) {
var bsize;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/5d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -84,14 +82,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
*
* // Apply the nullary function:
* nullary5d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary5d( x, fcn ) {
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/5d_blocked_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
*
* // Apply the nullary function:
* blockednullary5d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function blockednullary5d( x, fcn ) {
var bsize;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/6d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
*
* // Apply the nullary function:
* nullary6d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary6d( x, fcn ) {
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/6d_blocked_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
*
* // Apply the nullary function:
* blockednullary6d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function blockednullary6d( x, fcn ) { // eslint-disable-line max-statements
var bsize;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/7d_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
*
* // Apply the nullary function:
* nullary7d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function nullary7d( x, fcn ) {
var xbuf;
Expand Down
11 changes: 1 addition & 10 deletions lib/node_modules/@stdlib/ndarray/base/nullary/lib/7d_blocked_accessors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* function fcn() {
* return new Complex64( 10.0, -10.0 );
Expand Down Expand Up @@ -86,14 +84,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
*
* // Apply the nullary function:
* blockednullary7d( x, fcn );
*
* var v = x.data.get( 0 );
*
* var re = realf( v );
* // returns 10.0
*
* var im = imagf( v );
* // returns -10.0
* // xbuf => <Complex64Array>[ 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 10.0, -10.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
*/
function blockednullary7d( x, fcn ) { // eslint-disable-line max-statements
var bsize;
Expand Down
Loading