Skip to content

Commit 81821e1

Browse files
authored
docs: add missing notes
Signed-off-by: Athan <[email protected]>
1 parent 1bc00d1 commit 81821e1

File tree

1 file changed

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

1 file changed

+20
-0
lines changed

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,10 @@ interface FindLastIndex {
112112
/**
113113
* Returns the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.
114114
*
115+
* ## Notes
116+
*
117+
* - If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
118+
*
115119
* @param x - input ndarray
116120
* @param clbk - predicate function
117121
* @param thisArg - predicate function execution context
@@ -137,6 +141,10 @@ interface FindLastIndex {
137141
/**
138142
* Returns the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.
139143
*
144+
* ## Notes
145+
*
146+
* - If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
147+
*
140148
* @param x - input ndarray
141149
* @param options - function options
142150
* @param clbk - predicate function
@@ -163,6 +171,10 @@ interface FindLastIndex {
163171
/**
164172
* Returns the index of the last element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
165173
*
174+
* ## Notes
175+
*
176+
* - If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
177+
*
166178
* @param x - input ndarray
167179
* @param out - output ndarray
168180
* @param clbk - predicate function
@@ -194,6 +206,10 @@ interface FindLastIndex {
194206
/**
195207
* Returns the index of the last element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
196208
*
209+
* ## Notes
210+
*
211+
* - If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
212+
*
197213
* @param x - input ndarray
198214
* @param out - output ndarray
199215
* @param options - function options
@@ -227,6 +243,10 @@ interface FindLastIndex {
227243
/**
228244
* Returns the index of the last element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
229245
*
246+
* ## Notes
247+
*
248+
* - If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
249+
*
230250
* @param x - input ndarray
231251
* @param options - function options
232252
* @param clbk - predicate function

0 commit comments

Comments
 (0)