.. _cn_api_tensor_search_nonzero:

nonzero
-------------------------------

.. py:function:: paddle.nonzero(input, as_tuple=False)

:alias_main: paddle.nonzero
:alias: paddle.nonzero,paddle.tensor.nonzero,paddle.tensor.search.nonzero






该OP返回输入 ``input`` 中非零元素的坐标。如果输入 ``input`` 有 ``n`` 维，共包含 ``z`` 个非零元素，当 ``as_tuple = False`` 时，
返回结果是一个 ``shape`` 等于 ``[z x n]`` 的 ``Tensor`` , 第 ``i`` 行代表输入中第 ``i`` 个非零元素的坐标；当 ``as_tuple = True`` 时，
返回结果是由 ``n`` 个大小为 ``z`` 的 ``1-D Tensor`` 构成的元组，第 ``i`` 个 ``1-D Tensor`` 记录输入的非零元素在第 ``i`` 维的坐标。
        
**参数**：
    - **input** （Variable）– 输入张量。
    - **as_tuple** (bool, optinal) - 返回格式。是否以 ``1-D Tensor`` 构成的元组格式返回。

**返回**：
    - **Variable** (Tensor or tuple(1-D Tensor))，数据类型为 **INT64** 。
     
**代码示例**：

.. code-block:: python

        import paddle
        import paddle.fluid as fluid
        import numpy as np

        data1 = np.array([[1.0, 0.0, 0.0],
                            [0.0, 2.0, 0.0],
                            [0.0, 0.0, 3.0]])
        data2 = np.array([0.0, 1.0, 0.0, 3.0])
        data3 = np.array([0.0, 0.0, 0.0])
        with fluid.dygraph.guard():
            x1 = fluid.dygraph.to_variable(data1)
            x2 = fluid.dygraph.to_variable(data2)
            x3 = fluid.dygraph.to_variable(data3)
            out_z1 = paddle.nonzero(x1)
            print(out_z1.numpy())
            #[[0 0]
            # [1 1]
            # [2 2]]
            out_z1_tuple = paddle.nonzero(x1, as_tuple=True)
            for out in out_z1_tuple:
                print(out.numpy())
            #[[0]
            # [1]
            # [2]]
            #[[0]
            # [1]
            # [2]]
            out_z2 = paddle.nonzero(x2)
            print(out_z2.numpy())
            #[[1]
            # [3]]
            out_z2_tuple = paddle.nonzero(x2, as_tuple=True)
            for out in out_z2_tuple:
                print(out.numpy())
            #[[1]
            # [3]]
            out_z3 = paddle.nonzero(x3)
            print(out_z3.numpy())
            #[]
            out_z3_tuple = paddle.nonzero(x3, as_tuple=True)
            for out in out_z3_tuple:
                print(out.numpy())
            #[]         


