UNPKG

1.58 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2018 Google LLC. All Rights Reserved.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 * =============================================================================
16 */
17import { Tensor } from '../tensor';
18import { TensorLike } from '../types';
19/**
20 * Apply boolean mask to tensor.
21 *
22 * ```js
23 * const tensor = tf.tensor2d([1, 2, 3, 4, 5, 6], [3, 2]);
24 * const mask = tf.tensor1d([1, 0, 1], 'bool');
25 * const result = await tf.booleanMaskAsync(tensor, mask);
26 * result.print();
27 * ```
28 *
29 * @param tensor N-D tensor.
30 * @param mask K-D boolean tensor, K <= N and K must be known statically.
31 * @param axis A 0-D int Tensor representing the axis in tensor to mask from.
32 * By default, axis is 0 which will mask from the first dimension.
33 * Otherwise K + axis <= N.
34 *
35 * @doc {heading: 'Tensors', subheading: 'Slicing and Joining'}
36 */
37declare function booleanMaskAsync_(tensor: Tensor | TensorLike, mask: Tensor | TensorLike, axis?: number): Promise<Tensor>;
38export declare const booleanMaskAsync: typeof booleanMaskAsync_;
39export {};