math.py 146.5 KB
Newer Older
W
WuHaobo 已提交
1
# Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
2 3 4 5 6 7 8 9 10 11 12 13
#
# 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.
14 15 16
"""
math functions
"""
17
from __future__ import print_function
Y
Yang Zhang 已提交
18
import numpy as np
19

20 21 22 23 24 25
from paddle.common_ops_import import VarDesc
from paddle.common_ops_import import dygraph_only
from paddle.common_ops_import import OpProtoHolder
from paddle.common_ops_import import templatedoc
from paddle.common_ops_import import dygraph_utils

26
from paddle.tensor import cast
F
Feiyu Chan 已提交
27
from paddle.tensor.attribute import _complex_to_real_dtype
28
import paddle
Z
zhiboniu 已提交
29
from paddle.static import Variable
J
Jiabin Yang 已提交
30
from ..framework import core
31
from ..fluid.framework import _in_legacy_dygraph, in_dygraph_mode, _non_static_mode
Z
zhiboniu 已提交
32
from ..framework import _varbase_creator, convert_np_dtype_to_dtype_
L
Li Fuchen 已提交
33 34
from ..fluid.layer_helper import LayerHelper
from ..fluid.data_feeder import check_variable_and_dtype, check_type, check_dtype, convert_dtype
35
from ..fluid.layers.layer_function_generator import _generate_doc_string_, generate_activation_fn, generate_layer_fn
36
from ..fluid.dygraph.inplace_utils import inplace_apis_in_dygraph_only
37 38 39

# TODO: define math functions
# yapf: disable
40 41 42 43
from ..fluid.layers import abs    # noqa: F401
from ..fluid.layers import acos    # noqa: F401
from ..fluid.layers import asin    # noqa: F401
from ..fluid.layers import ceil    # noqa: F401
44
from ..fluid.layers import ceil_    # noqa: F401
45 46 47 48 49
from ..fluid.layers import cos    # noqa: F401
from ..fluid.layers import tan    # noqa: F401
from ..fluid.layers import sinh    # noqa: F401
from ..fluid.layers import cosh    # noqa: F401
from ..fluid.layers import exp    # noqa: F401
50
from ..fluid.layers import exp_    # noqa: F401
R
ronnywang 已提交
51
from ..fluid.layers import expm1    # noqa: F401
52
from ..fluid.layers import floor    # noqa: F401
53
from ..fluid.layers import floor_    # noqa: F401
54 55
from ..fluid.layers import log    # noqa: F401
from ..fluid.layers import reciprocal    # noqa: F401
56
from ..fluid.layers import reciprocal_    # noqa: F401
57
from ..fluid.layers import round    # noqa: F401
58
from ..fluid.layers import round_    # noqa: F401
59
from ..fluid.layers import rsqrt    # noqa: F401
60
from ..fluid.layers import rsqrt_    # noqa: F401
61 62 63 64 65 66
from ..fluid.layers import scale    # noqa: F401
from ..fluid.layers import square    # noqa: F401
from ..fluid.layers import stanh    # noqa: F401
from ..fluid.layers import atan    # noqa: F401
from ..fluid.layers import erf    # noqa: F401
from ..fluid.layers import sqrt    # noqa: F401
67
from ..fluid.layers import sqrt_    # noqa: F401
68
from ..fluid.layers import sin    # noqa: F401
69
from ..fluid.layers import lgamma    # noqa: F401
X
xiaoting 已提交
70 71 72
from ..fluid.layers import asinh    # noqa: F401
from ..fluid.layers import acosh    # noqa: F401
from ..fluid.layers import atanh    # noqa: F401
73 74

from ..fluid.layers import multiplex    # noqa: F401
Z
zhiboniu 已提交
75 76
from ..fluid.layers import reduce_prod
from ..fluid.layers import elementwise_sub
W
wanghuancoder 已提交
77
from paddle import _C_ops
78

79 80
__all__ = []

81 82 83 84 85 86 87 88 89 90 91 92 93
_supported_int_dtype_ = [
    VarDesc.VarType.UINT8,
    VarDesc.VarType.INT8,
    VarDesc.VarType.INT16,
    VarDesc.VarType.INT32,
    VarDesc.VarType.INT64,
]

_supported_float_dtype_ = [
    VarDesc.VarType.FP32,
    VarDesc.VarType.FP64,
]

94 95 96 97 98 99 100 101

@inplace_apis_in_dygraph_only
def scale_(x, scale=1.0, bias=0.0, bias_after_scale=True, act=None, name=None):
    """
    Inplace version of ``scale`` API, the output Tensor will be inplaced with input ``x``.
    Please refer to :ref:`api_tensor_scale`.
    """
    _scale = scale.numpy().item(0) if isinstance(scale, Variable) else scale
W
wanghuancoder 已提交
102
    return _C_ops.scale_(x, 'scale',
103 104 105 106
                            float(_scale), 'bias',
                            float(bias), 'bias_after_scale', bias_after_scale)


107
def pow(x, y, name=None):
108
    """
109
    Compute the power of tensor elements. The equation is:
S
swtkiwi 已提交
110

111 112
    .. math::
        out = x^{y} 
113

114 115
    **Note**:
    ``paddle.pow`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
116 117


118 119
    Args:
        x (Tensor): An N-D Tensor, the data type is float32, float64, int32 or int64.
120
        y (float|int|Tensor): If it is an N-D Tensor, its data type should be the same as `x`.
121 122
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
    
123
    Returns:
124
        N-D Tensor. A location into which the result is stored. Its dimension and data type are the same as `x`.
125 126 127

    Examples:

128
        ..  code-block:: python
129 130 131

            import paddle

132 133 134 135 136 137 138 139 140 141 142 143
            x = paddle.to_tensor([1, 2, 3], dtype='float32')

            # example 1: y is a float or int
            res = paddle.pow(x, 2)
            print(res)
            # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #        [1., 4., 9.])
            res = paddle.pow(x, 2.5)
            print(res)
            # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #        [1.         , 5.65685415 , 15.58845711])

144
            # example 2: y is a Tensor
145
            y = paddle.to_tensor([2], dtype='float32')
146
            res = paddle.pow(x, y)
147 148 149
            print(res)
            # Tensor(shape=[3], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #        [1., 4., 9.])
150 151

    """
152
    # in dynamic graph mode
153 154 155 156 157 158 159 160 161 162 163
    #if in_dygraph_mode():
    #if isinstance(y, (int, float)):
    #return _C_ops.final_state_pow(x, y)
    #elif isinstance(y, (paddle.Tensor, Variable)):
    #return _elementwise_op_in_dygraph(
    #x, y, axis=-1, act=None, op_name='elementwise_pow')
    #else:
    #raise TypeError('y must be scalar or tensor type, but received: %s '% (y.dtype))

    #if _in_legacy_dygraph():
    if _non_static_mode():
164
        if isinstance(y, (int, float)):
W
wanghuancoder 已提交
165
            return _C_ops.pow(x, 'factor', y)
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
        elif isinstance(y, (paddle.Tensor, Variable)):
            return _elementwise_op_in_dygraph(
                x, y, axis=-1, act=None, op_name='elementwise_pow')
        else:
            raise TypeError('y must be scalar or tensor type, but received: %s '% (y.dtype))
    # in static graph mode
    else:
        if isinstance(y, (int, float)):
            helper = LayerHelper('pow', **locals())
            inputs = {'X': x}
            attrs = {'factor': y}
            out = helper.create_variable_for_type_inference(dtype=x.dtype)
            helper.append_op(
                type='pow', inputs=inputs, outputs={'Out': out}, attrs=attrs)
            return out
        elif isinstance(y, (paddle.Tensor, Variable)):
            # TODO A potential speed improvement is supporting different types in C++ and removing the cast ops here
            helper = LayerHelper('elementwise_pow', **locals())
J
joejiong 已提交
184
            out = helper.create_variable_for_type_inference(dtype=x.dtype)
185 186 187
            return _elementwise_op(LayerHelper('elementwise_pow', **locals()))
        else:
            raise TypeError('y must be scalar or tensor type, but received: %s '% (type(y)))
188 189


190 191 192 193 194 195
OP_NAMEMAPPING = {
    'elementwise_max': 'final_state_maximum',
    'elementwise_min': 'final_state_minimum',
    'elementwise_pow': 'final_state_elementwise_pow',
    'elementwise_floordiv': 'final_state_floor_divide',
}
196

197 198 199 200 201 202 203
@dygraph_only
def _elementwise_op_in_dygraph(x,
                               y,
                               axis=-1,
                               act=None,
                               use_mkldnn=False,
                               op_name=None):
204 205 206 207 208 209 210 211 212 213
    def is_inplace(op_name):
        return  op_name[-1] == "_"

    if in_dygraph_mode():
        op = getattr(_C_ops, OP_NAMEMAPPING[op_name] if not is_inplace(op_name) else op_name)
        out = op(x, y)

    if _in_legacy_dygraph():
        op = getattr(_C_ops, op_name)
        out = op(x, y, 'axis', axis, 'use_mkldnn', use_mkldnn)
214 215 216 217 218 219 220 221 222 223

    return dygraph_utils._append_activation_in_dygraph(
        out, act, use_mkldnn=use_mkldnn)

def _elementwise_op(helper):
    op_type = helper.layer_type
    original_op_type = helper.kwargs.get('original_op_type', op_type)
    x = helper.kwargs.get('x', None)
    y = helper.kwargs.get('y', None)

224 225
    out = helper.kwargs.get('out', None)

226 227 228
    assert x is not None, 'x cannot be None in {}'.format(original_op_type)
    assert y is not None, 'y cannot be None in {}'.format(original_op_type)
    check_variable_and_dtype(
W
will-jl944 已提交
229
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64', 'bool'],
230 231
        original_op_type)
    check_variable_and_dtype(
W
will-jl944 已提交
232
        y, 'y', ['float16', 'float32', 'float64', 'int32', 'int64', 'bool'],
233 234 235 236 237
        original_op_type)

    axis = helper.kwargs.get('axis', -1)
    use_mkldnn = helper.kwargs.get('use_mkldnn', False)
    name = helper.kwargs.get('name', None)
238 239 240 241 242 243

    if out is None:
        if name is None:
            out = helper.create_variable_for_type_inference(dtype=x.dtype)
        else:
            out = helper.create_variable(name=name, dtype=x.dtype, persistable=False)
244 245 246 247 248 249 250 251 252 253 254

    helper.append_op(
        type=op_type,
        inputs={'X': x,
                'Y': y},
        outputs={'Out': out},
        attrs={'axis': axis,
               'use_mkldnn': use_mkldnn})
    return helper.append_activation(out)


Y
Yang Zhang 已提交
255
def add(x, y, name=None):
256
    """
257
    Examples:
258 259 260 261

    ..  code-block:: python

        import paddle
262 263
        x = paddle.to_tensor([2, 3, 4], 'float64')
        y = paddle.to_tensor([1, 5, 2], 'float64')
W
WuHaobo 已提交
264
        z = paddle.add(x, y)
265
        print(z)  # [3., 8., 6. ]
266 267

    """
268

J
Jiabin Yang 已提交
269 270 271 272 273 274 275
    if in_dygraph_mode():
        return _C_ops.final_state_add( x, y)
    else:
        if _in_legacy_dygraph():
            return _C_ops.elementwise_add(x, y)
        else:
            return _elementwise_op(LayerHelper('elementwise_add', **locals()))
276 277


278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
@inplace_apis_in_dygraph_only
def add_(x, y, name=None):
    """
    Inplace version of ``add`` API, the output Tensor will be inplaced with input ``x``.
    Please refer to :ref:`api_tensor_add`.
    """
    op_type = 'elementwise_add_'
    axis = -1

    out_shape = broadcast_shape(x.shape, y.shape)
    if out_shape != x.shape:
        raise ValueError("The shape of broadcast output {} is different from that of inplace tensor {} in the Inplace operation.".format(out_shape, x.shape))

    out = _elementwise_op_in_dygraph(
        x, y, axis=axis, op_name=op_type)
    return out


296 297
def subtract(x, y, name=None):
    """
W
Wei Shengyu 已提交
298
    Substract two tensors element-wise. The equation is:
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316

    .. math::
        out = x - y

    **Note**:
    ``paddle.subtract`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .

    Args:
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.

    Examples:

        .. code-block:: python
W
Wei Shengyu 已提交
317

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
            import numpy as np
            import paddle

            x = paddle.to_tensor([[1, 2], [7, 8]])
            y = paddle.to_tensor([[5, 6], [3, 4]])
            res = paddle.subtract(x, y)
            print(res)
            #       [[-4, -4],
            #        [4, 4]]

            x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]])
            y = paddle.to_tensor([1, 0, 4])
            res = paddle.subtract(x, y)
            print(res)
            #       [[[ 0,  2, -1],
            #         [ 0,  2, -1]]]

            x = paddle.to_tensor([2, np.nan, 5], dtype='float32')
            y = paddle.to_tensor([1, 4, np.nan], dtype='float32')
            res = paddle.subtract(x, y)
            print(res)
            #       [ 1., nan, nan]

            x = paddle.to_tensor([5, np.inf, -np.inf], dtype='float64')
            y = paddle.to_tensor([1, 4, 5], dtype='float64')
            res = paddle.subtract(x, y)
            print(res)
            #       [   4.,  inf., -inf.]

    """
    op_type = 'elementwise_sub'
    axis = -1
    act = None
J
Jiabin Yang 已提交
351 352 353 354 355 356 357 358
    if in_dygraph_mode():
        return _C_ops.final_state_subtract(x, y)
    else:
        if _in_legacy_dygraph():
            return _elementwise_op_in_dygraph(
                x, y, axis=axis, act=act, op_name=op_type)
        else:
            return _elementwise_op(LayerHelper(op_type, **locals()))
359 360


361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
@inplace_apis_in_dygraph_only
def subtract_(x, y, name=None):
    """
    Inplace version of ``subtract`` API, the output Tensor will be inplaced with input ``x``.
    Please refer to :ref:`api_tensor_subtract`.
    """
    axis = -1
    act = None

    out_shape = broadcast_shape(x.shape, y.shape)
    if out_shape != x.shape:
        raise ValueError("The shape of broadcast output {} is different from that of inplace tensor {} in the Inplace operation.".format(out_shape, x.shape))

    out = _elementwise_op_in_dygraph(
        x, y, axis=axis, act=act, op_name='elementwise_sub_')
    return out


379
def divide(x, y, name=None):
380
    """
381
    Divide two tensors element-wise. The equation is:
382

383 384
    .. math::
        out = x / y
385

386 387
    **Note**:
    ``paddle.divide`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
388

389 390 391 392
    Args:
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
393

394
    Returns:
395
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.
396

397
    Examples:
398

399
        ..  code-block:: python
400

401
            import paddle
402

403 404
            x = paddle.to_tensor([2, 3, 4], dtype='float64')
            y = paddle.to_tensor([1, 5, 2], dtype='float64')
405
            z = paddle.divide(x, y)
406
            print(z)  # [2., 0.6, 2.]
407

408 409 410 411
    """
    op_type = 'elementwise_div'
    axis = -1
    act = None
J
Jiabin Yang 已提交
412 413 414 415 416 417 418 419
    if in_dygraph_mode():
        return _C_ops.final_state_divide( x, y)
    else:
        if _in_legacy_dygraph():
            return _elementwise_op_in_dygraph(
                x, y, axis=axis, act=act, op_name=op_type)
        else:
            return _elementwise_op(LayerHelper(op_type, **locals()))
420 421


422 423 424
def floor_divide(x, y, name=None):
    """
    Floor divide two tensors element-wise. The equation is:
425

426 427
    .. math::
        out = x // y
428

429 430
    **Note**:
    ``paddle.floor_divide`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
431

432 433 434 435
    Args:
        x (Tensor): the input tensor, it's data type should be int32, int64.
        y (Tensor): the input tensor, it's data type should be int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
436

437 438
    Returns:
        N-D Tensor. A location into which the result is stored. It's dimension equals with $x$.
439

440
    Examples:
441

442
        ..  code-block:: python
443

444
            import paddle
445

446 447
            x = paddle.to_tensor([2, 3, 8, 7])
            y = paddle.to_tensor([1, 5, 3, 3])
448
            z = paddle.floor_divide(x, y)
449
            print(z)  # [2, 0, 2, 2]
450

451 452 453
    """
    op_type = 'elementwise_floordiv'
    axis = -1
Z
zhiboniu 已提交
454
    if paddle.in_dynamic_mode():
455 456
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, op_name=op_type)
457

458
    return _elementwise_op(LayerHelper(op_type, **locals()))
459 460


461
def remainder(x, y, name=None):
462
    r"""
463 464 465
    Mod two tensors element-wise. The equation is:

    .. math::
466

467 468 469
        out = x \% y

    **Note**:
470
    ``paddle.remainder`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
471 472

    Args:
W
WangXi 已提交
473 474
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
475 476 477
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
478
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.
479 480 481 482 483 484 485

    Examples:

        ..  code-block:: python

            import paddle

486 487
            x = paddle.to_tensor([2, 3, 8, 7])
            y = paddle.to_tensor([1, 5, 3, 3])
488
            z = paddle.remainder(x, y)
W
WangXi 已提交
489
            print(z)  # [0, 3, 2, 1]
490 491 492

    """
    op_type = 'elementwise_mod'
493
    axis = -1
Z
zhiboniu 已提交
494
    if paddle.in_dynamic_mode():
495
        return _elementwise_op_in_dygraph(
496
            x, y, axis=axis, op_name=op_type)
497 498 499 500

    return _elementwise_op(LayerHelper(op_type, **locals()))


501 502
mod = remainder  # noqa: F841
floor_mod = remainder  # noqa: F841
503 504


505
def multiply(x, y, name=None):
506
    """
507
    multiply two tensors element-wise. The equation is:
508

509 510
    .. math::
        out = x * y
511

512 513
    **Note**:
    ``paddle.multiply`` supports broadcasting. If you would like to know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
514

515
    Args:
W
will-jl944 已提交
516 517
        x (Tensor): the input tensor, its data type should be one of float32, float64, int32, int64, bool.
        y (Tensor): the input tensor, its data type should be one of float32, float64, int32, int64, bool.
518
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
519

520
    Returns:
521
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.
522

523 524 525 526 527 528
    Examples:

        ..  code-block:: python

            import paddle

529 530
            x = paddle.to_tensor([[1, 2], [3, 4]])
            y = paddle.to_tensor([[5, 6], [7, 8]])
531
            res = paddle.multiply(x, y)
532
            print(res) # [[5, 12], [21, 32]]
533

534
            x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]])
535 536 537
            y = paddle.to_tensor([2])
            res = paddle.multiply(x, y)
            print(res) # [[[2, 4, 6], [2, 4, 6]]]
538 539 540 541

    """
    op_type = 'elementwise_mul'
    act = None
542
    axis = -1
543

J
Jiabin Yang 已提交
544 545 546 547 548 549 550 551 552 553 554
    if in_dygraph_mode():
        return _C_ops.final_state_multiply(x, y)
    else:
        if _in_legacy_dygraph():
            return _elementwise_op_in_dygraph(
                x, y, axis=axis, act=act, op_name=op_type)
        else:
            if x.dtype != y.dtype:
                raise TypeError(
                    'Input tensors must be same type, but received type of x: %s, type of y: %s '
                    % (x.dtype, y.dtype))
555

J
Jiabin Yang 已提交
556
            return _elementwise_op(LayerHelper(op_type, **locals()))
557

558
def maximum(x, y, name=None):
559
    """
W
Wei Shengyu 已提交
560
    Compare two tensors and returns a new tensor containing the element-wise maxima. The equation is:
561

562 563
    .. math::
        out = max(x, y)
564

565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
    **Note**:
    ``paddle.maximum`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .

    Args:
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.

    Examples:

        .. code-block:: python

            import numpy as np
            import paddle

            x = paddle.to_tensor([[1, 2], [7, 8]])
            y = paddle.to_tensor([[3, 4], [5, 6]])
            res = paddle.maximum(x, y)
            print(res)
            #    [[3, 4],
            #     [7, 8]]

            x = paddle.to_tensor([[1, 2, 3], [1, 2, 3]])
            y = paddle.to_tensor([3, 0, 4])
            res = paddle.maximum(x, y)
            print(res)
            #    [[3, 2, 4],
            #     [3, 2, 4]]

            x = paddle.to_tensor([2, 3, 5], dtype='float32')
            y = paddle.to_tensor([1, np.nan, np.nan], dtype='float32')
            res = paddle.maximum(x, y)
            print(res)
            #    [ 2., nan, nan]

            x = paddle.to_tensor([5, 3, np.inf], dtype='float32')
            y = paddle.to_tensor([1, -np.inf, 5], dtype='float32')
            res = paddle.maximum(x, y)
            print(res)
            #    [  5.,   3., inf.]
608 609
    """
    op_type = 'elementwise_max'
610
    axis = -1
611
    act = None
Z
zhiboniu 已提交
612
    if paddle.in_dynamic_mode():
613 614 615 616
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)
    return _elementwise_op(LayerHelper(op_type, **locals()))

617
def minimum(x, y, name=None):
618
    """
W
Wei Shengyu 已提交
619
    Compare two tensors and returns a new tensor containing the element-wise minima. The equation is:
620

621 622
    .. math::
        out = min(x, y)
623

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
    **Note**:
    ``paddle.minimum`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .

    Args:
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.

    Examples:

        .. code-block:: python

            import numpy as np
            import paddle

            x = paddle.to_tensor([[1, 2], [7, 8]])
            y = paddle.to_tensor([[3, 4], [5, 6]])
            res = paddle.minimum(x, y)
            print(res)
            #       [[1, 2],
            #        [5, 6]]

            x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]])
            y = paddle.to_tensor([3, 0, 4])
            res = paddle.minimum(x, y)
            print(res)
            #       [[[1, 0, 3],
            #         [1, 0, 3]]]

            x = paddle.to_tensor([2, 3, 5], dtype='float32')
            y = paddle.to_tensor([1, np.nan, np.nan], dtype='float32')
            res = paddle.minimum(x, y)
            print(res)
            #       [ 1., nan, nan]

            x = paddle.to_tensor([5, 3, np.inf], dtype='float64')
            y = paddle.to_tensor([1, -np.inf, 5], dtype='float64')
            res = paddle.minimum(x, y)
            print(res)
            #       [   1., -inf.,    5.]
667 668
    """
    op_type = 'elementwise_min'
669
    axis = -1
670
    act = None
Z
zhiboniu 已提交
671
    if paddle.in_dynamic_mode():
672 673 674
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)
    return _elementwise_op(LayerHelper(op_type, **locals()))
675

L
LJQ❤️ 已提交
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
def fmax(x, y, name=None):
    """
    Compares the elements at the corresponding positions of the two tensors and returns a new tensor containing the maximum value of the element.
    If one of them is a nan value, the other value is directly returned, if both are nan values, then the first nan value is returned.
    The equation is:

    .. math::
        out = fmax(x, y)

    **Note**:
    ``paddle.fmax`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .

    Args:
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.

    Examples:

        .. code-block:: python

            import numpy as np
            import paddle

            x = paddle.to_tensor([[1, 2], [7, 8]])
            y = paddle.to_tensor([[3, 4], [5, 6]])
            res = paddle.fmax(x, y)
            print(res)
            #    [[3, 4],
            #     [7, 8]]

            x = paddle.to_tensor([[1, 2, 3], [1, 2, 3]])
            y = paddle.to_tensor([3, 0, 4])
            res = paddle.fmax(x, y)
            print(res)
            #    [[3, 2, 4],
            #     [3, 2, 4]]

            x = paddle.to_tensor([2, 3, 5], dtype='float32')
            y = paddle.to_tensor([1, np.nan, np.nan], dtype='float32')
            res = paddle.fmax(x, y)
            print(res)
            #    [ 2., 3., 5.]

            x = paddle.to_tensor([5, 3, np.inf], dtype='float32')
            y = paddle.to_tensor([1, -np.inf, 5], dtype='float32')
            res = paddle.fmax(x, y)
            print(res)
            #    [  5.,   3., inf.]
    """
    op_type = 'elementwise_fmax'
    axis = -1
    act = None
732 733 734
    if in_dygraph_mode():
        return _C_ops.final_state_fmax(x, y, axis)
    if _in_legacy_dygraph():
L
LJQ❤️ 已提交
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)
    return _elementwise_op(LayerHelper(op_type, **locals()))

def fmin(x, y, name=None):
    """
    Compares the elements at the corresponding positions of the two tensors and returns a new tensor containing the minimum value of the element.
    If one of them is a nan value, the other value is directly returned, if both are nan values, then the first nan value is returned.
    The equation is:

    .. math::
        out = fmin(x, y)

    **Note**:
    ``paddle.fmin`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .

    Args:
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        N-D Tensor. A location into which the result is stored. If x, y have different shapes and are "broadcastable", the resulting tensor shape is the shape of x and y after broadcasting. If x, y have the same shape,  its shape is the same as x and y.

    Examples:

        .. code-block:: python

            import numpy as np
            import paddle

            x = paddle.to_tensor([[1, 2], [7, 8]])
            y = paddle.to_tensor([[3, 4], [5, 6]])
            res = paddle.fmin(x, y)
            print(res)
            #       [[1, 2],
            #        [5, 6]]

            x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]])
            y = paddle.to_tensor([3, 0, 4])
            res = paddle.fmin(x, y)
            print(res)
            #       [[[1, 0, 3],
            #         [1, 0, 3]]]

            x = paddle.to_tensor([2, 3, 5], dtype='float32')
            y = paddle.to_tensor([1, np.nan, np.nan], dtype='float32')
            res = paddle.fmin(x, y)
            print(res)
            #       [ 1., 3., 5.]

            x = paddle.to_tensor([5, 3, np.inf], dtype='float64')
            y = paddle.to_tensor([1, -np.inf, 5], dtype='float64')
            res = paddle.fmin(x, y)
            print(res)
            #       [   1., -inf.,    5.]
    """
    op_type = 'elementwise_fmin'
    axis = -1
    act = None
795 796 797
    if in_dygraph_mode():
        return _C_ops.final_state_fmin(x, y, axis)
    if _in_legacy_dygraph():
L
LJQ❤️ 已提交
798 799 800 801
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)
    return _elementwise_op(LayerHelper(op_type, **locals()))

802 803
for func in [
        add,
804
        multiply
805
]:
806
    proto_dict = {'add': 'elementwise_add', 'multiply': 'elementwise_mul'}
807 808
    op_proto = OpProtoHolder.instance().get_op_proto(proto_dict[func.__name__])

Y
Yang Zhang 已提交
809 810 811 812 813 814 815
    additional_args_lines = [
        "name (string, optional): Name of the output. \
        Default is None. It's used to print debug info for developers. Details: \
        :ref:`api_guide_Name` "
    ]

    func.__doc__ = _generate_doc_string_(
816 817
        op_proto,
        additional_args_lines=additional_args_lines,
818
        skip_attrs_set={"x_data_format", "y_data_format", "axis",
819
            "use_quantizer", "mkldnn_data_type", "Scale_x", "Scale_y", "Scale_out"
820
        }) + """\n""" + str(func.__doc__)
821

Y
Yang Zhang 已提交
822

823
def sum(x, axis=None, dtype=None, keepdim=False, name=None):
824 825 826 827
    """
    Computes the sum of tensor elements over the given dimension.

    Args:
828
        x (Tensor): An N-D Tensor, the data type is bool, float16, float32, float64, int32 or int64.
829 830
        axis (int|list|tuple, optional): The dimensions along which the sum is performed. If
            :attr:`None`, sum all elements of :attr:`x` and return a
N
Noel 已提交
831
            Tensor with a single element, otherwise must be in the
832 833 834 835 836 837 838
            range :math:`[-rank(x), rank(x))`. If :math:`axis[i] < 0`,
            the dimension to reduce is :math:`rank + axis[i]`.
        dtype (str, optional): The dtype of output Tensor. The default value is None, the dtype
            of output is the same as input Tensor `x`.
        keepdim (bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result Tensor will have one fewer dimension
            than the :attr:`x` unless :attr:`keepdim` is true, default
839
            value is False.
840
        name (str, optional): The default value is None. Normally there is no need for
841 842 843
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
844
        Tensor: Results of summation operation on the specified axis of input Tensor `x`,
845 846
        if `x.dtype='bool'`, `x.dtype='int32'`, it's data type is `'int64'`, 
        otherwise it's data type is the same as `x`.
847 848

    Raises:
849
        TypeError: The type of :attr:`axis` must be int, list or tuple.
850

851 852 853 854
    Examples:
        .. code-block:: python

            import paddle
855

856
            # x is a Tensor with following elements:
857 858 859
            #    [[0.2, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, 0.6, 0.7]]
            # Each example is followed by the corresponding output tensor.
860 861
            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
                                  [0.1, 0.2, 0.6, 0.7]])
862
            out1 = paddle.sum(x)  # [3.5]
863 864 865
            out2 = paddle.sum(x, axis=0)  # [0.3, 0.5, 1.1, 1.6]
            out3 = paddle.sum(x, axis=-1)  # [1.9, 1.6]
            out4 = paddle.sum(x, axis=1, keepdim=True)  # [[1.9], [1.6]]
866

867
            # y is a Tensor with shape [2, 2, 2] and elements as below:
868 869 870
            #      [[[1, 2], [3, 4]],
            #      [[5, 6], [7, 8]]]
            # Each example is followed by the corresponding output tensor.
871 872
            y = paddle.to_tensor([[[1, 2], [3, 4]], 
                                  [[5, 6], [7, 8]]])
873 874
            out5 = paddle.sum(y, axis=[1, 2]) # [10, 26]
            out6 = paddle.sum(y, axis=[0, 1]) # [16, 20]
875 876 877 878 879 880 881 882 883 884
            
            # x is a Tensor with following elements:
            #    [[True, True, True, True]
            #     [False, False, False, False]]
            # Each example is followed by the corresponding output tensor.
            x = paddle.to_tensor([[True, True, True, True],
                                  [False, False, False, False]])
            out7 = paddle.sum(x)  # [4]
            out8 = paddle.sum(x, axis=0)  # [1, 1, 1, 1]
            out9 = paddle.sum(x, axis=1)  # [4, 0]
885
    """
886 887 888 889 890 891 892 893 894 895 896
    if axis is not None and not isinstance(axis, (list, tuple)):
        axis = [axis]

    if not axis:
        reduce_all_flag = True
    else:
        if len(axis) == len(x.shape):
            reduce_all_flag = True
        else:
            reduce_all_flag = False

897 898 899 900 901 902 903 904 905
    def get_dtype(x, dtype):
        if dtype is not None:
            return (True, dtype)
        src_type = convert_dtype(x.dtype)
        if src_type in ['bool','int32', 'int64']:
            return (True, 'int64')
        return (False, src_type)

    dtype_flag, dtype = get_dtype(x, dtype)
Z
zhiboniu 已提交
906
    if paddle.in_dynamic_mode():
907
        axis = axis if axis != None and axis != [] else [0]
908
        if dtype_flag:
W
wanghuancoder 已提交
909
            return _C_ops.reduce_sum(x, 'dim', axis, 'keep_dim', keepdim,
910 911
                                       'reduce_all', reduce_all_flag, 'in_dtype',
                                       x.dtype, 'out_dtype',
912 913
                                       convert_np_dtype_to_dtype_(dtype))
        else:
W
wanghuancoder 已提交
914
            return _C_ops.reduce_sum(x, 'dim', axis, 'keep_dim', keepdim,
915
                                       'reduce_all', reduce_all_flag)
W
wanghuancoder 已提交
916 917 918 919 920 921 922

    attrs = {
        'dim': axis if axis != None and axis != [] and axis != () else [0],
        'keep_dim': keepdim,
        'reduce_all': reduce_all_flag
    }

923 924 925 926 927
    if dtype_flag:
        attrs.update({
            'in_dtype': x.dtype,
            'out_dtype': convert_np_dtype_to_dtype_(dtype)
        })
W
wanghuancoder 已提交
928

929
    check_variable_and_dtype(
930
        x, 'x', ['bool', 'float16', 'float32', 'float64',
931
                'int16', 'int32', 'int64', 'complex64', 'complex128',
932 933
                u'bool', u'float16', u'float32', u'float64',
                u'int32', u'int64', u'complex64', u'complex128'], 'sum')
934

935 936
    check_type(axis, 'axis', (int, list, tuple, type(None)), 'sum')

937 938 939 940 941
    helper = LayerHelper('sum', **locals())
    if dtype_flag:
        out = helper.create_variable_for_type_inference(
            dtype=convert_np_dtype_to_dtype_(dtype))
    else:
942
        out = helper.create_variable_for_type_inference(dtype=x.dtype)
943 944
    helper.append_op(
        type='reduce_sum',
945
        inputs={'X': x},
946 947 948
        outputs={'Out': out},
        attrs=attrs)
    return out
949

950

W
wangguanqun 已提交
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
def nansum(x, axis=None, dtype=None, keepdim=False, name=None):
    """
    Computes the sum of tensor elements over the given axis, treating Not a Numbers (NaNs) as zero.

    Args:
        x (Tensor): An N-D Tensor, the data type is float32, float64, int32 or int64.
        axis (int|list|tuple, optional): The dimensions along which the nansum is performed. If
            :attr:`None`, nansum all elements of :attr:`x` and return a
            Tensor with a single element, otherwise must be in the
            range :math:`[-rank(x), rank(x))`. If :math:`axis[i] < 0`,
            the dimension to reduce is :math:`rank + axis[i]`.
        dtype (str, optional): The dtype of output Tensor. The default value is None, the dtype
            of output is the same as input Tensor `x`.
        keepdim (bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result Tensor will have one fewer dimension
            than the :attr:`x` unless :attr:`keepdim` is true, default
            value is False.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: Results of summation operation on the specified axis of input Tensor `x`,

    Examples:
        .. code-block:: python

            import paddle
            import numpy as np

            # x is a Tensor with following elements:
            #    [[nan, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, -nan, 0.7]]
            # Each example is followed by the corresponding output tensor.
            x = np.array([[float('nan'), 0.3, 0.5, 0.9],
                            [0.1, 0.2, float('-nan'), 0.7]]).astype(np.float32)
            x = paddle.to_tensor(x)
            out1 = paddle.nansum(x)  # [2.7]
            out2 = paddle.nansum(x, axis=0)  # [0.1, 0.5, 0.5, 1.6]
            out3 = paddle.nansum(x, axis=-1)  # [1.7, 1.0]
            out4 = paddle.nansum(x, axis=1, keepdim=True)  # [[1.7], [1.0]]

            # y is a Tensor with shape [2, 2, 2] and elements as below:
            #      [[[1, nan], [3, 4]],
            #      [[5, 6], [-nan, 8]]]
            # Each example is followed by the corresponding output tensor.
            y = np.array([[[1, float('nan')], [3, 4]], 
                            [[5, 6], [float('-nan'), 8]]])
            y = paddle.to_tensor(y)
            out5 = paddle.nansum(y, axis=[1, 2]) # [8, 19]
            out6 = paddle.nansum(y, axis=[0, 1]) # [9, 18]
    """
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'nansum')
    check_type(axis, 'axis', (int, list, tuple, type(None)), 'nansum')

    zero_tensor = paddle.zeros_like(x)
    tmp_tensor = paddle.where(isnan(x), zero_tensor, x)
    return sum(tmp_tensor, axis, dtype, keepdim, name)


1011
@templatedoc(op_type="sum")
S
Steffy-zxf 已提交
1012
def add_n(inputs, name=None):
1013
    """
S
Steffy-zxf 已提交
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
    This OP is used to sum one or more Tensor of the input.
    
    For example:

    .. code-block:: text
    
        Case 1:

            Input:
                input.shape = [2, 3]
                input = [[1, 2, 3],
                         [4, 5, 6]]

            Output:
                output.shape = [2, 3]
                output = [[1, 2, 3],
                          [4, 5, 6]]

        Case 2:
       
            Input:
                First input:
                    input1.shape = [2, 3]
                    Input1 = [[1, 2, 3],
                              [4, 5, 6]]

                The second input:
                    input2.shape = [2, 3]
                    input2 = [[7, 8, 9],
                              [10, 11, 12]]

                Output:
                    output.shape = [2, 3]
                    output = [[8, 10, 12],
                              [14, 16, 18]]
1049 1050

    Args:
1051
        inputs (Tensor|list[Tensor]|tuple[Tensor]):  A Tensor or a list/tuple of Tensors. The shape and data type of the list/tuple elements should be consistent.
S
Steffy-zxf 已提交
1052
            Input can be multi-dimensional Tensor, and data types can be: float32, float64, int32, int64.
1053 1054 1055 1056
        name(str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
S
Steffy-zxf 已提交
1057
        Tensor, the sum of input :math:`inputs` , its shape and data types are consistent with :math:`inputs`.
1058 1059 1060 1061 1062 1063

    Examples:
        .. code-block:: python

            import paddle

S
Steffy-zxf 已提交
1064 1065 1066 1067 1068
            input0 = paddle.to_tensor([[1, 2, 3], [4, 5, 6]], dtype='float32')
            input1 = paddle.to_tensor([[7, 8, 9], [10, 11, 12]], dtype='float32')
            output = paddle.add_n([input0, input1])
            # [[8., 10., 12.], 
            #  [14., 16., 18.]]
1069
    """
Z
zhiboniu 已提交
1070
    if paddle.in_dynamic_mode():
S
Steffy-zxf 已提交
1071 1072
        if isinstance(inputs, Variable):
            inputs = [inputs]
W
wanghuancoder 已提交
1073
        return _C_ops.sum(inputs, 'use_mkldnn', False)
1074

S
Steffy-zxf 已提交
1075 1076
    helper = LayerHelper('add_n', **locals())
    check_type(inputs, 'inputs', (Variable, tuple, list), 'add_n')
1077 1078 1079 1080
    if isinstance(inputs, list) or isinstance(inputs, tuple):
        if len(inputs) > 0:
            for input in inputs:
                check_variable_and_dtype(input, "inputs", \
S
Steffy-zxf 已提交
1081
                   ['float32', 'float64', 'int32', 'int64'], 'add_n')
1082 1083
    else:
        check_variable_and_dtype(inputs, "inputs", \
S
Steffy-zxf 已提交
1084
                ['float32', 'float64', 'int32', 'int64'], 'add_n')
1085 1086


1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
    out = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype('inputs'))
    helper.append_op(
        type='sum',
        inputs={'X': inputs},
        outputs={'Out': out},
        attrs={'use_mkldnn': False})

    return out


1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
def trunc(input, name=None):
    '''
    This API is used to returns a new tensor with the truncated integer values of input.
    
    Args:
        input (Tensor): The input tensor, it's data type should be int32, int64, float32, float64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
    
    Returns:
        Tensor: The output Tensor of trunc.
    
    Examples:
        .. code-block:: python

            import paddle

            input = paddle.rand([2,2],'float32')
            print(input)
            # Tensor(shape=[2, 2], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #         [[0.02331470, 0.42374918],
            #         [0.79647720, 0.74970269]])

            output = paddle.trunc(input)
            print(output)
            # Tensor(shape=[2, 2], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #         [[0., 0.],
            #         [0., 0.]]))
    '''
J
Jiabin Yang 已提交
1126 1127
    if in_dygraph_mode():
        return  _C_ops.final_state_trunc(input)
1128
    else:
J
Jiabin Yang 已提交
1129 1130 1131 1132 1133
        if _in_legacy_dygraph():
            return _C_ops.trunc(input)
        else:
            inputs = {"X": input}
            attrs = {}
1134

J
Jiabin Yang 已提交
1135 1136 1137
            helper = LayerHelper("trunc", **locals())
            check_variable_and_dtype(input, 'X', ['int32', 'int64', 'float32', 'float64'], 'trunc')
            out = helper.create_variable_for_type_inference(dtype=input.dtype)
1138

J
Jiabin Yang 已提交
1139 1140 1141
            helper.append_op(
                type="trunc", inputs=inputs, attrs=attrs, outputs={"Out": out})
            return out
1142 1143 1144



W
WuHaobo 已提交
1145
def mm(input, mat2, name=None):
1146
    """
S
swtkiwi 已提交
1147

1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
    Applies matrix multiplication to two tensors.

    Currently, the input tensors' rank can be any, but when the rank of any
    inputs is bigger than 3, this two inputs' rank should be equal.


    Also note that if the raw tensor :math:`x` or :math:`mat2` is rank-1 and
    nontransposed, the prepended or appended dimension :math:`1` will be
    removed after matrix multiplication.

    Args:
1159
        input (Tensor): The input tensor which is a Tensor.
N
Noel 已提交
1160
        mat2 (Tensor): The input tensor which is a Tensor.
1161 1162 1163 1164
        name(str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
N
Noel 已提交
1165
        Tensor: The product Tensor.
1166

W
wawltor 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
    ::

        * example 1:

        input: [B, ..., M, K], mat2: [B, ..., K, N]
        out: [B, ..., M, N]

        * example 2:

        input: [B, M, K], mat2: [B, K, N]
        out: [B, M, N]

        * example 3:

        input: [B, M, K], mat2: [K, N]
        out: [B, M, N]

        * example 4:

        input: [M, K], mat2: [K, N]
        out: [M, N]

        * example 5:

        input: [B, M, K], mat2: [K]
        out: [B, M]

        * example 6:

        input: [K], mat2: [K]
        out: [1]

1199 1200 1201 1202
    Examples:
        .. code-block:: python

            import paddle
1203 1204 1205 1206 1207 1208 1209 1210
            input = paddle.arange(1, 7).reshape((3, 2)).astype('float32')
            mat2 = paddle.arange(1, 9).reshape((2, 4)).astype('float32')
            out = paddle.mm(input, mat2)
            print(out)
            #        [[11., 14., 17., 20.],
            #         [23., 30., 37., 44.],
            #         [35., 46., 57., 68.]])

N
Noel 已提交
1211

1212
    """
Z
zhiboniu 已提交
1213
    if paddle.in_dynamic_mode():
1214
        return _C_ops.matmul_v2(input, mat2)
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251

    def __check_input(x, y):
        var_names = {'x': x, 'y': y}
        for name, val in var_names.items():
            check_variable_and_dtype(val, name,
                                     ['float16', 'float32', 'float64'], 'mm')
        x_shape = list(x.shape)
        y_shape = list(y.shape)
        if len(x_shape) == 1:
            x_shape = [1] + x_shape
        if len(y_shape) == 1:
            y_shape = y_shape + [1]

        # check the inner 2 dimensions
        if x_shape[-1] != y_shape[-2]:
            if not ((x_shape[-1] == -1) or (y_shape[-2] == -1)):
                raise ValueError(
                    "After performing an optional transpose, Input X's width should be "
                    "equal to Y's width for multiplication "
                    "prerequisites. But received X's shape: %s, Y's shape: %s\n"
                    % (x_shape, y_shape))

        if len(y_shape) > 2 and len(x_shape) > 2:
            for i, dim_x in enumerate(x_shape[:-2]):
                # don't check neg shape
                if dim_x < 0 or y_shape[i] < 0:
                    continue
                if dim_x != y_shape[i]:
                    raise ValueError(
                        "When the matrix is larger than 2 dimensions, the higher "
                        "dimensional values of the two matrices need to be equal. "
                        "But received x_shape[%d] != y_shape[%d]. X's shape: %s, "
                        "Y's shape: %s.\n" % (i, i, x_shape, y_shape))

    __check_input(input, mat2)

    helper = LayerHelper('mm', **locals())
W
WuHaobo 已提交
1252
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
1253
    helper.append_op(
1254
        type='matmul_v2', inputs={'X': input,
1255 1256
                               'Y': mat2}, outputs={'Out': out})
    return out
1257

1258

Y
yaoxuefeng 已提交
1259
def addmm(input, x, y, beta=1.0, alpha=1.0, name=None):
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
    """
    **addmm**

    This operator is used to perform matrix multiplication for input $x$ and $y$.
    $input$ is added to the final result.
    The equation is:

    ..  math::
        Out = alpha * x * y + beta * input

    $Input$, $x$ and $y$ can carry the LoD (Level of Details) information, or not. But the output only shares the LoD information with input $input$.

    Args:
Y
yaoxuefeng 已提交
1273 1274 1275
        input (Tensor): The input Tensor to be added to the final result.
        x (Tensor): The first input Tensor for matrix multiplication.
        y (Tensor): The second input Tensor for matrix multiplication.
1276
        beta (float): Coefficient of $input$.
Y
yaoxuefeng 已提交
1277
        alpha (float): Coefficient of $x*y$.
1278 1279 1280
        name (str, optional): Name of the output. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. Default is None.

    Returns:
Y
yaoxuefeng 已提交
1281
        Tensor: The output Tensor of addmm op.
1282 1283 1284

    Examples:
        ..  code-block:: python
Y
yaoxuefeng 已提交
1285
            
1286 1287
            import paddle

Y
yaoxuefeng 已提交
1288 1289 1290
            x = paddle.ones([2,2])
            y = paddle.ones([2,2])
            input = paddle.ones([2,2])
Y
yaoxuefeng 已提交
1291

Y
yaoxuefeng 已提交
1292
            out = paddle.addmm( input=input, x=x, y=y, beta=0.5, alpha=5.0 )
Y
yaoxuefeng 已提交
1293

N
Noel 已提交
1294
            print(out)
1295 1296 1297
            # [[10.5 10.5]
            # [10.5 10.5]]
    """
Y
yaoxuefeng 已提交
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
    input_shape = input.shape
    x_shape = x.shape
    y_shape = y.shape
    if not len(input_shape) == len(x_shape) == len(y_shape) == 2:
        raise ValueError("The dimention of input, x, y should be 2 but receive input's shape: {}, x's shape: {}, y's shape: {}".format(input_shape, x_shape, y_shape))
    if input_shape[0] != x_shape[0]:
        if input_shape[0] != 1:
            raise ValueError( "When x's dimension[0] is not equal with input's dimension[0], input's dimension[0] must be 1 but got {}".format(input_shape[0]))
        if input_shape[1] != y_shape[1] and input_shape[1] != 1:
            raise ValueError( "When y's dimension[1] is not equal with input's dimension[1], input's dimension[1] must be 1 but got {}".format(input_shape[1]))
    if input_shape[1] != y_shape[1]:
        if input_shape[1] != 1:
            raise ValueError( "When y's dimension[1] is not equal with input's dimension[1], input's dimension[1] must be 1 but got {}".format(input_shape[1]))
        if input_shape[0] != x_shape[0] and input_shape[0] != 1:
            raise ValueError( "When x's dimension[0] is not equal with input's dimension[0], input's dimension[0] must be 1 but got {}".format(input_shape[0]))
    if x_shape[1] != y_shape[0]:
        raise ValueError("The input Variable x's width must be equal with Variable y' height. But received x's shape = {}, y's shape = {}.".format(x_shape, y_shape))



J
Jiabin Yang 已提交
1318 1319 1320 1321 1322 1323 1324 1325 1326
    if in_dygraph_mode():
        return _C_ops.final_state_addmm( input, x, y, alpha, beta)
    else:
        if _in_legacy_dygraph():
            out = _C_ops.addmm(input, x, y, "Alpha", alpha, "Beta", beta)
            return out
        else:
            inputs = {'Input': input, "X": x, "Y": y}
            attrs = {'Alpha': alpha, 'Beta': beta}
1327

J
Jiabin Yang 已提交
1328 1329 1330 1331 1332
            helper = LayerHelper("addmm", **locals())
            check_variable_and_dtype(input, 'Input', ['float32', 'float64'], 'addmm')
            check_variable_and_dtype(x, 'X', ['float32', 'float64'], 'addmm')
            check_variable_and_dtype(y, 'Y', ['float32', 'float64'], 'addmm')
            out = helper.create_variable_for_type_inference(dtype=x.dtype)
1333

J
Jiabin Yang 已提交
1334 1335 1336
            helper.append_op(
                type="addmm", inputs=inputs, attrs=attrs, outputs={"Out": out})
            return out
1337

S
seemingwang 已提交
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
def renorm(x, p, axis, max_norm):
    """
    **renorm**

    This operator is used to calculate the p-norm along the axis,
    suppose the input-shape on axis dimension has the value of T, then
    the tensor is split into T parts, the p-norm should be calculated for each
    part, if the p-norm for part i is larger than max-norm, then each element 
    in part i should be re-normalized at the same scale so that part-i' p-norm equals
    max-norm exactly, otherwise part-i stays unchanged.

    Args:
        x (Tensor): The input Tensor
        p (float): The power of the norm operation.
        axis (int): the dimension to slice the tensor.
        max-norm (float): the maximal norm limit.

    Returns:
        Tensor: the renorm Tensor.

    Examples:
        ..  code-block:: python
            
            import paddle
            input = [[[2.0,2,-2],[3,0.3,3]],[[2,-8,2],[3.1,3.7,3]]]
            x = paddle.to_tensor(input,dtype='float32')
            y = paddle.renorm(x, 1.0, 2, 2.05)
            print(y)        
    #        [[[ 0.40594056,  0.29285714, -0.41000000],
    #          [ 0.60891086,  0.04392857,  0.61500001]],
    #         [[ 0.40594056, -1.17142856,  0.41000000],
    #          [ 0.62920785,  0.54178572,  0.61500001]]])
    
    """
    input_shape = x.shape
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'renorm')
    if not axis < len(input_shape):
        raise ValueError("the axis:{} should be less then the shape's size {}:{}".format(axis,len(input_shape),input_shape))
    if not axis >=0:
        if not axis >= -1 * len(input_shape):
            raise ValueError("the axis:{} should not be less than -1 * length of input_shape:{}".format(axis,-1 * len(input_shape)))
        axis = axis + len(input_shape)
Z
zhiboniu 已提交
1380
    if paddle.in_dynamic_mode():
H
hong 已提交
1381
        out = _C_ops.renorm(x, 'p',p, 'axis',axis, 'max_norm', max_norm)
S
seemingwang 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
        return out

    inputs = {'X': x}
    attrs = {'p': p, 'axis': axis, 'max_norm':max_norm}

    helper = LayerHelper("renorm", **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)

    helper.append_op(
        type="renorm", inputs=inputs, attrs=attrs, outputs={"Out": out})
    return out

1394

Z
zhiboniu 已提交
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435

def inner(x, y, name=None):
    """

    Inner product of two input Tensor.
    
    Ordinary inner product for 1-D Tensors, in higher dimensions a sum product over the last axes.

    Args:
        x (Tensor): An N-D Tensor or a Scalar Tensor. If its not a scalar Tensor, its last dimensions must match y's.
        y (Tensor): An N-D Tensor or a Scalar Tensor. If its not a scalar Tensor, its last dimensions must match x's.
        name(str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: The inner-product Tensor, the output shape is x.shape[:-1] + y.shape[:-1].

    Examples:
        .. code-block:: python

            import paddle
            x = paddle.arange(1, 7).reshape((2, 3)).astype('float32')
            y = paddle.arange(1, 10).reshape((3, 3)).astype('float32')
            out = paddle.inner(x, y)
            print(out)
            #        ([[14, 32, 50],
            #         [32, 77, 122]])


    """
    if x.size == 1 or y.size == 1:
        return multiply(x, y)
    else:
        xshape = x.shape
        yshape = y.shape
        dstshape = list(xshape[:-1])+list(yshape[:-1])
        if len(dstshape)==0:
            dstshape = [1]
        nx = x.reshape((-1, xshape[-1]))
        ny = y.reshape((-1, yshape[-1]))

Z
zhiboniu 已提交
1436
        if paddle.in_dynamic_mode():
Z
zhiboniu 已提交
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
            return _C_ops.matmul_v2(nx, ny.T).reshape(dstshape)

        def __check_input(x, y):
            var_names = {'x': x, 'y': y}
            for name, val in var_names.items():
                check_variable_and_dtype(val, name,
                                        ['float16', 'float32', 'float64'], 'inner')
            x_shape = list(xshape)
            y_shape = list(yshape)

            # check the inner 2 dimensions
            if x_shape[-1] != y_shape[-1]:
                if not ((x_shape[-1] == -1) or (y_shape[-1] == -1)):
                    raise ValueError(
                        "After performing an optional transpose, Input X's last dim should be "
                        "equal to Y's last dim for multiplication "
                        "prerequisites. But received X's shape: %s, Y's shape: %s\n"
                        % (x_shape, y_shape))

        __check_input(nx, ny)

        helper = LayerHelper('inner', **locals())
        out = helper.create_variable_for_type_inference(dtype=nx.dtype)
        helper.append_op(
            type='matmul_v2', inputs={'X': nx,
                                'Y': ny.T}, outputs={'Out': out})
        return out.reshape(dstshape)


def outer(x, y, name=None):
    """

    Outer product of two Tensors.

    Input is flattened if not already 1-dimensional.

    Args:
        x (Tensor): An N-D Tensor or a Scalar Tensor. 
        y (Tensor): An N-D Tensor or a Scalar Tensor. 
        name(str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: The outer-product Tensor.

    Examples:
        .. code-block:: python

            import paddle
            x = paddle.arange(1, 4).astype('float32')
            y = paddle.arange(1, 6).astype('float32')
            out = paddle.outer(x, y)
            print(out)
            #        ([[1, 2, 3, 4, 5],
            #         [2, 4, 6, 8, 10],
            #         [3, 6, 9, 12, 15]])


    """
    nx = x.reshape((-1, 1))
    ny = y.reshape((1, -1))

Z
zhiboniu 已提交
1499
    if paddle.in_dynamic_mode():
Z
zhiboniu 已提交
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
        return _C_ops.matmul_v2(nx, ny)

    def __check_input(x, y):
        var_names = {'x': x, 'y': y}
        for name, val in var_names.items():
            check_variable_and_dtype(val, name,
                                     ['float16', 'float32', 'float64'], 'inner')

    __check_input(nx, ny)

    helper = LayerHelper('outer', **locals())
    out = helper.create_variable_for_type_inference(dtype=nx.dtype)
    helper.append_op(
        type='matmul_v2', inputs={'X': nx,
                               'Y': ny}, outputs={'Out': out})
    return out


1518
def logsumexp(x, axis=None, keepdim=False, name=None):
1519
    r"""
1520
    This OP calculates the log of the sum of exponentials of ``x`` along ``axis`` .
1521

1522
    .. math::
1523
       logsumexp(x) = \\log\\sum exp(x)
1524

1525
    Args:
S
Shang Zhizhou 已提交
1526 1527
        x (Tensor): The input Tensor with data type float32 or float64, which 
            have no more than 4 dimensions.
1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
        axis (int|list|tuple, optional): The axis along which to perform
            logsumexp calculations. ``axis`` should be int, list(int) or
            tuple(int). If ``axis`` is a list/tuple of dimension(s), logsumexp
            is calculated along all element(s) of ``axis`` . ``axis`` or
            element(s) of ``axis`` should be in range [-D, D), where D is the
            dimensions of ``x`` . If ``axis`` or element(s) of ``axis`` is
            less than 0, it works the same way as :math:`axis + D` . If
            ``axis`` is None, logsumexp is calculated along all elements of
            ``x``. Default is None.
        keepdim (bool, optional): Whether to reserve the reduced dimension(s)
            in the output Tensor. If ``keep_dim`` is True, the dimensions of
            the output Tensor is the same as ``x`` except in the reduced
            dimensions(it is of size 1 in this case). Otherwise, the shape of
            the output Tensor is squeezed in ``axis`` . Default is False.
        name (str, optional): Name for the operation (optional, default is None).
            For more information, please refer to :ref:`api_guide_Name`.
1544

1545
    Returns:
1546 1547
        Tensor, results of logsumexp along ``axis`` of ``x``, with the same data
        type as ``x``.
1548

1549
    Examples:
1550

1551
    .. code-block:: python
1552

1553 1554
        import paddle

1555
        x = paddle.to_tensor([[-1.5, 0., 2.], [3., 1.2, -2.4]])
1556 1557
        out1 = paddle.logsumexp(x) # [3.4691226]
        out2 = paddle.logsumexp(x, 1) # [2.15317821, 3.15684602]
1558 1559

    """
1560 1561 1562 1563 1564 1565 1566
    if isinstance(axis, int):
        axis = [axis]
    reduce_all = True if axis is None \
        or len(axis)==0 \
        or len(axis) == len(x.shape) else False
    if axis is None or len(axis) == 0:
        axis = [0]
1567

Z
zhiboniu 已提交
1568
    if paddle.in_dynamic_mode():
W
wanghuancoder 已提交
1569
        return _C_ops.logsumexp(x, 'axis', axis, 'keepdim', keepdim, 'reduce_all', reduce_all)
1570

1571 1572 1573
    check_variable_and_dtype(x, 'x',
                             ['float32', 'float64'],
                             'logsumexp')
1574

1575
    helper = LayerHelper('logsumexp', **locals())
1576
    attrs = {'axis': axis, 'keepdim': keepdim, 'reduce_all':reduce_all}
1577 1578 1579 1580
    out = helper.create_variable_for_type_inference(x.dtype)
    helper.append_op(
        type='logsumexp', inputs={'X': x}, outputs={'Out': out}, attrs=attrs)
    return out
1581

S
swtkiwi 已提交
1582

1583 1584
def inverse(x, name=None):
    """
1585 1586 1587 1588 1589
    Takes the inverse of the square matrix. A square matrix is a matrix with
    the same number of rows and columns. The input can be a square matrix
    (2-D Tensor) or batches of square matrices.

    Args:
1590
        x (Tensor): The input tensor. The last two
1591 1592 1593 1594 1595 1596 1597 1598
            dimensions should be equal. When the number of dimensions is
            greater than 2, it is treated as batches of square matrix. The data
            type can be float32 and float64.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information,
            please refer to :ref:`api_guide_Name`

    Returns:
1599
        Tensor: A Tensor holds the inverse of x. The shape and data type
1600
                        is the same as x.
1601 1602 1603 1604 1605

    Examples:
        .. code-block:: python

            import paddle
1606 1607

            mat = paddle.to_tensor([[2, 0], [0, 2]], dtype='float32')
1608 1609
            inv = paddle.inverse(mat)
            print(inv) # [[0.5, 0], [0, 0.5]]
1610 1611

    """
Z
zhiboniu 已提交
1612
    if paddle.in_dynamic_mode():
W
wanghuancoder 已提交
1613
        return _C_ops.inverse(x)
1614

1615 1616
    def _check_input(x):
        check_variable_and_dtype(x, 'x',
1617
                                 ['float32', 'float64'], 'inverse')
1618
        if len(x.shape) < 2:
1619 1620 1621
            raise ValueError(
                "The input of inverse is expected to be a Tensor whose number "
                "of dimensions is no less than 2. But reviced: %d, "
1622 1623
                "x's shape: %s." % (len(x.shape), x.shape))
    _check_input(x)
1624
    helper = LayerHelper('inverse', **locals())
1625
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
1626
    helper.append_op(
1627
        type='inverse', inputs={'Input': [x] }, outputs={'Output': [out]})
1628 1629
    return out

T
Tao Luo 已提交
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
def _get_reduce_all_value(axis):
    """
    Internal function for max, min, amax and amin. 
    It computes the attribute reduce_all value based on axis.
    """
    if axis is not None and not isinstance(axis, list):
        if isinstance(axis, tuple):
            axis = list(axis)
        elif isinstance(axis, int):
            axis= [axis]
        else:
            raise TypeError(
                "The type of axis must be int, list or tuple, but received {}".format(type(axis)))

    reduce_all = True if axis == None or axis == [] else False
    axis = axis if axis != None and axis != [] else [0]
    return reduce_all, axis
1647

1648
def max(x, axis=None, keepdim=False, name=None):
1649
    """
S
swtkiwi 已提交
1650

1651
    Computes the maximum of tensor elements over the given axis.
1652

T
Tao Luo 已提交
1653 1654 1655 1656 1657 1658
    Note:
        The difference between max and amax is: If there are multiple maximum elements,
        amax evenly distributes gradient between these equal values, 
        while max propagates gradient to all of them.


1659
    Args:
1660
        x(Tensor): A tensor, the data type is float32, float64, int32, int64.
1661
        axis(int|list|tuple, optional): The axis along which the maximum is computed.
1662
            If :attr:`None`, compute the maximum over all elements of
N
Noel 已提交
1663
            `x` and return a Tensor with a single element,
1664 1665 1666
            otherwise must be in the range :math:`[-x.ndim(x), x.ndim(x))`.
            If :math:`axis[i] < 0`, the axis to reduce is :math:`x.ndim + axis[i]`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the
1667
            output Tensor. The result tensor will have one fewer dimension
1668
            than the `x` unless :attr:`keepdim` is true, default
1669
            value is False.
1670
        name(str, optional): The default value is None.  Normally there is no need for
1671 1672 1673
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
1674
        Tensor, results of maximum on the specified axis of input tensor,
1675
        it's data type is the same as `x`.
1676 1677 1678

    Examples:
        .. code-block:: python
1679

1680
            import paddle
1681

N
Noel 已提交
1682
            # data_x is a Tensor with shape [2, 4]
1683
            # the axis is a int element
1684
            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
1685 1686
                                  [0.1, 0.2, 0.6, 0.7]], 
                                 dtype='float64', stop_gradient=False)
1687
            result1 = paddle.max(x)
1688 1689 1690 1691 1692
            result1.backward()
            print(result1, x.grad) 
            #[0.9], [[0., 0., 0., 1.], [0., 0., 0., 0.]]

            x.clear_grad()
1693
            result2 = paddle.max(x, axis=0)
1694 1695 1696 1697 1698
            result2.backward()
            print(result2, x.grad) 
            #[0.2, 0.3, 0.6, 0.9], [[1., 1., 0., 1.], [0., 0., 1., 0.]]

            x.clear_grad()
1699
            result3 = paddle.max(x, axis=-1)
1700 1701 1702 1703 1704
            result3.backward()
            print(result3, x.grad) 
            #[0.9, 0.7], [[0., 0., 0., 1.], [0., 0., 0., 1.]]

            x.clear_grad()
1705
            result4 = paddle.max(x, axis=1, keepdim=True)
1706 1707 1708
            result4.backward()
            print(result4, x.grad) 
            #[[0.9], [0.7]], [[0., 0., 0., 1.], [0., 0., 0., 1.]]
1709

N
Noel 已提交
1710
            # data_y is a Tensor with shape [2, 2, 2]
1711
            # the axis is list 
1712
            y = paddle.to_tensor([[[1.0, 2.0], [3.0, 4.0]],
1713 1714
                                  [[5.0, 6.0], [7.0, 8.0]]],
                                 dtype='float64', stop_gradient=False)
1715
            result5 = paddle.max(y, axis=[1, 2])
1716 1717 1718 1719 1720
            result5.backward()
            print(result5, y.grad) 
            #[4., 8.], [[[0., 0.], [0., 1.]], [[0., 0.], [0., 1.]]]

            y.clear_grad()
1721
            result6 = paddle.max(y, axis=[0, 1])
1722 1723 1724
            result6.backward()
            print(result6, y.grad) 
            #[7., 8.], [[[0., 0.], [0., 0.]], [[0., 0.], [1., 1.]]]
1725 1726
    """

T
Tao Luo 已提交
1727
    reduce_all, axis = _get_reduce_all_value(axis)
1728 1729 1730 1731 1732
    if in_dygraph_mode():
        if reduce_all:
            axis = range(len(x.shape))
        return _C_ops.final_state_max(x, axis, keepdim)
    if _in_legacy_dygraph():
W
wanghuancoder 已提交
1733
        return _C_ops.reduce_max(x, 'dim', axis, 'keep_dim', keepdim,
1734
                                   'reduce_all', reduce_all)
1735

1736
    helper = LayerHelper('max', **locals())
1737
    check_variable_and_dtype(
1738
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'max')
1739

1740
    out = helper.create_variable_for_type_inference(
1741
            dtype=x.dtype)
1742 1743
    helper.append_op(
        type='reduce_max',
1744
        inputs={'X': x},
1745 1746
        outputs={'Out': out},
        attrs={
1747 1748
            'dim': axis,
            'keep_dim': keepdim,
1749 1750 1751 1752
            'reduce_all': reduce_all
        })
    return out

1753
def min(x, axis=None, keepdim=False, name=None):
1754
    """
S
swtkiwi 已提交
1755

1756
    Computes the minimum of tensor elements over the given axis
1757

T
Tao Luo 已提交
1758 1759 1760 1761 1762
    Note:
        The difference between min and amin is: If there are multiple minimum elements,
        amin evenly distributes gradient between these equal values, 
        while min propagates gradient to all of them.

1763
    Args:
1764
        x(Tensor): A tensor, the data type is float32, float64, int32, int64.
1765
        axis(int|list|tuple, optional): The axis along which the minimum is computed.
1766
            If :attr:`None`, compute the minimum over all elements of
N
Noel 已提交
1767
            `x` and return a Tensor with a single element,
1768 1769 1770
            otherwise must be in the range :math:`[-x.ndim, x.ndim)`.
            If :math:`axis[i] < 0`, the axis to reduce is :math:`x.ndim + axis[i]`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the
1771
            output Tensor. The result tensor will have one fewer dimension
1772
            than the `x` unless :attr:`keepdim` is true, default
1773
            value is False.
W
WuHaobo 已提交
1774
        name(str, optional): The default value is None.  Normally there is no need for 
1775
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
1776

1777
    Returns:
1778
        Tensor, results of minimum on the specified axis of input tensor,
1779
        it's data type is the same as input's Tensor.
1780

1781 1782 1783
    Examples:
        .. code-block:: python

1784
            import paddle
1785

1786
            # data_x is a Tensor with shape [2, 4]
1787
            # the axis is a int element
1788
            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
1789 1790
                                  [0.1, 0.2, 0.6, 0.7]], 
                                 dtype='float64', stop_gradient=False)
1791
            result1 = paddle.min(x)
1792 1793 1794 1795 1796
            result1.backward()
            print(result1, x.grad) 
            #[0.1], [[0., 0., 0., 0.], [1., 0., 0., 0.]]

            x.clear_grad()
1797
            result2 = paddle.min(x, axis=0)
1798 1799 1800 1801 1802
            result2.backward()
            print(result2, x.grad) 
            #[0.1, 0.2, 0.5, 0.7], [[0., 0., 1., 0.], [1., 1., 0., 1.]]

            x.clear_grad()
1803
            result3 = paddle.min(x, axis=-1)
1804 1805 1806 1807 1808
            result3.backward()
            print(result3, x.grad) 
            #[0.2, 0.1], [[1., 0., 0., 0.], [1., 0., 0., 0.]]

            x.clear_grad()
1809
            result4 = paddle.min(x, axis=1, keepdim=True)
1810 1811 1812
            result4.backward()
            print(result4, x.grad) 
            #[[0.2], [0.1]], [[1., 0., 0., 0.], [1., 0., 0., 0.]]
1813

1814
            # data_y is a Tensor with shape [2, 2, 2]
1815
            # the axis is list 
1816
            y = paddle.to_tensor([[[1.0, 2.0], [3.0, 4.0]],
1817 1818
                                  [[5.0, 6.0], [7.0, 8.0]]],
                                 dtype='float64', stop_gradient=False)
1819
            result5 = paddle.min(y, axis=[1, 2])
1820 1821 1822 1823 1824
            result5.backward()
            print(result5, y.grad) 
            #[1., 5.], [[[1., 0.], [0., 0.]], [[1., 0.], [0., 0.]]]

            y.clear_grad()
1825
            result6 = paddle.min(y, axis=[0, 1])
1826 1827 1828
            result6.backward()
            print(result6, y.grad) 
            #[1., 2.], [[[1., 1.], [0., 0.]], [[0., 0.], [0., 0.]]]
1829
    """
1830

T
Tao Luo 已提交
1831
    reduce_all, axis = _get_reduce_all_value(axis)
1832 1833 1834 1835 1836 1837
    if in_dygraph_mode():
        if reduce_all:
            axis = range(len(x.shape))
        return _C_ops.final_state_min(x, axis, keepdim)

    if _in_legacy_dygraph():
W
wanghuancoder 已提交
1838
        return _C_ops.reduce_min(x, 'dim', axis, 'keep_dim', keepdim,
1839
                                   'reduce_all', reduce_all)
1840 1841 1842 1843 1844 1845

    helper = LayerHelper('min', **locals())
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'min')

    out = helper.create_variable_for_type_inference(
1846
            dtype=x.dtype)
1847 1848
    helper.append_op(
        type='reduce_min',
1849
        inputs={'X': x},
1850 1851
        outputs={'Out': out},
        attrs={
1852 1853
            'dim': axis,
            'keep_dim': keepdim,
1854 1855 1856 1857
            'reduce_all': reduce_all
        })
    return out

T
Tao Luo 已提交
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867
def amax(x, axis=None, keepdim=False, name=None):
    """
    Computes the maximum of tensor elements over the given axis.

    Note:
        The difference between max and amax is: If there are multiple maximum elements,
        amax evenly distributes gradient between these equal values, 
        while max propagates gradient to all of them.

    Args:
1868 1869
        x(Tensor): A tensor, the data type is float32, float64, int32, int64,
            the dimension is no more than 4.
T
Tao Luo 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
        axis(int|list|tuple, optional): The axis along which the maximum is computed.
            If :attr:`None`, compute the maximum over all elements of
            `x` and return a Tensor with a single element,
            otherwise must be in the range :math:`[-x.ndim(x), x.ndim(x))`.
            If :math:`axis[i] < 0`, the axis to reduce is :math:`x.ndim + axis[i]`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result tensor will have one fewer dimension
            than the `x` unless :attr:`keepdim` is true, default
            value is False.
        name(str, optional): The default value is None.  Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor, results of maximum on the specified axis of input tensor,
        it's data type is the same as `x`.

    Examples:
        .. code-block:: python

            import paddle
            # data_x is a Tensor with shape [2, 4] with multiple maximum elements
            # the axis is a int element

            x = paddle.to_tensor([[0.1, 0.9, 0.9, 0.9],
                                  [0.9, 0.9, 0.6, 0.7]], 
                                 dtype='float64', stop_gradient=False)
T
Tao Luo 已提交
1896 1897 1898 1899 1900
            # There are 5 maximum elements: 
            # 1) amax evenly distributes gradient between these equal values, 
            #    thus the corresponding gradients are 1/5=0.2;
            # 2) while max propagates gradient to all of them, 
            #    thus the corresponding gradient are 1.
T
Tao Luo 已提交
1901 1902 1903 1904 1905
            result1 = paddle.amax(x)
            result1.backward()
            print(result1, x.grad) 
            #[0.9], [[0., 0.2, 0.2, 0.2], [0.2, 0.2, 0., 0.]]

T
Tao Luo 已提交
1906 1907 1908 1909 1910 1911 1912 1913
            x.clear_grad()
            result1_max = paddle.max(x)
            result1_max.backward()
            print(result1_max, x.grad) 
            #[0.9], [[0., 1.0, 1.0, 1.0], [1.0, 1.0, 0., 0.]]

            ###############################

T
Tao Luo 已提交
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
            x.clear_grad()
            result2 = paddle.amax(x, axis=0)
            result2.backward()
            print(result2, x.grad) 
            #[0.9, 0.9, 0.9, 0.9], [[0., 0.5, 1., 1.], [1., 0.5, 0., 0.]]

            x.clear_grad()
            result3 = paddle.amax(x, axis=-1)
            result3.backward()
            print(result3, x.grad) 
            #[0.9, 0.9], [[0., 0.3333, 0.3333, 0.3333], [0.5, 0.5, 0., 0.]]

            x.clear_grad()
            result4 = paddle.amax(x, axis=1, keepdim=True)
            result4.backward()
            print(result4, x.grad) 
            #[[0.9], [0.9]], [[0., 0.3333, 0.3333, 0.3333.], [0.5, 0.5, 0., 0.]]

            # data_y is a Tensor with shape [2, 2, 2]
            # the axis is list 
            y = paddle.to_tensor([[[0.1, 0.9], [0.9, 0.9]],
                                  [[0.9, 0.9], [0.6, 0.7]]],
                                 dtype='float64', stop_gradient=False)
            result5 = paddle.amax(y, axis=[1, 2])
            result5.backward()
            print(result5, y.grad) 
            #[0.9., 0.9], [[[0., 0.3333], [0.3333, 0.3333]], [[0.5, 0.5], [0., 1.]]]

            y.clear_grad()
            result6 = paddle.amax(y, axis=[0, 1])
            result6.backward()
            print(result6, y.grad) 
            #[0.9., 0.9], [[[0., 0.3333], [0.5, 0.3333]], [[0.5, 0.3333], [1., 1.]]]
    """

    reduce_all, axis = _get_reduce_all_value(axis)
Z
zhiboniu 已提交
1950
    if paddle.in_dynamic_mode():
T
Tao Luo 已提交
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
        return _C_ops.reduce_amax(x, 'dim', axis, 'keep_dim', keepdim, 'reduce_all', reduce_all)

    helper = LayerHelper('amax', **locals())
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'amax')

    out = helper.create_variable_for_type_inference(
            dtype=x.dtype)
    helper.append_op(
        type='reduce_amax',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={
            'dim': axis,
            'keep_dim': keepdim,
            'reduce_all': reduce_all
        })
    return out

def amin(x, axis=None, keepdim=False, name=None):
    """

    Computes the minimum of tensor elements over the given axis

    Note:
        The difference between min and amin is: If there are multiple minimum elements,
        amin evenly distributes gradient between these equal values, 
        while min propagates gradient to all of them.

    Args:
1981 1982
        x(Tensor): A tensor, the data type is float32, float64, int32, int64, 
            the dimension is no more than 4.
T
Tao Luo 已提交
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008
        axis(int|list|tuple, optional): The axis along which the minimum is computed.
            If :attr:`None`, compute the minimum over all elements of
            `x` and return a Tensor with a single element,
            otherwise must be in the range :math:`[-x.ndim, x.ndim)`.
            If :math:`axis[i] < 0`, the axis to reduce is :math:`x.ndim + axis[i]`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result tensor will have one fewer dimension
            than the `x` unless :attr:`keepdim` is true, default
            value is False.
        name(str, optional): The default value is None.  Normally there is no need for 
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor, results of minimum on the specified axis of input tensor,
        it's data type is the same as input's Tensor.

    Examples:
        .. code-block:: python

            import paddle
            # data_x is a Tensor with shape [2, 4] with multiple minimum elements
            # the axis is a int element

            x = paddle.to_tensor([[0.2, 0.1, 0.1, 0.1],
                                  [0.1, 0.1, 0.6, 0.7]], 
                                 dtype='float64', stop_gradient=False)
T
Tao Luo 已提交
2009 2010 2011 2012 2013
            # There are 5 minimum elements: 
            # 1) amin evenly distributes gradient between these equal values, 
            #    thus the corresponding gradients are 1/5=0.2;
            # 2) while min propagates gradient to all of them, 
            #    thus the corresponding gradient are 1.
T
Tao Luo 已提交
2014 2015 2016 2017 2018
            result1 = paddle.amin(x)
            result1.backward()
            print(result1, x.grad) 
            #[0.1], [[0., 0.2, 0.2, 0.2], [0.2, 0.2, 0., 0.]]

T
Tao Luo 已提交
2019 2020 2021 2022 2023 2024 2025 2026
            x.clear_grad()
            result1_min = paddle.min(x)
            result1_min.backward()
            print(result1_min, x.grad) 
            #[0.1], [[0., 1.0, 1.0, 1.0], [1.0, 1.0, 0., 0.]]

            ###############################

T
Tao Luo 已提交
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
            x.clear_grad()
            result2 = paddle.amin(x, axis=0)
            result2.backward()
            print(result2, x.grad) 
            #[0.1, 0.1, 0.1, 0.1], [[0., 0.5, 1., 1.], [1., 0.5, 0., 0.]]

            x.clear_grad()
            result3 = paddle.amin(x, axis=-1)
            result3.backward()
            print(result3, x.grad) 
            #[0.1, 0.1], [[0., 0.3333, 0.3333, 0.3333], [0.5, 0.5, 0., 0.]]

            x.clear_grad()
            result4 = paddle.amin(x, axis=1, keepdim=True)
            result4.backward()
            print(result4, x.grad) 
            #[[0.1], [0.1]], [[0., 0.3333, 0.3333, 0.3333.], [0.5, 0.5, 0., 0.]]

            # data_y is a Tensor with shape [2, 2, 2]
            # the axis is list 
            y = paddle.to_tensor([[[0.2, 0.1], [0.1, 0.1]],
                                  [[0.1, 0.1], [0.6, 0.7]]],
                                 dtype='float64', stop_gradient=False)
            result5 = paddle.amin(y, axis=[1, 2])
            result5.backward()
            print(result5, y.grad) 
            #[0.1., 0.1], [[[0., 0.3333], [0.3333, 0.3333]], [[0.5, 0.5], [0., 1.]]]

            y.clear_grad()
            result6 = paddle.amin(y, axis=[0, 1])
            result6.backward()
            print(result6, y.grad) 
            #[0.1., 0.1], [[[0., 0.3333], [0.5, 0.3333]], [[0.5, 0.3333], [1., 1.]]]
    """

    reduce_all, axis = _get_reduce_all_value(axis)
Z
zhiboniu 已提交
2063
    if paddle.in_dynamic_mode():
T
Tao Luo 已提交
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
        return _C_ops.reduce_amin(x, 'dim', axis, 'keep_dim', keepdim, 'reduce_all', reduce_all)

    helper = LayerHelper('amin', **locals())
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'amin')

    out = helper.create_variable_for_type_inference(
            dtype=x.dtype)
    helper.append_op(
        type='reduce_amin',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={
            'dim': axis,
            'keep_dim': keepdim,
            'reduce_all': reduce_all
        })
    return out

W
WuHaobo 已提交
2083
def log1p(x, name=None):
2084
    r"""
2085
    Calculates the natural log of the given input tensor, element-wise.
N
Noel 已提交
2086

2087 2088
    .. math::
        Out = \\ln(x+1)
S
Steffy-zxf 已提交
2089

2090
    Args:
S
Steffy-zxf 已提交
2091
        x (Tensor): Input Tensor. Must be one of the following types: float32, float64.
2092 2093 2094
        name(str, optional): The default value is None.  Normally there is no need for 
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
    Returns:
S
Steffy-zxf 已提交
2095
        Tensor, the natural log of the input Tensor computed element-wise.
2096

2097 2098
    Examples:
        .. code-block:: python
S
Steffy-zxf 已提交
2099

2100
            import paddle
S
Steffy-zxf 已提交
2101 2102 2103 2104

            data = paddle.to_tensor([[0], [1]], dtype='float32')
            res = paddle.log1p(data)
            # [[0.], [0.6931472]]
2105 2106
    """

2107 2108 2109
    if in_dygraph_mode():
        return _C_ops.final_state_log1p(x)
    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2110
        return _C_ops.log1p(x)
2111 2112 2113 2114 2115

    check_variable_and_dtype(x, 'x', ['float32', 'float64'], "log1p")
    inputs = {'X': [x]}
    helper = LayerHelper('log1p', **locals())
    dtype = helper.input_dtype(input_param_name='x')
W
WuHaobo 已提交
2116
    out = helper.create_variable_for_type_inference(dtype)
2117 2118
    helper.append_op(type="log1p", inputs={"X": x}, outputs={"Out": out})
    return out
B
Bai Yifan 已提交
2119

J
joejiong 已提交
2120
def log2(x, name=None):
2121
    r"""
J
joejiong 已提交
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157
    Calculates the log to the base 2 of the given input tensor, element-wise.

    .. math::

        Out = \\log_2x

    Args:
        x (Tensor): Input tensor must be one of the following types: float32, float64.
        name (str|None): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`


    Returns:
        Tensor: The log to the base 2 of the input Tensor computed element-wise.

    Examples:

        .. code-block:: python
        
            import paddle

            # example 1: x is a float
            x_i = paddle.to_tensor([[1.0], [2.0]])
            res = paddle.log2(x_i) # [[0.], [1.0]]

            # example 2: x is float32
            x_i = paddle.full(shape=[1], fill_value=2, dtype='float32')
            paddle.to_tensor(x_i)
            res = paddle.log2(x_i)
            print(res) # [1.0]

            # example 3: x is float64
            x_i = paddle.full(shape=[1], fill_value=2, dtype='float64')
            paddle.to_tensor(x_i)
            res = paddle.log2(x_i)
            print(res) # [1.0]
    """
2158 2159 2160
    if in_dygraph_mode():
        return _C_ops.final_state_log2(x)
    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2161
        return _C_ops.log2(x)
J
joejiong 已提交
2162 2163 2164 2165 2166 2167 2168 2169

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], "log2")
    inputs = {'X': [x]}
    helper = LayerHelper('log2', **locals())
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
    helper.append_op(type="log2", inputs={"X": x}, outputs={"Out": out})
    return out
W
WuHaobo 已提交
2170

J
joejiong 已提交
2171 2172

def log10(x, name=None):
2173
    r"""
J
joejiong 已提交
2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209
    Calculates the log to the base 10 of the given input tensor, element-wise.

    .. math::

        Out = \\log_10_x

    Args:
        x (Tensor): Input tensor must be one of the following types: float32, float64.
        name (str|None): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`


    Returns:
        Tensor: The log to the base 10 of the input Tensor computed element-wise.

    Examples:

        .. code-block:: python
        
            import paddle

            # example 1: x is a float
            x_i = paddle.to_tensor([[1.0], [10.0]])
            res = paddle.log10(x_i) # [[0.], [1.0]]

            # example 2: x is float32
            x_i = paddle.full(shape=[1], fill_value=10, dtype='float32')
            paddle.to_tensor(x_i)
            res = paddle.log10(x_i)
            print(res) # [1.0]

            # example 3: x is float64
            x_i = paddle.full(shape=[1], fill_value=10, dtype='float64')
            paddle.to_tensor(x_i)
            res = paddle.log10(x_i)
            print(res) # [1.0]
    """
2210 2211 2212
    if in_dygraph_mode():
        return _C_ops.final_state_log10(x)
    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2213
        return _C_ops.log10(x)
J
joejiong 已提交
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], "log10")
    inputs = {'X': [x]}
    helper = LayerHelper('log10', **locals())
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
    helper.append_op(type="log10", inputs={"X": x}, outputs={"Out": out})
    return out


Y
Yang Zhang 已提交
2224
def clip(x, min=None, max=None, name=None):
2225
    """
Y
Yang Zhang 已提交
2226
    This operator clip all elements in input into the range [ min, max ] and return
2227 2228 2229 2230
    a resulting tensor as the following equation:

    .. math::

2231
        Out = MIN(MAX(x, min), max)
2232 2233

    Args:
2234 2235
        x (Tensor): An N-D Tensor with data type float32, float64, int32 or int64.
        min (float|int|Tensor): The lower bound with type ``float`` , ``int`` or a ``Tensor``
2236
            with shape [1] and type ``int32``, ``float32``, ``float64``.
2237
        max (float|int|Tensor): The upper bound with type ``float``, ``int`` or a ``Tensor``
2238 2239 2240 2241 2242 2243
            with shape [1] and type ``int32``, ``float32``, ``float64``.
        name (str, optional): The default value is None. Normally there is no
            need for user to set this property. For more information, please
            refer to :ref:`api_guide_Name`.

    Returns:
Y
Yang Zhang 已提交
2244
        Tensor: A Tensor with the same data type and data shape as input.
2245 2246 2247 2248 2249

    Examples:
        .. code-block:: python

            import paddle
N
Noel 已提交
2250

2251
            x1 = paddle.to_tensor([[1.2, 3.5], [4.5, 6.4]], 'float32')
Y
Yang Zhang 已提交
2252 2253
            out1 = paddle.clip(x1, min=3.5, max=5.0)
            out2 = paddle.clip(x1, min=2.5)
2254
            print(out1)
Y
Yang Zhang 已提交
2255 2256
            # [[3.5, 3.5]
            # [4.5, 5.0]]
2257
            print(out2)
Y
Yang Zhang 已提交
2258 2259
            # [[2.5, 3.5]
            # [[4.5, 6.4]
2260 2261
    """

2262 2263 2264 2265 2266 2267 2268 2269 2270 2271
    x_dtype = str(x.dtype)
    if x_dtype == 'paddle.int32':
        min_ = np.iinfo(np.int32).min
        max_ = np.iinfo(np.int32).max - 2**7
    elif x_dtype == 'paddle.int64':
        min_ = np.iinfo(np.int64).min
        max_ = np.iinfo(np.int64).max - 2**39
    else:
        min_ = float(np.finfo(np.float32).min)
        max_ = float(np.finfo(np.float32).max)
2272

Z
zhiboniu 已提交
2273
    if paddle.in_dynamic_mode():
2274 2275 2276 2277
        if isinstance(min, Variable):
            min = min.numpy().item(0)
        if isinstance(max, Variable):
            max = max.numpy().item(0)
2278 2279
        min = min_ if min is None else min
        max = max_ if max is None else max
W
wanghuancoder 已提交
2280
        return _C_ops.clip(x, "min", min, "max", max)
W
WuHaobo 已提交
2281

2282
    if min is not None:
Y
Yang Zhang 已提交
2283
        check_type(min, 'min', (float, int, Variable), 'clip')
2284 2285
        if isinstance(min, Variable):
            check_dtype(min.dtype, 'min', ['float32', 'float64', 'int32'],
Y
Yang Zhang 已提交
2286
                        'clip', '(When the type of min in clip is Variable.)')
2287
    if max is not None:
Y
Yang Zhang 已提交
2288
        check_type(max, 'max', (float, int, Variable), 'clip')
2289 2290
        if isinstance(max, Variable):
            check_dtype(max.dtype, 'max', ['float32', 'float64', 'int32'],
Y
Yang Zhang 已提交
2291
                        'clip', '(When the type of max in clip is Variable.)')
2292

2293
    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'], 'clip')
Y
Yang Zhang 已提交
2294 2295

    inputs = {'X': x}
2296
    attrs = {'min': min_, 'max': max_}
2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309

    if isinstance(min, Variable):
        min.stop_gradient = True
        inputs['Min'] = min
    elif min is not None:
        attrs['min'] = min

    if isinstance(max, Variable):
        max.stop_gradient = True
        inputs['Max'] = max
    elif max is not None:
        attrs['max'] = max

Y
Yang Zhang 已提交
2310
    helper = LayerHelper('clip', **locals())
W
WuHaobo 已提交
2311
    output = helper.create_variable_for_type_inference(
Y
Yang Zhang 已提交
2312
        dtype=helper.input_dtype('x'))
2313 2314 2315 2316
    helper.append_op(
        type='clip', inputs=inputs, outputs={'Out': [output]}, attrs=attrs)

    return output
F
Feiyu Chan 已提交
2317

W
WuHaobo 已提交
2318

2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332
@inplace_apis_in_dygraph_only
def clip_(x, min=None, max=None, name=None):
    """
    Inplace version of ``clip`` API, the output Tensor will be inplaced with input ``x``.
    Please refer to :ref:`api_tensor_clip`.
    """
    fmin = float(np.finfo(np.float32).min)
    fmax = float(np.finfo(np.float32).max)
    if isinstance(min, Variable):
        min = min.numpy().item(0)
    if isinstance(max, Variable):
        max = max.numpy().item(0)
    min = fmin if min is None else min
    max = fmax if max is None else max
W
wanghuancoder 已提交
2333
    return _C_ops.clip_(x, "min", min, "max", max)
2334 2335 2336



2337
def trace(x, offset=0, axis1=0, axis2=1, name=None):
L
Li Fuchen 已提交
2338
    """
2339
    **trace**
S
swtkiwi 已提交
2340

2341
    This OP computes the sum along diagonals of the input tensor x.
2342 2343

    If ``x`` is 2D, returns the sum of diagonal.
L
Li Fuchen 已提交
2344

2345
    If ``x`` has larger dimensions, then returns an tensor of diagonals sum, diagonals be taken from
2346
    the 2D planes specified by axis1 and axis2. By default, the 2D planes formed by the first and second axes
2347
    of the input tensor x.
L
Li Fuchen 已提交
2348

2349
    The argument ``offset`` determines where diagonals are taken from input tensor x:
L
Li Fuchen 已提交
2350 2351 2352 2353

    - If offset = 0, it is the main diagonal.
    - If offset > 0, it is above the main diagonal.
    - If offset < 0, it is below the main diagonal.
2354
    - Note that if offset is out of input's shape indicated by axis1 and axis2, 0 will be returned.
2355

L
Li Fuchen 已提交
2356
    Args:
2357
        x(Tensor): The input tensor x. Must be at least 2-dimensional. The input data type should be float32, float64, int32, int64.
2358 2359 2360
        offset(int, optional): Which diagonals in input tensor x will be taken. Default: 0 (main diagonals).
        axis1(int, optional): The first axis with respect to take diagonal. Default: 0.
        axis2(int, optional): The second axis with respect to take diagonal. Default: 1.
L
Li Fuchen 已提交
2361 2362 2363
        name (str, optional): Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. Default: None.

    Returns:
2364
        Tensor: the output data type is the same as input data type.
L
Li Fuchen 已提交
2365 2366 2367 2368 2369

    Examples:
        .. code-block:: python

            import paddle
2370

2371 2372 2373
            case1 = paddle.randn([2, 3])
            case2 = paddle.randn([3, 10, 10])
            case3 = paddle.randn([3, 10, 5, 10])
2374 2375 2376
            data1 = paddle.trace(case1) # data1.shape = [1]
            data2 = paddle.trace(case2, offset=1, axis1=1, axis2=2) # data2.shape = [3]
            data3 = paddle.trace(case3, offset=-3, axis1=1, axis2=-1) # data2.shape = [3, 5]
L
Li Fuchen 已提交
2377 2378
    """
    def __check_input(input, offset, dim1, dim2):
2379
        check_dtype(x.dtype, 'Input',
L
Li Fuchen 已提交
2380 2381 2382
                    ['int32', 'int64', 'float16', 'float32', 'float64'],
                    'trace')

2383
        input_shape = list(x.shape)
L
Li Fuchen 已提交
2384
        assert len(input_shape) >= 2,                     \
2385 2386
                "The x must be at least 2-dimensional, "   \
                "But received Input x's dimensional: %s.\n" %  \
L
Li Fuchen 已提交
2387 2388
                len(input_shape)

2389 2390
        axis1_ = axis1 if axis1 >= 0 else len(input_shape) + axis1
        axis2_ = axis2 if axis2 >= 0 else len(input_shape) + axis2
L
Li Fuchen 已提交
2391

X
XiangGao 已提交
2392
        assert ((0 <= axis1_) and (axis1_ < len(input_shape))),     \
2393 2394
            "The argument axis1 is out of range (expected to be in range of [%d, %d], but got %d).\n"  \
            % (-(len(input_shape)), len(input_shape) - 1, axis1)
L
Li Fuchen 已提交
2395

X
XiangGao 已提交
2396
        assert ((0 <= axis2_) and (axis2_ < len(input_shape))),   \
2397 2398
            "The argument axis2 is out of range (expected to be in range of [%d, %d], but got %d).\n"   \
            % (-(len(input_shape)), len(input_shape) - 1, axis2)
L
Li Fuchen 已提交
2399 2400


2401 2402 2403
        assert  axis1_ != axis2_,   \
               "axis1 and axis2 cannot be the same axis." \
                "But received axis1 = %d, axis2 = %d\n"%(axis1, axis2)
L
Li Fuchen 已提交
2404

W
wanghuancoder 已提交
2405
    __check_input(input, offset, axis1, axis2)
H
hong 已提交
2406 2407 2408 2409
    if in_dygraph_mode():
        return _C_ops.final_state_trace( x, offset, axis1, axis2 )

    if _in_legacy_dygraph():
X
XiangGao 已提交
2410 2411 2412 2413
        return _C_ops.trace(x, 'offset', offset, 'axis1', axis1, 'axis2', axis2)

    inputs = {'Input': [x]}
    attrs = {'offset': offset, 'axis1': axis1, 'axis2': axis2}
L
Li Fuchen 已提交
2414 2415
    helper = LayerHelper('trace', **locals())

2416
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
L
Li Fuchen 已提交
2417 2418 2419

    helper.append_op(
        type='trace',
2420
        inputs={'Input': [x]},
L
Li Fuchen 已提交
2421
        attrs={'offset': offset,
2422 2423
               'axis1': axis1,
               'axis2': axis2},
L
Li Fuchen 已提交
2424 2425 2426
        outputs={'Out': [out]})
    return out

2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491
def diagonal(x, offset=0, axis1=0, axis2=1, name=None):
    """
    This OP computes the diagonals of the input tensor x.

    If ``x`` is 2D, returns the diagonal.
    If ``x`` has larger dimensions, diagonals be taken from the 2D planes specified by axis1 and axis2. 
    By default, the 2D planes formed by the first and second axis of the input tensor x.

    The argument ``offset`` determines where diagonals are taken from input tensor x:

    - If offset = 0, it is the main diagonal.
    - If offset > 0, it is above the main diagonal.
    - If offset < 0, it is below the main diagonal.
    
    Args:
        x(Tensor): The input tensor x. Must be at least 2-dimensional. The input data type should be bool, int32, int64, float16, float32, float64.
        offset(int, optional): Which diagonals in input tensor x will be taken. Default: 0 (main diagonals).
        axis1(int, optional): The first axis with respect to take diagonal. Default: 0.
        axis2(int, optional): The second axis with respect to take diagonal. Default: 1.
        name (str, optional): Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. Default: None.

    Returns:
        Tensor: a partial view of input tensor in specify two dimensions, the output data type is the same as input data type.

    Examples:
        .. code-block:: python

            import paddle

            x = paddle.rand([2,2,3],'float32')
            print(x)
            # Tensor(shape=[2, 2, 3], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #        [[[0.45661032, 0.03751532, 0.90191704],
            #          [0.43760979, 0.86177313, 0.65221709]],

            #         [[0.17020577, 0.00259554, 0.28954273],
            #          [0.51795638, 0.27325270, 0.18117726]]])

            out1 = paddle.diagonal(x)
            print(out1)
            #Tensor(shape=[3, 2], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [[0.45661032, 0.51795638],
            #        [0.03751532, 0.27325270],
            #        [0.90191704, 0.18117726]])

            out2 = paddle.diagonal(x, offset=0, axis1=2, axis2=1)
            print(out2)
            #Tensor(shape=[2, 2], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [[0.45661032, 0.86177313],
            #        [0.17020577, 0.27325270]])

            out3 = paddle.diagonal(x, offset=1, axis1=0, axis2=1)
            print(out3)
            #Tensor(shape=[3, 1], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [[0.43760979],
            #        [0.86177313],
            #        [0.65221709]])

            out4 = paddle.diagonal(x, offset=0, axis1=1, axis2=2)
            print(out4)
            #Tensor(shape=[2, 2], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [[0.45661032, 0.86177313],
            #        [0.17020577, 0.27325270]])
            
    """
J
Jiabin Yang 已提交
2492 2493 2494 2495 2496
    if in_dygraph_mode():
        return _C_ops.final_state_diagonal(x, offset, axis1, axis2)
    else:
        if _in_legacy_dygraph():
            return _C_ops.diagonal(x, 'offset', offset, 'axis1', axis1, 'axis2', axis2)
W
wanghuancoder 已提交
2497

2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
    def __check_input(input, offset, dim1, dim2):
        check_dtype(x.dtype, 'Input',
                    ['bool', 'int32', 'int64', 'float16', 'float32', 'float64'],
                    'diagonal')

        input_shape = list(x.shape)
        assert len(input_shape) >= 2,                     \
                "The x must be at least 2-dimensional, "   \
                "But received Input x's dimensional: %s.\n" %  \
                len(input_shape)

        axis1_ = axis1 if axis1 >= 0 else len(input_shape) + axis1
        axis2_ = axis2 if axis2 >= 0 else len(input_shape) + axis2

        assert axis1_ < len(input_shape),     \
            "The argument axis1 is out of range (expected to be in range of [%d, %d], but got %d).\n"  \
            % (-(len(input_shape)), len(input_shape) - 1, axis1)

        assert axis2_ < len(input_shape),   \
            "The argument axis2 is out of range (expected to be in range of [%d, %d], but got %d).\n"   \
            % (-(len(input_shape)), len(input_shape) - 1, axis2)

        assert  axis1_ != axis2_,   \
               "axis1 and axis2 cannot be the same axis." \
                "But received axis1 = %d, axis2 = %d\n"%(axis1, axis2)

    __check_input(input, offset, axis1, axis2)
    helper = LayerHelper('diagonal', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)

    helper.append_op(
        type='diagonal',
        inputs={'Input': [x]},
        attrs={'offset': offset,
               'axis1': axis1,
               'axis2': axis2},
               outputs={'Out': [out]})
    return out


F
Feiyu Chan 已提交
2538
@templatedoc(op_type="kron")
W
WuHaobo 已提交
2539
def kron(x, y, name=None):
S
swtkiwi 已提交
2540 2541 2542
    """

${comment}
F
Feiyu Chan 已提交
2543 2544

    Args:
N
Noel 已提交
2545
        x (Tensor): the fist operand of kron op, data type: float16, float32,
F
Feiyu Chan 已提交
2546
            float64, int32 or int64.
N
Noel 已提交
2547
        y (Tensor): the second operand of kron op, data type: float16,
2548
            float32, float64, int32 or int64. Its data type should be the same
F
Feiyu Chan 已提交
2549
            with x.
2550 2551
        name(str, optional): The default value is None.  Normally there is no
            need for user to set this property.  For more information, please
F
Feiyu Chan 已提交
2552 2553 2554
            refer to :ref:`api_guide_Name`.

    Returns:
N
Noel 已提交
2555
        Tensor: The output of kron op, data type: float16, float32, float64, int32 or int64. Its data is the same with x.
F
Feiyu Chan 已提交
2556 2557 2558

    Examples:
        .. code-block:: python
2559

2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570
            import paddle
            x = paddle.to_tensor([[1, 2], [3, 4]], dtype='int64')
            y = paddle.to_tensor([[1, 2, 3], [4, 5, 6], [7, 8, 9]], dtype='int64')
            out = paddle.kron(x, y)
            print(out)
            #        [[1, 2, 3, 2, 4, 6],
            #         [ 4,  5,  6,  8, 10, 12],
            #         [ 7,  8,  9, 14, 16, 18],
            #         [ 3,  6,  9,  4,  8, 12],
            #         [12, 15, 18, 16, 20, 24],
            #         [21, 24, 27, 28, 32, 36]])
F
Feiyu Chan 已提交
2571
    """
Z
zhiboniu 已提交
2572
    if paddle.in_dynamic_mode():
W
wanghuancoder 已提交
2573
        return _C_ops.kron(x, y)
F
Feiyu Chan 已提交
2574 2575 2576 2577 2578

    helper = LayerHelper('kron', **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'kron')
    check_variable_and_dtype(y, 'y', ['float16', 'float32', 'float64', 'int32', 'int64'], 'kron')

W
WuHaobo 已提交
2579
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
F
Feiyu Chan 已提交
2580 2581
    helper.append_op(type="kron", inputs={"X": x, "Y": y}, outputs={"Out": out})
    return out
2582 2583 2584 2585


def cumsum(x, axis=None, dtype=None, name=None):
    """
2586 2587 2588 2589
    The cumulative sum of the elements along a given axis. 
    
    **Note**:
    The first element of the result is the same of the first element of the input. 
2590 2591

    Args:
2592
        x (Tensor): The input tensor needed to be cumsumed.
2593 2594 2595 2596 2597
        axis (int, optional): The dimension to accumulate along. -1 means the last dimension. The default (None) is to compute the cumsum over the flattened array.
        dtype (str, optional): The data type of the output tensor, can be float32, float64, int32, int64. If specified, the input tensor is casted to dtype before the operation is performed. This is useful for preventing data type overflows. The default value is None. 
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
2598
        Tensor, the result of cumsum operator. 
2599 2600 2601 2602 2603

    Examples:
        .. code-block:: python
            
            import paddle
2604 2605 2606
            
            data = paddle.arange(12)
            data = paddle.reshape(data, (3, 4))
2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629

            y = paddle.cumsum(data)
            # [ 0  1  3  6 10 15 21 28 36 45 55 66]

            y = paddle.cumsum(data, axis=0)
            # [[ 0  1  2  3]
            #  [ 4  6  8 10]
            #  [12 15 18 21]]
            
            y = paddle.cumsum(data, axis=-1)
            # [[ 0  1  3  6]
            #  [ 4  9 15 22]
            #  [ 8 17 27 38]]

            y = paddle.cumsum(data, dtype='float64')
            print(y.dtype)
            # VarType.FP64
    """
    if axis is None:
        flatten = True
    else:
        flatten = False
    if dtype is not None and x.dtype != convert_np_dtype_to_dtype_(dtype):
Z
zhiboniu 已提交
2630
        x = cast(x, dtype)
2631

H
hong 已提交
2632 2633 2634
    if in_dygraph_mode():
        return _C_ops.final_state_cumsum(x, axis, flatten, False, False)
    if _in_legacy_dygraph():
2635
        if axis is None:
W
wanghuancoder 已提交
2636
            return _C_ops.cumsum(x, 'flatten', flatten)
2637
        else:
W
wanghuancoder 已提交
2638
            return _C_ops.cumsum(x, 'axis', axis, 'flatten', flatten)
2639 2640 2641 2642 2643 2644 2645 2646 2647

    check_type(x, 'x', (Variable), 'cumsum')
    locals_var = locals().copy()
    kwargs = dict()
    for name, val in locals_var.items():
        if val is not None:
            kwargs[name] = val
    _cum_sum_ = generate_layer_fn('cumsum')
    return _cum_sum_(**kwargs)
G
guofei 已提交
2648

H
hlygit66666 已提交
2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
def cumprod(x, dim=None, dtype=None, name=None):
    """
    Compute the cumulative product of the input tensor x along a given dimension dim.

    **Note**:
    The first element of the result is the same as the first element of the input.

    Args:
        x (Tensor): the input tensor need to be cumproded.
        dim (int): the dimension along which the input tensor will be accumulated. It need to be in the range of [-x.rank, x.rank), where x.rank means the dimensions of the input tensor x and -1 means the last dimension.
        dtype (str, optional): The data type of the output tensor, can be float32, float64, int32, int64, complex64, complex128. If specified, the input tensor is casted to dtype before the operation is performed. This is useful for preventing data type overflows. The default value is None.
H
hlygit66666 已提交
2660
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
H
hlygit66666 已提交
2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696

    Returns:
        Tensor, the result of cumprod operator.

    Examples:
        .. code-block:: python

            import paddle

            data = paddle.arange(12)
            data = paddle.reshape(data, (3, 4))
            # [[ 0  1  2  3 ]
            #  [ 4  5  6  7 ]
            #  [ 8  9  10 11]]

            y = paddle.cumprod(data, dim=0)
            # [[ 0  1   2   3]
            #  [ 0  5  12  21]
            #  [ 0 45 120 231]]

            y = paddle.cumprod(data, dim=-1)
            # [[ 0   0   0    0]
            #  [ 4  20 120  840]
            #  [ 8  72 720 7920]]

            y = paddle.cumprod(data, dim=1, dtype='float64')
            # [[ 0.   0.   0.    0.]
            #  [ 4.  20. 120.  840.]
            #  [ 8.  72. 720. 7920.]]

            print(y.dtype)
            # paddle.float64

    """

    if dtype is not None and x.dtype != convert_np_dtype_to_dtype_(dtype):
Z
zhiboniu 已提交
2697
        x = cast(x, dtype)
H
hlygit66666 已提交
2698

2699 2700 2701
    if in_dygraph_mode():
        return _C_ops.final_state_cumprod(x, dim)
    if _in_legacy_dygraph():
H
hlygit66666 已提交
2702 2703 2704 2705 2706 2707 2708 2709 2710 2711
        return _C_ops.cumprod(x, 'dim', dim)

    check_variable_and_dtype(x, "x", ['complex64', 'complex128', 'float32', 'float64', 'int32', 'int64'], 'cumprod')
    check_type(dim, 'dim', int, 'cumprod')

    helper = LayerHelper('cumprod', **locals())
    out = helper.create_variable_for_type_inference(x.dtype)
    helper.append_op(type='cumprod', inputs={'X': x}, outputs={'Out': out}, attrs={'dim': dim})
    return out

J
Jack Zhou 已提交
2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
def isfinite(x, name=None):
    """

    Return whether every element of input tensor is finite number or not.

    Args:
        x (Tensor): The input tensor, it's data type should be float16, float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        `Tensor`, the bool result which shows every element of `x` whether it is finite number or not.

    Examples:
        .. code-block:: python

            import paddle
N
Noel 已提交
2728

2729
            x = paddle.to_tensor([float('-inf'), -2, 3.6, float('inf'), 0, float('-nan'), float('nan')])
J
Jack Zhou 已提交
2730
            out = paddle.tensor.isfinite(x)
N
Noel 已提交
2731
            print(out)  # [False  True  True False  True False False]
J
Jack Zhou 已提交
2732
    """
H
hong 已提交
2733 2734 2735
    if in_dygraph_mode():
        return _C_ops.final_state_isfinite( x )
    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2736
        return _C_ops.isfinite_v2(x)
J
Jack Zhou 已提交
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758
    helper = LayerHelper("isfinite_v2", **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'isfinite')
    out = helper.create_variable_for_type_inference('bool')
    helper.append_op(type="isfinite_v2", inputs={"X": x}, outputs={"Out": out})
    return out

def isinf(x, name=None):
    """

    Return whether every element of input tensor is `+/-INF` or not.

    Args:
        x (Tensor): The input tensor, it's data type should be float16, float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        `Tensor`, the bool result which shows every element of `x` whether it is `+/-INF` or not.

    Examples:
        .. code-block:: python

            import paddle
2759
            x = paddle.to_tensor([float('-inf'), -2, 3.6, float('inf'), 0, float('-nan'), float('nan')])
J
Jack Zhou 已提交
2760
            out = paddle.tensor.isinf(x)
N
Noel 已提交
2761
            print(out)  # [ True False False  True False False False]
J
Jack Zhou 已提交
2762
    """
H
hong 已提交
2763 2764 2765
    if in_dygraph_mode():
        return _C_ops.final_state_isinf( x )
    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2766
        return _C_ops.isinf_v2(x)
J
Jack Zhou 已提交
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788
    helper = LayerHelper("isinf_v2", **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'isinf')
    out = helper.create_variable_for_type_inference(dtype='bool')
    helper.append_op(type="isinf_v2", inputs={"X": x}, outputs={"Out": out})
    return out

def isnan(x, name=None):
    """

    Return whether every element of input tensor is `NaN` or not.

    Args:
        x (Tensor): The input tensor, it's data type should be float16, float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        `Tensor`, the bool result which shows every element of `x` whether it is `NaN` or not.

    Examples:
        .. code-block:: python

            import paddle
2789
            x = paddle.to_tensor([float('-inf'), -2, 3.6, float('inf'), 0, float('-nan'), float('nan')])
J
Jack Zhou 已提交
2790
            out = paddle.tensor.isnan(x)
N
Noel 已提交
2791
            print(out)  # [False False False False False  True  True]
J
Jack Zhou 已提交
2792
    """
H
hong 已提交
2793 2794 2795 2796
    if in_dygraph_mode():
        return _C_ops.final_state_isnan( x )

    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2797
        return _C_ops.isnan_v2(x)
J
Jack Zhou 已提交
2798 2799 2800 2801 2802 2803 2804
    helper = LayerHelper("isnan_v2", **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'isnan')
    out = helper.create_variable_for_type_inference(dtype='bool')
    helper.append_op(type="isnan_v2", inputs={"X": x}, outputs={"Out": out})
    return out


G
guofei 已提交
2805 2806 2807 2808 2809
def prod(x, axis=None, keepdim=False, dtype=None, name=None):
    """
    Compute the product of tensor elements over the given axis.

    Args:
2810
        x(Tensor): The input tensor, its data type should be float32, float64, int32, int64.
G
guofei 已提交
2811 2812 2813 2814 2815 2816 2817 2818 2819
        axis(int|list|tuple, optional): The axis along which the product is computed. If :attr:`None`, 
            multiply all elements of `x` and return a Tensor with a single element, 
            otherwise must be in the range :math:`[-x.ndim, x.ndim)`. If :math:`axis[i]<0`, 
            the axis to reduce is :math:`x.ndim + axis[i]`. Default is None.
        dtype(str|np.dtype, optional): The desired date type of returned tensor, can be float32, float64, 
            int32, int64. If specified, the input tensor is casted to dtype before operator performed. 
            This is very useful for avoiding data type overflows. The default value is None, the dtype 
            of output is the same as input Tensor `x`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the output Tensor. The result 
2820
            tensor will have one fewer dimension than the input unless `keepdim` is true. Default is False.
G
guofei 已提交
2821 2822 2823 2824 2825 2826 2827 2828 2829
        name(string, optional): The default value is None. Normally there is no need for user to set this property.
            For more information, please refer to :ref:`api_guide_Name` .

    Returns:
        Tensor, result of product on the specified dim of input tensor.

    Raises:
        ValueError: The :attr:`dtype` must be float32, float64, int32 or int64.
        TypeError: The type of :attr:`axis` must be int, list or tuple.
J
Jack Zhou 已提交
2830
    
G
guofei 已提交
2831 2832 2833 2834 2835 2836
    Examples:
        .. code-block:: python

            import paddle

            # the axis is a int element
2837 2838
            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
                                  [0.1, 0.2, 0.6, 0.7]])
G
guofei 已提交
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854
            out1 = paddle.prod(x)
            # [0.0002268]

            out2 = paddle.prod(x, -1)
            # [0.027  0.0084]

            out3 = paddle.prod(x, 0)
            # [0.02 0.06 0.3  0.63]

            out4 = paddle.prod(x, 0, keepdim=True)
            # [[0.02 0.06 0.3  0.63]]

            out5 = paddle.prod(x, 0, dtype='int64')
            # [0 0 0 0]

            # the axis is list
2855 2856
            y = paddle.to_tensor([[[1.0, 2.0], [3.0, 4.0]],
                                  [[5.0, 6.0], [7.0, 8.0]]])
G
guofei 已提交
2857 2858 2859 2860 2861 2862 2863 2864 2865 2866
            out6 = paddle.prod(y, [0, 1])
            # [105. 384.]

            out7 = paddle.prod(y, (1, 2))
            # [  24. 1680.]

    """
    if dtype is not None:
        check_dtype(dtype, 'dtype', ['float32', 'float64', 'int32', 'int64'], 'prod')
        if x.dtype != convert_np_dtype_to_dtype_(dtype):
Z
zhiboniu 已提交
2867
            x = cast(x, dtype)
G
guofei 已提交
2868

Z
zhiboniu 已提交
2869
    return reduce_prod(input=x, dim=axis, keep_dim=keepdim, name=name)
W
WangXi 已提交
2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888


def sign(x, name=None):
    """
    This OP returns sign of every element in `x`: 1 for positive, -1 for negative and 0 for zero.

    Args:
        x(Tensor): The input tensor. The data type can be float16, float32 or float64.
        name (str, optional): The default value is None. Normally there is no need for user to
            set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: The output sign tensor with identical shape and data type to the input :attr:`x`.

    Examples:
        .. code-block:: python

          import paddle

2889
          x = paddle.to_tensor([3.0, 0.0, -2.0, 1.7], dtype='float32')
W
WangXi 已提交
2890 2891 2892
          out = paddle.sign(x=x)
          print(out)  # [1.0, 0.0, -1.0, 1.0]
    """
H
hong 已提交
2893 2894 2895 2896
    if in_dygraph_mode():
        return _C_ops.final_state_sign(x)

    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2897
        return _C_ops.sign(x)
W
WangXi 已提交
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'sign')
    helper = LayerHelper("sign", **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)

    helper.append_op(type='sign', inputs={'X': [x]}, outputs={'Out': [out]})

    return out


def tanh(x, name=None):
2909
    r"""
W
WangXi 已提交
2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927
    Tanh Activation Operator.

    .. math::
        out = \\frac{e^{x} - e^{-x}}{e^{x} + e^{-x}}

    Args:
        x (Tensor): Input of Tanh operator, an N-D Tensor, with data type float32, float64 or float16.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        Output of Tanh operator, a Tensor with same data type and shape as input.

    Examples:

        .. code-block:: python

            import paddle

2928
            x = paddle.to_tensor([-0.4, -0.2, 0.1, 0.3])
W
WangXi 已提交
2929
            out = paddle.tanh(x)
N
Noel 已提交
2930
            print(out)
W
WangXi 已提交
2931 2932
            # [-0.37994896 -0.19737532  0.09966799  0.29131261]
    """
H
hong 已提交
2933 2934 2935 2936
    if in_dygraph_mode():
        return _C_ops.final_state_tanh( x )

    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2937
        return _C_ops.tanh(x)
W
WangXi 已提交
2938 2939

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'tanh')
S
ShenLiang 已提交
2940
    check_type(x, 'x', (Variable), 'tanh')
W
WangXi 已提交
2941 2942 2943 2944
    helper = LayerHelper('tanh', **locals())
    out = helper.create_variable_for_type_inference(x.dtype)
    helper.append_op(type='tanh', inputs={'X': x}, outputs={'Out': out})
    return out
S
Steffy-zxf 已提交
2945

2946
@inplace_apis_in_dygraph_only
2947 2948 2949 2950 2951
def tanh_(x, name=None):
    r"""
    Inplace version of ``tanh`` API, the output Tensor will be inplaced with input ``x``.
    Please refer to :ref:`api_tensor_tanh`.
    """
W
wanghuancoder 已提交
2952
    return _C_ops.tanh_(x)
2953 2954


S
Steffy-zxf 已提交
2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977
def increment(x, value=1.0, name=None):
    """
    The OP is usually used for control flow to increment the data of :attr:`x` by an amount :attr:`value`.
    Notice that the number of elements in :attr:`x` must be equal to 1.

    Args:
        x (Tensor): A tensor that must always contain only one element, its data type supports float32, float64, int32 and int64.
        value(float, optional): The amount to increment the data of :attr:`x`. Default: 1.0.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        Tensor, the elementwise-incremented tensor with the same shape and data type as :attr:`x`.

    Examples:
        .. code-block:: python

            import paddle

            data = paddle.zeros(shape=[1], dtype='float32')
            counter = paddle.increment(data)
            # [1.]

    """
H
hong 已提交
2978 2979 2980 2981
    if in_dygraph_mode():
        return _C_ops.final_state_increment( x, value)

    if _in_legacy_dygraph():
W
wanghuancoder 已提交
2982
        return _C_ops.increment(x, 'step', value)
S
Steffy-zxf 已提交
2983 2984 2985 2986 2987 2988 2989 2990 2991 2992

    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'increment')
    helper = LayerHelper("increment", **locals())
    helper.append_op(
        type='increment',
        inputs={'X': [x]},
        outputs={'Out': [x]},
        attrs={'step': float(value)})
    return x
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002


def all(x, axis=None, keepdim=False, name=None):
    """
    Computes the the ``logical and`` of tensor elements over the given dimension.

    Args:
        x (Tensor): An N-D Tensor, the input data type should be `bool`.
        axis (int|list|tuple, optional): The dimensions along which the ``logical and`` is compute. If
            :attr:`None`, and all elements of :attr:`x` and return a
N
Noel 已提交
3003
            Tensor with a single element, otherwise must be in the
3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025
            range :math:`[-rank(x), rank(x))`. If :math:`axis[i] < 0`,
            the dimension to reduce is :math:`rank + axis[i]`.
        keepdim (bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result Tensor will have one fewer dimension
            than the :attr:`x` unless :attr:`keepdim` is true, default
            value is False.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: Results the ``logical and`` on the specified axis of input Tensor `x`,  it's data type is bool.

    Raises:
        ValueError: If the data type of `x` is not bool.
        TypeError: The type of :attr:`axis` must be int, list or tuple.

    Examples:
        .. code-block:: python

            import paddle
            import numpy as np
            
N
Noel 已提交
3026
            # x is a bool Tensor with following elements:
3027 3028
            #    [[True, False]
            #     [True, True]]
S
syyxsxx 已提交
3029
            x = paddle.assign(np.array([[1, 0], [1, 1]], dtype='int32'))
3030
            print(x)
S
syyxsxx 已提交
3031
            x = paddle.cast(x, 'bool')
3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045
            
            # out1 should be [False]
            out1 = paddle.all(x)  # [False]
            print(out1)
            
            # out2 should be [True, False]
            out2 = paddle.all(x, axis=0)  # [True, False]
            print(out2)
            
            # keep_dim=False, out3 should be [False, True], out.shape should be (2,)
            out3 = paddle.all(x, axis=-1)  # [False, True]
            print(out3)
            
            # keep_dim=True, out4 should be [[False], [True]], out.shape should be (2,1)
S
syyxsxx 已提交
3046 3047
            out4 = paddle.all(x, axis=1, keepdim=True)
            out4 = paddle.cast(out4, 'int32')  # [[False], [True]]
3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061
            print(out4)
            
    """
    if axis is not None and not isinstance(axis, (list, tuple)):
        axis = [axis]

    if not axis:
        reduce_all_flag = True
    else:
        if len(axis) == len(x.shape):
            reduce_all_flag = True
        else:
            reduce_all_flag = False

3062 3063 3064 3065 3066 3067
    if in_dygraph_mode():
        if reduce_all_flag:
            axis = range(len(x.shape))
        return _C_ops.final_state_all(x, axis, keepdim)

    if _in_legacy_dygraph():
W
wanghuancoder 已提交
3068
        axis = axis if axis != None and axis != [] else [0]
W
wanghuancoder 已提交
3069
        return _C_ops.reduce_all(x, 'dim', axis, 'keep_dim', keepdim,
W
wanghuancoder 已提交
3070 3071
                                       'reduce_all', reduce_all_flag)

3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099
    attrs = {
        'dim': axis if axis != None and axis != [] and axis != () else [0],
        'keep_dim': keepdim,
        'reduce_all': reduce_all_flag
    }
    check_variable_and_dtype(x, 'x', ['bool'], 'all')


    check_type(axis, 'axis', (int, list, tuple, type(None)), 'all')

    helper = LayerHelper('all', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='reduce_all',
        inputs={'X': x},
        outputs={'Out': out},
        attrs=attrs)
    return out


def any(x, axis=None, keepdim=False, name=None):
    """
    Computes the the ``logical or`` of tensor elements over the given dimension.

    Args:
        x (Tensor): An N-D Tensor, the input data type should be `bool`.
        axis (int|list|tuple, optional): The dimensions along which the ``logical or`` is compute. If
            :attr:`None`, and all elements of :attr:`x` and return a
N
Noel 已提交
3100
            Tensor with a single element, otherwise must be in the
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122
            range :math:`[-rank(x), rank(x))`. If :math:`axis[i] < 0`,
            the dimension to reduce is :math:`rank + axis[i]`.
        keepdim (bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result Tensor will have one fewer dimension
            than the :attr:`x` unless :attr:`keepdim` is true, default
            value is False.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: Results the ``logical or`` on the specified axis of input Tensor `x`,  it's data type is bool.

    Raises:
        ValueError: If the data type of `x` is not bool.
        TypeError: The type of :attr:`axis` must be int, list or tuple.

    Examples:
        .. code-block:: python

            import paddle
            import numpy as np
            
N
Noel 已提交
3123
            # x is a bool Tensor with following elements:
3124 3125
            #    [[True, False]
            #     [False, False]]
S
syyxsxx 已提交
3126
            x = paddle.assign(np.array([[1, 0], [1, 1]], dtype='int32'))
3127
            print(x)
S
syyxsxx 已提交
3128
            x = paddle.cast(x, 'bool')
3129 3130 3131 3132 3133
            
            # out1 should be [True]
            out1 = paddle.any(x)  # [True]
            print(out1)
            
3134 3135
            # out2 should be [True, True]
            out2 = paddle.any(x, axis=0)  # [True, True]
3136 3137
            print(out2)
            
3138 3139
            # keep_dim=False, out3 should be [True, True], out.shape should be (2,)
            out3 = paddle.any(x, axis=-1)  # [True, True]
3140 3141
            print(out3)
            
3142
            # keep_dim=True, result should be [[True], [True]], out.shape should be (2,1)
S
syyxsxx 已提交
3143
            out4 = paddle.any(x, axis=1, keepdim=True)
3144
            out4 = paddle.cast(out4, 'int32')  # [[True], [True]]
3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158
            print(out4)
            
    """
    if axis is not None and not isinstance(axis, (list, tuple)):
        axis = [axis]

    if not axis:
        reduce_all_flag = True
    else:
        if len(axis) == len(x.shape):
            reduce_all_flag = True
        else:
            reduce_all_flag = False

3159 3160 3161 3162 3163 3164
    if in_dygraph_mode():
        if reduce_all_flag:
            axis = range(len(x.shape))
        return _C_ops.final_state_any(x, axis, keepdim)

    if _in_legacy_dygraph():
W
wanghuancoder 已提交
3165
        axis = axis if axis != None and axis != [] else [0]
W
wanghuancoder 已提交
3166
        return _C_ops.reduce_any(x, 'dim', axis, 'keep_dim', keepdim,
W
wanghuancoder 已提交
3167 3168
                                       'reduce_all', reduce_all_flag)

3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187
    attrs = {
        'dim': axis if axis != None and axis != [] and axis != () else [0],
        'keep_dim': keepdim,
        'reduce_all': reduce_all_flag
    }

    check_variable_and_dtype(x, 'x', ['bool'], 'any')


    check_type(axis, 'axis', (int, list, tuple, type(None)), 'any')

    helper = LayerHelper('any', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='reduce_any',
        inputs={'X': x},
        outputs={'Out': out},
        attrs=attrs)
    return out
L
Leo Chen 已提交
3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214

def broadcast_shape(x_shape, y_shape):
    """
    The function returns the shape of doing operation with broadcasting on tensors of x_shape and y_shape, please refer to :ref:`user_guide_broadcasting` for more details.

    Args:
        x_shape (list[int]|tuple[int]): A shape of tensor.
        y_shape (list[int]|tuple[int]): A shape of tensor.
        

    Returns:
        list[int], the result shape.

    Examples:
        .. code-block:: python

            import paddle

            shape = paddle.broadcast_shape([2, 1, 3], [1, 3, 1])
            # [2, 3, 3]
            
            # shape = paddle.broadcast_shape([2, 1, 3], [3, 3, 1])
            # ValueError (terminated with error message).

    """

    return core.broadcast_shape(x_shape, y_shape)
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244

def conj(x, name=None):
    r"""
    This function computes the conjugate of the Tensor elementwisely.

    Args:
        x (Tensor): The input tensor which hold the complex numbers. 
            Optional data types are: complex64, complex128, float32, float64, int32 or int64.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        out (Tensor): The conjugate of input. The shape and data type is the same with input.
            If the elements of tensor is real type such as float32, float64, int32 or int64, the out is the same with input.

    Examples:
        .. code-block:: python

          import paddle
          data=paddle.to_tensor([[1+1j, 2+2j, 3+3j], [4+4j, 5+5j, 6+6j]])
          #Tensor(shape=[2, 3], dtype=complex64, place=CUDAPlace(0), stop_gradient=True,
          #       [[(1+1j), (2+2j), (3+3j)],
          #        [(4+4j), (5+5j), (6+6j)]])

          conj_data=paddle.conj(data)
          #Tensor(shape=[2, 3], dtype=complex64, place=CUDAPlace(0), stop_gradient=True,
          #       [[(1-1j), (2-2j), (3-3j)],
          #        [(4-4j), (5-5j), (6-6j)]])

    """
Z
zhiboniu 已提交
3245
    if paddle.in_dynamic_mode():
W
wanghuancoder 已提交
3246
        return _C_ops.conj(x)
3247 3248 3249 3250 3251 3252 3253 3254 3255

    check_variable_and_dtype(x, "x", ['complex64', 'complex128', 'float32', 'float64', 'int32', 'int64'], 'conj')

    helper = LayerHelper('conj', **locals())
    out = helper.create_variable_for_type_inference(
            dtype=helper.input_dtype())

    helper.append_op(type='conj', inputs={'X': x}, outputs={'Out': [out]})
    return out
3256

Z
zyfncg 已提交
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283
def digamma(x, name=None):
    r"""
    Calculates the digamma of the given input tensor, element-wise.

    .. math::
        Out = \Psi(x) = \frac{ \Gamma^{'}(x) }{ \Gamma(x) }

    Args:
        x (Tensor): Input Tensor. Must be one of the following types: float32, float64.
        name(str, optional): The default value is None.  Normally there is no need for 
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
    Returns:
        Tensor, the digamma of the input Tensor, the shape and data type is the same with input.

    Examples:
        .. code-block:: python

            import paddle

            data = paddle.to_tensor([[1, 1.5], [0, -2.2]], dtype='float32')
            res = paddle.digamma(data)
            print(res)
            # Tensor(shape=[2, 2], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [[-0.57721591,  0.03648996],
            #        [ nan       ,  5.32286835]])
    """

J
Jiabin Yang 已提交
3284 3285 3286 3287 3288
    if in_dygraph_mode():
        return _C_ops.final_state_digamma(x)
    else:
        if _in_legacy_dygraph():
            return _C_ops.digamma(x)
Z
zyfncg 已提交
3289 3290 3291 3292 3293 3294 3295

    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'digamma')
    helper = LayerHelper('digamma', **locals())
    out = helper.create_variable_for_type_inference(x.dtype)
    helper.append_op(type='digamma', inputs={'X': x}, outputs={'Out': out})
    return out

3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317
def neg(x, name=None):
    """
    This function computes the negative of the Tensor elementwisely.

    Args:
        x (Tensor): Input of neg operator, an N-D Tensor, with data type float32, float64, int8, int16, int32, or int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): The negative of input Tensor. The shape and data type are the same with input Tensor.

    Examples:
        .. code-block:: python

            import paddle

            x = paddle.to_tensor([-0.4, -0.2, 0.1, 0.3])
            out = paddle.neg(x)
            print(out)
            # [0.4 0.2 -0.1 -0.3]
    """

Z
zhiboniu 已提交
3318
    return scale(x, scale=-1.0, bias=0.0, bias_after_scale=True, act=None, name=name)
R
ronnywang 已提交
3319

3320
def atan2(x, y, name=None):
R
ronnywang 已提交
3321
    r"""
3322
    Element-wise arctangent of x/y with consideration of the quadrant.
R
ronnywang 已提交
3323 3324 3325 3326

    Equation:
        .. math::

3327 3328 3329 3330 3331 3332 3333 3334
            atan2(x,y)=\left\{\begin{matrix}
            & tan^{-1}(\frac{x}{y}) & y > 0 \\
            & tan^{-1}(\frac{x}{y}) + \pi & x>=0, y < 0 \\
            & tan^{-1}(\frac{x}{y}) - \pi & x<0, y < 0 \\
            & +\frac{\pi}{2} & x>0, y = 0 \\
            & -\frac{\pi}{2} & x<0, y = 0 \\
            &\text{undefined} & x=0, y = 0
            \end{matrix}\right.
R
ronnywang 已提交
3335 3336

    Args:
3337 3338
        x (Tensor): An N-D Tensor, the data type is int32, int64, float16, float32, float64.
        y (Tensor): An N-D Tensor, must have the same type as `x`.
R
ronnywang 已提交
3339 3340 3341 3342 3343 3344 3345 3346
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): An N-D Tensor, the shape and data type is the same with input (The output data type is float64 when the input data type is int).

    Examples:
        .. code-block:: python

3347
            import paddle
R
ronnywang 已提交
3348

3349 3350 3351
            x = paddle.to_tensor([-1, +1, +1, -1]).astype('float32')
            #Tensor(shape=[4], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [-1,  1,  1, -1])
R
ronnywang 已提交
3352

3353 3354 3355
            y = paddle.to_tensor([-1, -1, +1, +1]).astype('float32')
            #Tensor(shape=[4], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [-1,  -1,  1, 1])
R
ronnywang 已提交
3356

3357 3358 3359
            out = paddle.atan2(x, y)
            #Tensor(shape=[4], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #       [-2.35619450,  2.35619450,  0.78539819, -0.78539819])
R
ronnywang 已提交
3360 3361 3362

    """

J
Jiabin Yang 已提交
3363 3364
    if in_dygraph_mode():
        return _C_ops.final_state_atan2( x, y)
R
ronnywang 已提交
3365
    else:
J
Jiabin Yang 已提交
3366 3367 3368 3369 3370
        if _in_legacy_dygraph():
            return _C_ops.atan2(x, y)
        else:
            check_variable_and_dtype(x, 'x', ['int32', 'int64', 'float16', 'float32', 'float64'], 'atan2')
            check_variable_and_dtype(y, 'y', ['int32', 'int64', 'float16', 'float32', 'float64'], 'atan2')
R
ronnywang 已提交
3371

J
Jiabin Yang 已提交
3372 3373 3374 3375 3376 3377
            helper = LayerHelper('atan2', **locals())
            inputs = {'X1' : x, 'X2' : y}
            out = helper.create_variable_for_type_inference(dtype=x.dtype)
            helper.append_op(
                    type='atan2', inputs=inputs, outputs={'Out': out})
            return out
A
andyjpaddle 已提交
3378

W
wangzhen38 已提交
3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421
def logit(x, eps=None, name=None):
    r"""
    This function generates a new tensor with the logit of the elements of input x. x is clamped to [eps, 1-eps] when eps is not zero. When eps is zero and x < 0 or x > 1, the function will yields NaN.

    .. math::
 
        logit(x) = ln(\frac{x}{1 - x})

    where

    .. math::

        x_i=
            \left\{\begin{array}{rcl}
                x_i & &\text{if } eps == Default \\
                eps & &\text{if } x_i < eps \\
                x_i & &\text{if } eps <= x_i <= 1-eps \\
                1-eps & &\text{if } x_i > 1-eps
            \end{array}\right.

    Args:
        x (Tensor): The input Tensor with data type float32, float64.
        eps (float, optional):  the epsilon for input clamp bound. Default is None.
        name (str, optional): Name for the operation (optional, default is None).
            For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out(Tensor): A Tensor with the same data type and shape as ``x`` .

    Examples:
        .. code-block:: python

            import paddle

            x = paddle.to_tensor([0.2635, 0.0106, 0.2780, 0.2097, 0.8095])
            out1 = paddle.logit(x)
            print(out1)
            # [-1.0277, -4.5365, -0.9544, -1.3269,  1.4468]  

    """

    if eps == None:
        eps = 0.0
Z
zhiboniu 已提交
3422
    if paddle.in_dynamic_mode():
W
wangzhen38 已提交
3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434
        return _C_ops.logit(x, 'eps', eps)

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'logit')
    helper = LayerHelper("logit", **locals())
    out = helper.create_variable_for_type_inference(x.dtype)
    helper.append_op(
        type='logit',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'eps': eps})
    return out

3435 3436 3437 3438 3439 3440 3441 3442 3443 3444
def lerp(x, y, weight, name=None):
    r"""
    Does a linear interpolation between x and y based on weight.

    Equation:
        .. math::

            lerp(x, y, weight) = x + weight * (y - x).

    Args:
3445 3446 3447
        x (Tensor): An N-D Tensor with starting points, the data type is float32, float64.
        y (Tensor): An N-D Tensor with ending points, the data type is float32, float64.
        weight (float|Tensor): The weight for the interpolation formula. When weight is Tensor, the data type is float32, float64.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): An N-D Tensor, the shape and data type is the same with input.

    Example:
        .. code-block:: python

            import paddle
            
            x = paddle.arange(1., 5., dtype='float32')
            y = paddle.empty([4], dtype='float32')
            y.fill_(10.)
            out = paddle.lerp(start, end, 0.5)
            # out: [5.5., 6., 6.5, 7.]

    """
H
hong 已提交
3465
    if in_dygraph_mode():
3466
        check_type(weight, 'weight', (float, paddle.Tensor, Variable), 'lerp')
H
hong 已提交
3467 3468 3469 3470 3471
        if isinstance(weight, float):
            weight = paddle.to_tensor(weight, dtype=x.dtype)

        return _C_ops.final_state_lerp( x, y, weight)
    if _in_legacy_dygraph():
3472 3473 3474 3475
        if isinstance(weight, float):
            weight = paddle.to_tensor(weight, dtype=x.dtype)
        return _C_ops.lerp(x, y, weight)

3476 3477 3478
    if isinstance(weight, float):
        weight = paddle.full(shape=[1], fill_value=weight, dtype=x.dtype)

3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'lerp')
    check_variable_and_dtype(y, 'y', ['float32', 'float64'], 'lerp')
    check_variable_and_dtype(weight, 'weight', ['float32', 'float64'], 'lerp')

    helper = LayerHelper('lerp', **locals())
    inputs = {'X': x, 'Y': y, 'Weight': weight}
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(type='lerp', inputs=inputs, outputs={'Out': out})
    return out

@inplace_apis_in_dygraph_only
def lerp_(x, y, weight, name=None):
    r"""
    Inplace version of ``lerp`` API, the output Tensor will be inplaced with input ``x``.
    Please refer to :ref:`api_tensor_lerp`.
    """
    out_shape = broadcast_shape(x.shape, y.shape)
    check_type(weight, 'weight', (float, paddle.Tensor, Variable), 'lerp')
    if isinstance(weight, float):
        weight = paddle.to_tensor([weight], dtype=x.dtype)
    elif isinstance(weight, (paddle.Tensor, Variable)):
        out_shape = broadcast_shape(out_shape, weight.shape)
    if out_shape != x.shape:
        raise ValueError("The shape of broadcast output {} is different from that of inplace tensor {} in the Inplace operation.".format(out_shape, x.shape))
    return _C_ops.lerp_(x, y, weight)

W
wuhuanzhou 已提交
3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532
def erfinv(x, name=None):
    r"""
    The inverse error function of x, .

    Equation:
        .. math::

            erfinv(erf(x)) = x.

    Args:
        x (Tensor): An N-D Tensor, the data type is float32, float64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): An N-D Tensor, the shape and data type is the same with input.

    Example:
        .. code-block:: python

            import paddle
            
            x = paddle.to_tensor([0, 0.5, -1.], dtype="float32")
            out = paddle.erfinv(x)
            # out: [0, 0.4769, -inf]

    """
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'erfinv')

Z
zhiboniu 已提交
3533
    if paddle.in_dynamic_mode():
W
wuhuanzhou 已提交
3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549
        return _C_ops.erfinv(x)

    helper = LayerHelper('erfinv', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(type='erfinv', inputs={'X': x}, outputs={'Out': out})
    return out

@inplace_apis_in_dygraph_only
def erfinv_(x, name=None):
    r"""
    Inplace version of ``erfinv`` API, the output Tensor will be inplaced with input ``x``.
    Please refer to :ref:`api_tensor_erfinv`.
    """
    check_type(x, 'x', (paddle.Tensor, Variable), 'erfinv')
    return _C_ops.erfinv_(x)

3550
def rad2deg(x, name=None):
3551
    r"""
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591
    Convert each of the elements of input x from angles in radians to degrees.
    
    Equation:
        .. math::

            rad2deg(x)=180/ \pi * x

    Args:
        x (Tensor): An N-D Tensor, the data type is float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): An N-D Tensor, the shape and data type is the same with input (The output data type is float32 when the input data type is int).

    Examples:
        .. code-block:: python

            import paddle
            import numpy as np
            
            x1 = paddle.to_tensor([3.142, -3.142, 6.283, -6.283, 1.570, -1.570])
            result1 = paddle.rad2deg(x1)
            print(result1)
            # Tensor(shape=[6], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #         [180.02334595, -180.02334595,  359.98937988, -359.98937988,
            #           9.95437622 , -89.95437622])

            x2 = paddle.to_tensor(np.pi/2)
            result2 = paddle.rad2deg(x2)
            print(result2)
            # Tensor(shape=[1], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #         [90.])
                     
            x3 = paddle.to_tensor(1)
            result3 = paddle.rad2deg(x3)
            print(result3)
            # Tensor(shape=[1], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #         [57.29578018])
    """
    rad2deg_scale = 180 / np.pi
Z
zhiboniu 已提交
3592
    if paddle.in_dynamic_mode():
3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609
        if convert_dtype(x.dtype) in ['int32', 'int64']:
            x = cast(x, dtype="float32")
        return _C_ops.scale(x, 'scale', rad2deg_scale)
    else:
        check_variable_and_dtype(x, 'x', ['int32', 'int64', 'float32', 'float64'], 'rad2deg')
        helper = LayerHelper('rad2deg', **locals())
        out_cast = x
        if convert_dtype(x.dtype) in ['int32', 'int64']:
            out_cast = helper.create_variable_for_type_inference(dtype=paddle.float32)
            helper.append_op(
                    type='cast', inputs={'X':x}, outputs={'Out': out_cast}, attrs={'in_dtype': x.dtype,'out_dtype': paddle.float32})
        out = helper.create_variable_for_type_inference(dtype=out_cast.dtype)
        helper.append_op(
            type='scale', inputs={'X':out_cast}, outputs={'Out': out}, attrs={'scale': rad2deg_scale})
        return out

def deg2rad(x, name=None):
3610
    r"""
3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644
    Convert each of the elements of input x from degrees to angles in radians.
    
    Equation:
        .. math::

            deg2rad(x)=\pi * x / 180

    Args:
        x (Tensor): An N-D Tensor, the data type is float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): An N-D Tensor, the shape and data type is the same with input (The output data type is float32 when the input data type is int).

    Examples:
        .. code-block:: python

            import paddle
            import numpy as np
            
            x1 = paddle.to_tensor([180.0, -180.0, 360.0, -360.0, 90.0, -90.0])
            result1 = paddle.deg2rad(x1)
            print(result1)
            # Tensor(shape=[6], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #         [3.14159274, -3.14159274,  6.28318548, -6.28318548,  1.57079637,
            #           -1.57079637])

            x2 = paddle.to_tensor(180)
            result2 = paddle.deg2rad(x2)
            print(result2)
            # Tensor(shape=[1], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
            #         [3.14159274])
    """
    deg2rad_scale = np.pi / 180.0
Z
zhiboniu 已提交
3645
    if paddle.in_dynamic_mode():
3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660
        if convert_dtype(x.dtype) in ['int32', 'int64']:
            x = cast(x, dtype="float32")
        return _C_ops.scale(x, 'scale', deg2rad_scale)
    else:
        check_variable_and_dtype(x, 'x', ['int32', 'int64', 'float32', 'float64'], 'deg2rad')
        helper = LayerHelper('deg2rad', **locals())
        out_cast = x
        if convert_dtype(x.dtype) in ['int32', 'int64']:
            out_cast = helper.create_variable_for_type_inference(dtype=paddle.float32)
            helper.append_op(
                    type='cast', inputs={'X':x}, outputs={'Out': out_cast}, attrs={'in_dtype': x.dtype,'out_dtype': paddle.float32})
        out = helper.create_variable_for_type_inference(dtype=out_cast.dtype)
        helper.append_op(
            type='scale', inputs={'X':out_cast}, outputs={'Out': out}, attrs={'scale': deg2rad_scale})
        return out
A
andyjpaddle 已提交
3661

T
Tao Luo 已提交
3662 3663 3664 3665 3666 3667 3668 3669
def gcd(x, y, name=None):
    """
    Computes the element-wise greatest common divisor (GCD) of input |x| and |y|.
    Both x and y must have integer types.
    
    Note:
        gcd(0,0)=0, gcd(0, y)=|y|

T
Tao Luo 已提交
3670 3671
        If x.shape != y.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

T
Tao Luo 已提交
3672
    Args:
T
Tao Luo 已提交
3673 3674
        x (Tensor): An N-D Tensor, the data type is int32,int64. 
        y (Tensor): An N-D Tensor, the data type is int32,int64. 
T
Tao Luo 已提交
3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): An N-D Tensor, the data type is the same with input.

    Examples:
        .. code-block:: python

            import paddle
            
            x1 = paddle.to_tensor(12)
            x2 = paddle.to_tensor(20)
            paddle.gcd(x1, x2)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [4])

T
Tao Luo 已提交
3691
            x3 = paddle.arange(6)
T
Tao Luo 已提交
3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728
            paddle.gcd(x3, x2)
            # Tensor(shape=[6], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [20, 1 , 2 , 1 , 4 , 5])

            x4 = paddle.to_tensor(0)
            paddle.gcd(x4, x2)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [20])

            paddle.gcd(x4, x4)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [0])
            
            x5 = paddle.to_tensor(-20)
            paddle.gcd(x1, x5)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [4])
    """
    shape = paddle.broadcast_shape(x.shape, y.shape)
    x = paddle.broadcast_to(x, shape)
    y = paddle.broadcast_to(y, shape)
    x = paddle.abs(x)
    y = paddle.abs(y)

    def _gcd_cond_fn(x, y):
        return paddle.any(y != 0)

    def _gcd_body_fn(x, y):
        # paddle.mod will raise an error when any element of y is 0. To avoid
        # that, we change those zeros to ones. Their values don't matter because
        # they won't be used.
        y_not_equal_0 = (y != 0)
        y_safe = paddle.where(y_not_equal_0, y, paddle.ones(y.shape, y.dtype))
        x, y = (paddle.where(y_not_equal_0, y, x),
                  paddle.where(y_not_equal_0, paddle.mod(x, y_safe),paddle.zeros(y.shape, y.dtype)))
        return (paddle.where(x < y, y, x), paddle.where(x < y, x, y))

Z
zhiboniu 已提交
3729
    if paddle.in_dynamic_mode():
T
Tao Luo 已提交
3730 3731 3732 3733 3734
        while _gcd_cond_fn(x, y):
            x, y = _gcd_body_fn(x, y)

        return x
    else:
T
Tao Luo 已提交
3735 3736
        check_variable_and_dtype(x, 'x', ['int32', 'int64'], 'gcd')
        check_variable_and_dtype(y, 'y', ['int32', 'int64'], 'gcd')
T
Tao Luo 已提交
3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747
        out, _ = paddle.static.nn.while_loop(_gcd_cond_fn, _gcd_body_fn, [x, y])
        return out

def lcm(x, y, name=None):
    """
    Computes the element-wise least common multiple (LCM) of input |x| and |y|.
    Both x and y must have integer types.
    
    Note:
        lcm(0,0)=0, lcm(0, y)=0

T
Tao Luo 已提交
3748 3749
        If x.shape != y.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

T
Tao Luo 已提交
3750
    Args:
T
Tao Luo 已提交
3751 3752
        x (Tensor): An N-D Tensor, the data type is int32,int64. 
        y (Tensor): An N-D Tensor, the data type is int32,int64. 
T
Tao Luo 已提交
3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        out (Tensor): An N-D Tensor, the data type is the same with input.

    Examples:
        .. code-block:: python

            import paddle
            
            x1 = paddle.to_tensor(12)
            x2 = paddle.to_tensor(20)
            paddle.lcm(x1, x2)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [60])

T
Tao Luo 已提交
3769
            x3 = paddle.arange(6)
T
Tao Luo 已提交
3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796
            paddle.lcm(x3, x2)
            # Tensor(shape=[6], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [0, 20, 20, 60, 20, 20])

            x4 = paddle.to_tensor(0)
            paddle.lcm(x4, x2)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [0])

            paddle.lcm(x4, x4)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [0])
            
            x5 = paddle.to_tensor(-20)
            paddle.lcm(x1, x5)
            # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True,
            #        [60])
    """
    d = paddle.gcd(x, y)
    # paddle.mod will raise an error when any element of y is 0. To avoid
    # that, we change those zeros to ones. Their values don't matter because
    # they won't be used.
    d_equal_0 = paddle.equal(d, 0)
    d_safe = paddle.where(d_equal_0, paddle.ones(d.shape, d.dtype), d)
    out = paddle.where(d_equal_0, paddle.zeros(d.shape, d.dtype), paddle.abs(x * y) // d_safe)
    return out

A
andyjpaddle 已提交
3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829
def diff(x, n=1, axis=-1, prepend=None, append=None, name=None):
    r"""
    Computes the n-th forward difference along the given axis.
    The first-order differences is computed by using the following formula: 

    .. math::

        out[i] = x[i+1] - x[i]
    
    Higher-order differences are computed by using paddle.diff() recursively. 
    Only n=1 is currently supported.

    Args:
        x(Tensor): The input tensor to compute the forward difference on
        n(int, optional): The number of times to recursively compute the difference. 
                          Only support n=1. Default:1
        axis(int, optional): The axis to compute the difference along. Default:-1
        prepend(Tensor, optional): The tensor to prepend to input along axis before computing the difference.
                                   It's dimensions must be equivalent to that of x, 
                                   and its shapes must match x's shape except on axis.
        append(Tensor, optional): The tensor to append to input along axis before computing the difference, 
                                   It's dimensions must be equivalent to that of x, 
                                   and its shapes must match x's shape except on axis.
        name(str|None): A name for this layer(optional). If set None, 
                        the layer will be named automatically.
    
    Returns:
        Tensor: The output tensor with same dtype with x.

    Examples:
        .. code-block:: python

            import paddle
3830

A
andyjpaddle 已提交
3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
            x = paddle.to_tensor([1, 4, 5, 2])
            out = paddle.diff(x)
            print(out)
            # out:
            # [3, 1, -3]

            y = paddle.to_tensor([7, 9])
            out = paddle.diff(x, append=y)
            print(out)
            # out: 
            # [3, 1, -3, 5, 2]

            z = paddle.to_tensor([[1, 2, 3], [4, 5, 6]])
            out = paddle.diff(z, axis=0)
            print(out)
            # out:
            # [[3, 3, 3]]
            out = paddle.diff(z, axis=1)
            print(out)
            # out:
            # [[1, 1], [1, 1]]
    """

    if axis < 0:
        axis = axis + len(x.shape)
    if axis > len(x.shape):
        axis = len(x.shape)
    if axis < 0:
        axis = 0
    dtype = x.dtype
    axes = [axis]
    infer_flags = list(1 for i in range(len(axes)))
Z
zhiboniu 已提交
3863
    if paddle.in_dynamic_mode():
A
andyjpaddle 已提交
3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888
        has_pend = False
        input_list = []
        if prepend is not None and append is not None:
            input_list = [prepend, x, append]
            has_pend = True
        elif prepend is not None:
            input_list = [prepend, x]
            has_pend = True
        elif append is not None:
            input_list = [x, append]
            has_pend = True
        if has_pend:
            new_input = _C_ops.concat(input_list, 'axis', axis)
        else:
            new_input = x

        attrs_1 = ()
        attrs_2 = ()

        dim_len = new_input.shape[axis]

        starts_1 = [0]
        attrs_1 += ('starts', starts_1)
        ends_1 = [dim_len - 1]
        attrs_1 += ('ends', ends_1)
W
wanghuancoder 已提交
3889
        input_front = _C_ops.slice(new_input, None, None, None, None, 'axes', axes, \
A
andyjpaddle 已提交
3890 3891 3892 3893 3894
            'infer_flags', infer_flags, *attrs_1)
        starts_2 = [1]
        attrs_2 += ('starts', starts_2)
        ends_2 = [dim_len]
        attrs_2 += ('ends', ends_2)
W
wanghuancoder 已提交
3895
        input_back = _C_ops.slice(new_input, None, None, None, None, 'axes', axes, \
A
andyjpaddle 已提交
3896 3897 3898 3899 3900 3901
            'infer_flags', infer_flags, *attrs_2)

        if x.dtype == paddle.bool:
            op = getattr(_C_ops, "logical_xor")
            out = op(input_back, input_front)
        else:
Z
zhiboniu 已提交
3902
            out = elementwise_sub(input_back, input_front, axis=axis)
A
andyjpaddle 已提交
3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953
        return out
    else:
        check_variable_and_dtype(x, 'x', ['float32', 'float64', 'bool', 'int32', 'int64'], 'diff')
        check_type(axis, 'axis', (int), 'diff')
        helper = LayerHelper('diff', **locals())
        has_pend = False
        input_list = []
        if prepend is not None and append is not None:
            input_list = [prepend, x, append]
            has_pend = True
        elif prepend is not None:
            input_list = [prepend, x]
            has_pend = True
        elif append is not None:
            input_list = [x, append]
            has_pend = True

        if has_pend:
            new_input = helper.create_variable_for_type_inference(dtype)
            helper.append_op(
                type='concat', inputs={'X': input_list}, outputs={'Out': [new_input]}, attrs={'axis': axis}
            )
        else:
            new_input = x

        dim_len = new_input.shape[axis]
        attrs_1 = {'axes': axes}
        starts_1 = [0]
        ends_1 = [dim_len - 1]
        attrs_1['starts'] = starts_1
        attrs_1['ends'] = ends_1
        input_front = helper.create_variable_for_type_inference(dtype)
        helper.append_op(
            type='slice', inputs={'Input': new_input}, attrs=attrs_1, outputs={'Out': input_front}
        )
        attrs_2 = {'axes': axes}
        starts_2 = [1]
        ends_2 = [dim_len]
        attrs_2['starts'] = starts_2
        attrs_2['ends'] = ends_2
        input_back = helper.create_variable_for_type_inference(dtype)
        helper.append_op(
            type='slice', inputs={'Input': new_input}, attrs=attrs_2, outputs={'Out': input_back}
        )

        if dtype == paddle.bool:
            out = helper.create_variable_for_type_inference(dtype)
            helper.append_op(
                type='logical_xor', inputs={"X": input_back, "Y": input_front}, outputs={"Out": out}
            )
        else:
Z
zhiboniu 已提交
3954
            out = elementwise_sub(input_back, input_front, axis=axis)
A
andyjpaddle 已提交
3955 3956

        return out
F
Feiyu Chan 已提交
3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972

def angle(x, name=None):
    r"""
    Element-wise angle of complex numbers. For non-negative real numbers, the angle is 0 while 
    for negative real numbers, the angle is :math:`\pi`.

    Equation:
        .. math::

            angle(x)=arctan2(x.imag, x.real)

    Args:
        x (Tensor): An N-D Tensor, the data type is complex64, complex128, or float32, float64 .
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
3973
        Tensor: An N-D Tensor of real data type with the same precision as that of x's data type.
F
Feiyu Chan 已提交
3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996

    Examples:
        .. code-block:: python

            import paddle

            x = paddle.to_tensor([-2, -1, 0, 1]).unsqueeze(-1).astype('float32')
            y = paddle.to_tensor([-2, -1, 0, 1]).astype('float32')
            z = x + 1j * y
            print(z.numpy())
            # [[-2.-2.j -2.-1.j -2.+0.j -2.+1.j]
            #  [-1.-2.j -1.-1.j -1.+0.j -1.+1.j]
            #  [ 0.-2.j  0.-1.j  0.+0.j  0.+1.j]
            #  [ 1.-2.j  1.-1.j  1.+0.j  1.+1.j]]

            theta = paddle.angle(z)
            print(theta.numpy())
            # [[-2.3561945 -2.6779451  3.1415927  2.6779451]
            #  [-2.0344439 -2.3561945  3.1415927  2.3561945]
            #  [-1.5707964 -1.5707964  0.         1.5707964]
            #  [-1.1071488 -0.7853982  0.         0.7853982]]
    """

Z
zhiboniu 已提交
3997
    if paddle.in_dynamic_mode():
F
Feiyu Chan 已提交
3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009
        return _C_ops.angle(x)

    check_variable_and_dtype(x, 'x',
        ['float32', 'float64', 'complex64', 'complex128'], 'angle')
    op_type = "angle"
    helper = LayerHelper(op_type, **locals())
    inputs = {"X": x}
    out = helper.create_variable_for_type_inference(
        dtype=_complex_to_real_dtype(x.dtype))
    outputs = {"Out": out}
    helper.append_op(type=op_type, inputs=inputs, outputs=outputs)
    return out