-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
lower_bound.ts
72 lines (70 loc) · 2.86 KB
/
lower_bound.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/**
* @license
* Copyright 2022 Google LLC. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =============================================================================
*/
import {Tensor} from '../tensor';
import {TensorLike} from '../types';
import {searchSorted} from './search_sorted';
/**
* Searches for where a value would go in a sorted sequence.
*
* This is not a method for checking containment (like javascript in).
*
* The typical use case for this operation is "binning", "bucketing", or
* "discretizing". The values are assigned to bucket-indices based on the edges
* listed in 'sortedSequence'. This operation returns the bucket-index for each
* value.
*
* The index returned corresponds to the first edge greater than or equal to the
* value.
*
* The axis is not settable for this operation. It always operates on the
* innermost dimension (axis=-1). The operation will accept any number of outer
* dimensions.
*
* Note: This operation assumes that 'lowerBound' is sorted along the
* innermost axis, maybe using 'sort(..., axis=-1)'. If the sequence is not
* sorted no error is raised and the content of the returned tensor is not well
* defined.
*
* ```js
* const edges = tf.tensor1d([-1, 3.3, 9.1, 10.0]);
* let values = tf.tensor1d([0.0, 4.1, 12.0]);
* const result1 = tf.lowerBound(edges, values);
* result1.print(); // [1, 2, 4]
*
* const seq = tf.tensor1d([0, 3, 9, 10, 10]);
* values = tf.tensor1d([0, 4, 10]);
* const result2 = tf.lowerBound(seq, values);
* result2.print(); // [0, 2, 3]
*
* const sortedSequence = tf.tensor2d([[0., 3., 8., 9., 10.],
* [1., 2., 3., 4., 5.]]);
* values = tf.tensor2d([[9.8, 2.1, 4.3],
* [0.1, 6.6, 4.5, ]]);
* const result3 = tf.lowerBound(sortedSequence, values);
* result3.print(); // [[4, 1, 2], [0, 5, 4]]
* ```
* @param sortedSequence: N-D. Sorted sequence.
* @param values: N-D. Search values.
* @return An N-D int32 tensor the size of values containing the result of
* applying lower bound to each value. The result is not a global index to
* the entire Tensor, but the index in the last dimension.
* @doc {heading: 'Operations', subheading: 'Evaluation'}
*/
export function lowerBound(
sortedSequence: Tensor|TensorLike, values: Tensor|TensorLike): Tensor {
return searchSorted(sortedSequence, values, 'left');
}