Skip to content

Commit fa99780

Browse files
committed
docs: fix inconsistencies
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent d7f61cd commit fa99780

File tree

1 file changed

+29
-29
lines changed
  • lib/node_modules/@stdlib/blas/ext/find-index/docs/types

1 file changed

+29
-29
lines changed

lib/node_modules/@stdlib/blas/ext/find-index/docs/types/index.d.ts

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -33,48 +33,48 @@ type InputArray<T> = typedndarray<T>;
3333
type OutputArray = typedndarray<number>;
3434

3535
/**
36-
* Returns the result of callback function.
36+
* Returns a boolean indicating whether an element passes a test.
3737
*
38-
* @returns result
38+
* @returns a boolean indicating whether an element passes a test
3939
*/
40-
type NullaryCallback<ThisArg> = ( this: ThisArg ) => boolean;
40+
type NullaryPredicate<ThisArg> = ( this: ThisArg ) => boolean;
4141

4242
/**
43-
* Returns the result of callback function.
43+
* Returns a boolean indicating whether an element passes a test.
4444
*
4545
* @param value - current array element
46-
* @returns result
46+
* @returns a boolean indicating whether an element passes a test
4747
*/
48-
type UnaryCallback<T, ThisArg> = ( this: ThisArg, value: T ) => boolean;
48+
type UnaryPredicate<T, ThisArg> = ( this: ThisArg, value: T ) => boolean;
4949

5050
/**
51-
* Returns the result of callback function.
51+
* Returns a boolean indicating whether an element passes a test.
5252
*
5353
* @param value - current array element
5454
* @param index - current array element index
55-
* @returns result
55+
* @returns a boolean indicating whether an element passes a test
5656
*/
57-
type BinaryCallback<T, ThisArg> = ( this: ThisArg, value: T, index: number ) => boolean;
57+
type BinaryPredicate<T, ThisArg> = ( this: ThisArg, value: T, index: number ) => boolean;
5858

5959
/**
60-
* Returns the result of callback function.
60+
* Returns a boolean indicating whether an element passes a test.
6161
*
6262
* @param value - current array element
6363
* @param index - current array element index
6464
* @param array - input ndarray
65-
* @returns result
65+
* @returns a boolean indicating whether an element passes a test
6666
*/
67-
type TernaryCallback<T, U, ThisArg> = ( this: ThisArg, value: T, index: number, array: U ) => boolean;
67+
type TernaryPredicate<T, U, ThisArg> = ( this: ThisArg, value: T, index: number, array: U ) => boolean;
6868

6969
/**
70-
* Returns the result of callback function.
70+
* Returns a boolean indicating whether an element passes a test.
7171
*
7272
* @param value - current array element
7373
* @param index - current array element index
7474
* @param array - input ndarray
75-
* @returns result
75+
* @returns a boolean indicating whether an element passes a test
7676
*/
77-
type Callback<T, U, ThisArg> = NullaryCallback<ThisArg> | UnaryCallback<T, ThisArg> | BinaryCallback<T, ThisArg> | TernaryCallback<T, U, ThisArg>;
77+
type Predicate<T, U, ThisArg> = NullaryPredicate<ThisArg> | UnaryPredicate<T, ThisArg> | BinaryPredicate<T, ThisArg> | TernaryPredicate<T, U, ThisArg>;
7878

7979
/**
8080
* Interface defining "base" options.
@@ -113,8 +113,8 @@ interface FindIndex {
113113
* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function.
114114
*
115115
* @param x - input ndarray
116-
* @param clbk - callback function
117-
* @param thisArg - callback function execution context
116+
* @param clbk - predicate function
117+
* @param thisArg - predicate function execution context
118118
* @returns output ndarray
119119
*
120120
* @example
@@ -132,15 +132,15 @@ interface FindIndex {
132132
* var v = y.get();
133133
* // returns 1
134134
*/
135-
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): OutputArray;
135+
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): OutputArray;
136136

137137
/**
138138
* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function.
139139
*
140140
* @param x - input ndarray
141141
* @param options - function options
142-
* @param clbk - callback function
143-
* @param thisArg - callback function execution context
142+
* @param clbk - predicate function
143+
* @param thisArg - predicate function execution context
144144
* @returns output ndarray
145145
*
146146
* @example
@@ -158,15 +158,15 @@ interface FindIndex {
158158
* var v = y.get();
159159
* // returns 1
160160
*/
161-
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): OutputArray;
161+
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): OutputArray;
162162

163163
/**
164164
* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
165165
*
166166
* @param x - input ndarray
167167
* @param out - output ndarray
168-
* @param clbk - callback function
169-
* @param thisArg - callback function execution context
168+
* @param clbk - predicate function
169+
* @param thisArg - predicate function execution context
170170
* @returns output ndarray
171171
*
172172
* @example
@@ -189,16 +189,16 @@ interface FindIndex {
189189
* var bool = ( out === y );
190190
* // returns true
191191
*/
192-
assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends OutputArray = OutputArray, ThisArg = unknown>( x: U, out: V, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): V;
192+
assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends OutputArray = OutputArray, ThisArg = unknown>( x: U, out: V, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): V;
193193

194194
/**
195195
* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
196196
*
197197
* @param x - input ndarray
198198
* @param out - output ndarray
199199
* @param options - function options
200-
* @param clbk - callback function
201-
* @param thisArg - callback function execution context
200+
* @param clbk - predicate function
201+
* @param thisArg - predicate function execution context
202202
* @returns output ndarray
203203
*
204204
* @example
@@ -221,16 +221,16 @@ interface FindIndex {
221221
* var bool = ( out === y );
222222
* // returns true
223223
*/
224-
assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends OutputArray = OutputArray, ThisArg = unknown>( x: U, out: V, options: BaseOptions, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): V;
224+
assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends OutputArray = OutputArray, ThisArg = unknown>( x: U, out: V, options: BaseOptions, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): V;
225225
}
226226

227227
/**
228228
* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
229229
*
230230
* @param x - input ndarray
231231
* @param options - function options
232-
* @param clbk - callback function
233-
* @param thisArg - callback execution context
232+
* @param clbk - predicate function
233+
* @param thisArg - predicate function execution context
234234
* @returns output ndarray
235235
*
236236
* @example

0 commit comments

Comments
 (0)