Skip to content

Commit 2df0faf

Browse files
committed
docs: fix the jsdoc to set the accessors
1 parent ccad894 commit 2df0faf

2 files changed

Lines changed: 70 additions & 30 deletions

File tree

lib/node_modules/@stdlib/ndarray/base/where/lib/0d_accessors.js

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,16 @@
5555
* @returns {void}
5656
*
5757
* @example
58-
* var Float64Array = require( '@stdlib/array/float64' );
59-
* var Uint8Array = require( '@stdlib/array/uint8' );
58+
* var Complex64Array = require( '@stdlib/array/complex64' );
59+
* var BooleanArray = require( '@stdlib/array/bool' );
60+
* var realf = require( '@stdlib/complex/float32/real' );
61+
* var imagf = require( '@stdlib/complex/float32/imag' );
6062
*
6163
* // Create data buffers:
62-
* var cbuf = new Uint8Array( [ 1 ] );
63-
* var xbuf = new Float64Array( [ 1.0 ] );
64-
* var ybuf = new Float64Array( [ 2.0 ] );
65-
* var obuf = new Float64Array( 1 );
64+
* var cbuf = new BooleanArray( [ 1 ] );
65+
* var xbuf = new Complex64Array( [ 1.0, 2.0 ] );
66+
* var ybuf = new Complex64Array( [ 3.0, 4.0 ] );
67+
* var obuf = new Complex64Array( 1 );
6668
*
6769
* // Define the shape of the arrays (0-dimensional = scalar):
6870
* var shape = [];
@@ -79,45 +81,63 @@
7981
* var oy = 0;
8082
* var oo = 0;
8183
*
84+
* // Define getters and setters:
85+
* function getter( buf, idx ) {
86+
* return buf.get( idx );
87+
* }
88+
*
89+
* function setter( buf, idx, value ) {
90+
* buf.set( value, idx );
91+
* }
92+
*
8293
* // Create the ndarray-like objects:
8394
* var condition = {
8495
* 'dtype': 'uint8',
8596
* 'data': cbuf,
8697
* 'shape': shape,
8798
* 'strides': sc,
8899
* 'offset': oc,
89-
* 'order': 'row-major'
100+
* 'order': 'row-major',
101+
* 'accessors': [ getter, setter ]
90102
* };
91103
* var x = {
92-
* 'dtype': 'float64',
104+
* 'dtype': 'complex64',
93105
* 'data': xbuf,
94106
* 'shape': shape,
95107
* 'strides': sx,
96108
* 'offset': ox,
97-
* 'order': 'row-major'
109+
* 'order': 'row-major',
110+
* 'accessors': [ getter, setter ]
98111
* };
99112
* var y = {
100-
* 'dtype': 'float64',
113+
* 'dtype': 'complex64',
101114
* 'data': ybuf,
102115
* 'shape': shape,
103116
* 'strides': sy,
104117
* 'offset': oy,
105-
* 'order': 'row-major'
118+
* 'order': 'row-major',
119+
* 'accessors': [ getter, setter ]
106120
* };
107121
* var out = {
108-
* 'dtype': 'float64',
122+
* 'dtype': 'complex64',
109123
* 'data': obuf,
110124
* 'shape': shape,
111125
* 'strides': so,
112126
* 'offset': oo,
113-
* 'order': 'row-major'
127+
* 'order': 'row-major',
128+
* 'accessors': [ getter, setter ]
114129
* };
115130
*
116131
* // Apply the condition:
117132
* where0d( condition, x, y, out );
118133
*
119-
* console.log( out.data );
120-
* // => <Float64Array>[ 1.0 ]
134+
* var v = out.data.get( 0 );
135+
*
136+
* var re = realf( v );
137+
* // returns 1.0
138+
*
139+
* var im = imagf( v );
140+
* // returns 2.0
121141
*/
122142
function where0d( condition, x, y, out ) {
123143
out.accessors[ 1 ]( out.data, out.offset, ( condition.accessors[ 0 ]( condition.data, condition.offset ) ) ? x.accessors[ 0 ]( x.data, x.offset ) : y.accessors[ 0 ]( y.data, y.offset ) ); // eslint-disable-line max-len

lib/node_modules/@stdlib/ndarray/base/where/lib/2d_accessors.js

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,16 @@
5656
* @returns {void}
5757
*
5858
* @example
59-
* var Float64Array = require( '@stdlib/array/float64' );
60-
* var Uint8Array = require( '@stdlib/array/uint8' );
59+
* var Complex64Array = require( '@stdlib/array/complex64' );
60+
* var BooleanArray = require( '@stdlib/array/bool' );
61+
* var realf = require( '@stdlib/complex/float32/real' );
62+
* var imagf = require( '@stdlib/complex/float32/imag' );
6163
*
6264
* // Create data buffers:
63-
* var cbuf = new Uint8Array( [ 1, 0, 0, 1 ] );
64-
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
65-
* var ybuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0 ] );
66-
* var obuf = new Float64Array( 4 );
65+
* var cbuf = new BooleanArray( [ 1, 0, 0, 1 ] );
66+
* var xbuf = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
67+
* var ybuf = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 ] );
68+
* var obuf = new Complex64Array( 4 );
6769
*
6870
* // Define the shape of the arrays:
6971
* var shape = [ 2, 2 ];
@@ -80,45 +82,63 @@
8082
* var oy = 0;
8183
* var oo = 0;
8284
*
85+
* // Define getters and setters:
86+
* function getter( buf, idx ) {
87+
* return buf.get( idx );
88+
* }
89+
*
90+
* function setter( buf, idx, value ) {
91+
* buf.set( value, idx );
92+
* }
93+
*
8394
* // Create the ndarray-like objects:
8495
* var condition = {
8596
* 'dtype': 'uint8',
8697
* 'data': cbuf,
8798
* 'shape': shape,
8899
* 'strides': sc,
89100
* 'offset': oc,
90-
* 'order': 'row-major'
101+
* 'order': 'row-major',
102+
* 'accessors': [ getter, setter ]
91103
* };
92104
* var x = {
93-
* 'dtype': 'float64',
105+
* 'dtype': 'complex64',
94106
* 'data': xbuf,
95107
* 'shape': shape,
96108
* 'strides': sx,
97109
* 'offset': ox,
98-
* 'order': 'row-major'
110+
* 'order': 'row-major',
111+
* 'accessors': [ getter, setter ]
99112
* };
100113
* var y = {
101-
* 'dtype': 'float64',
114+
* 'dtype': 'complex64',
102115
* 'data': ybuf,
103116
* 'shape': shape,
104117
* 'strides': sy,
105118
* 'offset': oy,
106-
* 'order': 'row-major'
119+
* 'order': 'row-major',
120+
* 'accessors': [ getter, setter ]
107121
* };
108122
* var out = {
109-
* 'dtype': 'float64',
123+
* 'dtype': 'complex64',
110124
* 'data': obuf,
111125
* 'shape': shape,
112126
* 'strides': so,
113127
* 'offset': oo,
114-
* 'order': 'row-major'
128+
* 'order': 'row-major',
129+
* 'accessors': [ getter, setter ]
115130
* };
116131
*
117132
* // Apply the condition:
118133
* where2d( condition, x, y, out, true );
119134
*
120-
* console.log( out.data );
121-
* // => <Float64Array>[ 1.0, -2.0, -3.0, 4.0 ]
135+
* var v = out.data.get( 0 );
136+
*
137+
* var re = realf( v );
138+
* // returns 1.0
139+
*
140+
* var im = imagf( v );
141+
* // returns 2.0
122142
*/
123143
function where2d( condition, x, y, out, isRowMajor ) {
124144
var cbuf;

0 commit comments

Comments
 (0)