floor.rst 1.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
.. floor.rst:

#####
Floor
#####

.. code-block:: cpp

   Floor  // Elementwise floor operation

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

Scott Cyphers's avatar
Scott Cyphers committed
14
Produces a single output tensor of the same element type and shape as ``arg,``
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
where the value at each coordinate of ``output`` is the floor of the
value at each ``arg`` coordinate.

Inputs
------

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

Outputs
-------

+-----------------+-------------------------+--------------------------------+
| Name            | Element Type            | Shape                          |
+=================+=========================+================================+
| ``output``      | Same as ``arg``         | Same as ``arg``                |
+-----------------+-------------------------+--------------------------------+


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

.. math::

   \mathtt{output}_{i_0, \ldots, i_{n-1}} = \lfloor \mathtt{arg}_{i_0,
   \ldots, i_{n-1}}\rfloor

Backprop
========

Not defined by nGraph.

The backprop would be zero for non-integer
input and undefined for integer input; a zero backprop would have
no effect on the backprop to ``arg``, so there is no need for ``Floor``
to define a backprop.

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

.. doxygenclass:: ngraph::op::Floor
   :project: ngraph
   :members: