UNPKG

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