shape_of.rst 1.43 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
.. shape_of.rst:

#######
ShapeOf
#######

.. code-block:: cpp

   ShapeOf  // Operation that returns the shape of its input tensor


Description
===========

.. warning:: This op is experimental and subject to change without notice.

Returns the shape of its input argument as a tensor of element type ``u64``.

Inputs
------

+-----------------+-------------------------+---------------------------------+
| Name            | Element Type            | Shape                           |
+=================+=========================+=================================+
| ``arg``         | Any                     | Any                             |
+-----------------+-------------------------+---------------------------------+

Outputs
-------

+-----------------+-------------------------+-----------------------------------------------------+
| Name            | Element Type            | Shape                                               |
+=================+=========================+=====================================================+
| ``output``      | ``element::u64``        | ``{r}`` where ``r`` is the rank of ``arg``'s shape. |
+-----------------+-------------------------+-----------------------------------------------------+


Mathematical Definition
=======================

.. math::

   \mathtt{output} = \mathtt{shapeof}(\mathtt{arg})


C++ Interface
=============

.. doxygenclass:: ngraph::op::ShapeOf
   :project: ngraph
   :members: