Skip to content

Commit 44fccf8

Browse files
committed
docs: fix the jsdoc to set the accessors
1 parent ccad894 commit 44fccf8

2 files changed

Lines changed: 34 additions & 8 deletions

File tree

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

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,38 +79,51 @@
7979
* var oy = 0;
8080
* var oo = 0;
8181
*
82+
* // Define getters and setters:
83+
* function getter( buf, idx ) {
84+
* return buf.get( idx );
85+
* }
86+
*
87+
* function setter( buf, idx, value ) {
88+
* buf.set( value, idx );
89+
* }
90+
*
8291
* // Create the ndarray-like objects:
8392
* var condition = {
8493
* 'dtype': 'uint8',
8594
* 'data': cbuf,
8695
* 'shape': shape,
8796
* 'strides': sc,
8897
* 'offset': oc,
89-
* 'order': 'row-major'
98+
* 'order': 'row-major',
99+
* 'accessors': [ getter, setter ]
90100
* };
91101
* var x = {
92102
* 'dtype': 'float64',
93103
* 'data': xbuf,
94104
* 'shape': shape,
95105
* 'strides': sx,
96106
* 'offset': ox,
97-
* 'order': 'row-major'
107+
* 'order': 'row-major',
108+
* 'accessors': [ getter, setter ]
98109
* };
99110
* var y = {
100111
* 'dtype': 'float64',
101112
* 'data': ybuf,
102113
* 'shape': shape,
103114
* 'strides': sy,
104115
* 'offset': oy,
105-
* 'order': 'row-major'
116+
* 'order': 'row-major',
117+
* 'accessors': [ getter, setter ]
106118
* };
107119
* var out = {
108120
* 'dtype': 'float64',
109121
* 'data': obuf,
110122
* 'shape': shape,
111123
* 'strides': so,
112124
* 'offset': oo,
113-
* 'order': 'row-major'
125+
* 'order': 'row-major',
126+
* 'accessors': [ getter, setter ]
114127
* };
115128
*
116129
* // Apply the condition:

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

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,38 +80,51 @@
8080
* var oy = 0;
8181
* var oo = 0;
8282
*
83+
* // Define getters and setters:
84+
* function getter( buf, idx ) {
85+
* return buf.get( idx );
86+
* }
87+
*
88+
* function setter( buf, idx, value ) {
89+
* buf.set( value, idx );
90+
* }
91+
*
8392
* // Create the ndarray-like objects:
8493
* var condition = {
8594
* 'dtype': 'uint8',
8695
* 'data': cbuf,
8796
* 'shape': shape,
8897
* 'strides': sc,
8998
* 'offset': oc,
90-
* 'order': 'row-major'
99+
* 'order': 'row-major',
100+
* 'accessors': [ getter, setter ]
91101
* };
92102
* var x = {
93103
* 'dtype': 'float64',
94104
* 'data': xbuf,
95105
* 'shape': shape,
96106
* 'strides': sx,
97107
* 'offset': ox,
98-
* 'order': 'row-major'
108+
* 'order': 'row-major',
109+
* 'accessors': [ getter, setter ]
99110
* };
100111
* var y = {
101112
* 'dtype': 'float64',
102113
* 'data': ybuf,
103114
* 'shape': shape,
104115
* 'strides': sy,
105116
* 'offset': oy,
106-
* 'order': 'row-major'
117+
* 'order': 'row-major',
118+
* 'accessors': [ getter, setter ]
107119
* };
108120
* var out = {
109121
* 'dtype': 'float64',
110122
* 'data': obuf,
111123
* 'shape': shape,
112124
* 'strides': so,
113125
* 'offset': oo,
114-
* 'order': 'row-major'
126+
* 'order': 'row-major',
127+
* 'accessors': [ getter, setter ]
115128
* };
116129
*
117130
* // Apply the condition:

0 commit comments

Comments
 (0)