/** * @license * Copyright 2018 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'; /** * Gather slices from tensor `x`'s axis `axis` according to `indices`. * * ```js * const x = tf.tensor1d([1, 2, 3, 4]); * const indices = tf.tensor1d([1, 3, 3], 'int32'); * * x.gather(indices).print(); * ``` * * ```js * const x = tf.tensor2d([1, 2, 3, 4], [2, 2]); * const indices = tf.tensor1d([1, 1, 0], 'int32'); * * x.gather(indices).print(); * ``` * @param x The input tensor whose slices to be gathered. * @param indices The indices of the values to extract. * @param axis The axis over which to select values. Defaults to 0. * @param batchDims Optional. The number of batch dimensions. It must be less * than or equal to rank(indices). Defaults to 0. * The output tensor will have shape of * `x.shape[:axis] + indices.shape[batchDims:] + x.shape[axis + 1:]` * * @doc {heading: 'Tensors', subheading: 'Slicing and Joining'} */ declare function gather_(x: T | TensorLike, indices: Tensor | TensorLike, axis?: number, batchDims?: number): T; export declare const gather: typeof gather_; export {};