@tensorflow/tfjs-core/src/public/chained_ops/topk.ts

Hardware-accelerated JavaScript library for machine intelligence

/**
 * @license
 * Copyright 2020 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 {topk} from '../../ops/topk';
import {getGlobalTensorClass, Tensor} from '../../tensor';
import {Rank} from '../../types';

declare module '../../tensor' {
  interface Tensor<R extends Rank = Rank> {
    topk<T extends Tensor>(this: T, k?: number, sorted?: boolean):
        {values: T, indices: T};
  }
}

getGlobalTensorClass().prototype.topk = function<T extends Tensor>(
    this: T, k?: number, sorted?: boolean): {values: T, indices: T} {
  this.throwIfDisposed();
  return topk(this, k, sorted) as {values: T, indices: T};
};