UNPKG

1.71 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 * Computes the cumulative sum of a `tf.Tensor` along `axis`.
21 *
22 * ```js
23 * const x = tf.tensor([1, 2, 3, 4]);
24 * x.cumsum().print();
25 * ```
26 * ```js
27 * const x = tf.tensor([[1, 2], [3, 4]]);
28 * x.cumsum().print();
29 * ```
30 *
31 * @param x The input tensor to be summed.
32 * @param axis The axis along which to sum. Optional. Defaults to 0.
33 * @param exclusive Whether to perform exclusive cumulative sum. Optional.
34 * Defaults to false. If set to true then the sum of each tensor entry
35 * does not include its own value, but only the values previous to it
36 * along the specified axis.
37 * @param reverse Whether to sum in the opposite direction. Optional.
38 * Defaults to false.
39 *
40 * @doc {heading: 'Operations', subheading: 'Scan'}
41 */
42declare function cumsum_<T extends Tensor>(x: Tensor | TensorLike, axis?: number, exclusive?: boolean, reverse?: boolean): T;
43export declare const cumsum: typeof cumsum_;
44export {};