Skip to content

Commit 56aeda8

Browse files
authored
docs: update namespace TypeScript declarations
PR-URL: #5003 Reviewed-by: Athan Reines <[email protected]>
1 parent 55a1a08 commit 56aeda8

File tree

1 file changed

+4
-40
lines changed
  • lib/node_modules/@stdlib/blas/base/docs/types

1 file changed

+4
-40
lines changed

lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts

+4-40
Original file line numberDiff line numberDiff line change
@@ -223,59 +223,23 @@ interface Namespace {
223223
*
224224
* @example
225225
* var Complex64Array = require( '@stdlib/array/complex64' );
226-
* var realf = require( '@stdlib/complex/float32/real' );
227-
* var imagf = require( '@stdlib/complex/float32/imag' );
228226
*
229227
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
230228
* var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
231229
*
232230
* ns.csrot( 2, cx, 2, cy, 1, 0.8, 0.6 );
233-
*
234-
* var z = cy.get( 0 );
235-
* // returns <Complex64>
236-
*
237-
* var re = realf( z );
238-
* // returns -0.6
239-
*
240-
* var im = imagf( z );
241-
* // returns -1.2
242-
*
243-
* z = cx.get( 0 );
244-
* // returns <Complex64>
245-
*
246-
* re = realf( z );
247-
* // returns 0.8
248-
*
249-
* im = imagf( z );
250-
* // returns 1.6
231+
* // cx => <Complex64Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
232+
* // cy => <Complex64Array>[ ~-0.6, ~-1.2, -3.0, ~-3.6, 0.0, 0.0, 0.0, 0.0 ]
251233
*
252234
* @example
253235
* var Complex64Array = require( '@stdlib/array/complex64' );
254-
* var realf = require( '@stdlib/complex/float32/real' );
255-
* var imagf = require( '@stdlib/complex/float32/imag' );
256236
*
257237
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
258238
* var cy = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
259239
*
260240
* ns.csrot.ndarray( 2, cx, 2, 0, cy, 1, 0, 0.8, 0.6 );
261-
*
262-
* var z = cy.get( 0 );
263-
* // returns <Complex64>
264-
*
265-
* var re = realf( z );
266-
* // returns -0.6
267-
*
268-
* var im = imagf( z );
269-
* // returns -1.2
270-
*
271-
* z = cx.get( 0 );
272-
* // returns <Complex64>
273-
*
274-
* re = realf( z );
275-
* // returns 0.8
276-
*
277-
* im = imagf( z );
278-
* // returns 1.6
241+
* // cx => <Complex64Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
242+
* // cy => <Complex64Array>[ ~-0.6, ~-1.2, -3.0, ~-3.6, 0.0, 0.0, 0.0, 0.0 ]
279243
*/
280244
csrot: typeof csrot;
281245

0 commit comments

Comments
 (0)