20
20
21
21
/// <reference types="@stdlib/types"/>
22
22
23
- import { Collection } from '@stdlib/types/array' ;
23
+ import { Collection , AccessorArrayLike } from '@stdlib/types/array' ;
24
24
25
25
/**
26
26
* Interface describing `gfill`.
27
27
*/
28
28
interface Routine {
29
+ /**
30
+ * Fills a strided array with a specified scalar constant.
31
+ *
32
+ * @param N - number of indexed elements
33
+ * @param alpha - scalar constant
34
+ * @param x - input array
35
+ * @param strideX - stride length
36
+ * @returns `x`
37
+ *
38
+ * @example
39
+ * var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
40
+ *
41
+ * var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
42
+ *
43
+ * gfill( x.length, 5.0, toAccessorArray( x ), 1 );
44
+ * // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
45
+ */
46
+ < T = unknown , U = unknown > ( N : number , alpha : T , x : AccessorArrayLike < U > , strideX : number ) : AccessorArrayLike < T | U > ;
47
+
29
48
/**
30
49
* Fills a strided array with a specified scalar constant.
31
50
*
@@ -43,6 +62,26 @@ interface Routine {
43
62
*/
44
63
< T = unknown , U = unknown > ( N : number , alpha : T , x : Collection < U > , strideX : number ) : Collection < T | U > ;
45
64
65
+ /**
66
+ * Fills a strided array with a specified scalar constant using alternative indexing semantics.
67
+ *
68
+ * @param N - number of indexed elements
69
+ * @param alpha - scalar constant
70
+ * @param x - input array
71
+ * @param strideX - stride length
72
+ * @param offsetX - starting index
73
+ * @returns `x`
74
+ *
75
+ * @example
76
+ * var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
77
+ *
78
+ * var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
79
+ *
80
+ * gfill.ndarray( x.length, 5.0, toAccessorArray( x ), 1, 0 );
81
+ * // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
82
+ */
83
+ ndarray < T = unknown , U = unknown > ( N : number , alpha : T , x : AccessorArrayLike < U > , strideX : number , offsetX : number ) : AccessorArrayLike < T | U > ;
84
+
46
85
/**
47
86
* Fills a strided array with a specified scalar constant using alternative indexing semantics.
48
87
*
0 commit comments