-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
cumprod.ts
69 lines (63 loc) · 2.27 KB
/
cumprod.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/**
* @license
* Copyright 2022 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 { ENGINE } from '../engine';
import { Cumprod, CumprodAttrs, CumprodInputs } from '../kernel_names';
import { NamedAttrMap } from '../kernel_registry';
import { Tensor } from '../tensor';
import { NamedTensorMap } from '../tensor_types';
import { convertToTensor } from '../tensor_util_env';
import { TensorLike } from '../types';
import { op } from './operation';
/**
* Computes the cumulative product of a `tf.Tensor` along `axis`.
*
* ```js
* const x = tf.tensor([1, 2, 3, 4]);
* x.cumprod().print();
* ```
* ```js
* const x = tf.tensor([[1, 2], [3, 4]]);
* x.cumprod().print();
* ```
*
* @param x The input tensor to cumulatively multiply.
* @param axis The axis along which to multiply. Optional. Defaults to 0.
* @param exclusive Whether to perform exclusive cumulative product. Optional.
* Defaults to false. If set to true then the product of each tensor entry
* does not include its own value, but only the values previous to it
* along the specified axis.
* @param reverse Whether to multiply in the opposite direction. Optional.
* Defaults to false.
*
* @doc {heading: 'Operations', subheading: 'Scan'}
*/
function cumprod_<T extends Tensor>(
x: Tensor | TensorLike,
axis = 0,
exclusive = false,
reverse = false
): T {
const $x = convertToTensor(x, 'x', 'cumprod');
const inputs: CumprodInputs = { x: $x };
const attrs: CumprodAttrs = { axis, exclusive, reverse };
return ENGINE.runKernel(
Cumprod,
inputs as unknown as NamedTensorMap,
attrs as unknown as NamedAttrMap
);
}
export const cumprod = /* @__PURE__ */ op({ cumprod_ });