.. _api:

Public API
==========

Data types
----------

.. autoclass:: opveclib.DType
    :members:
    :undoc-members:
    :exclude-members: as_proto, from_proto, as_cstr, as_ctypes, as_numpy

.. autodata:: opveclib.expression.float32
    :annotation:
.. autodata:: opveclib.expression.float64
    :annotation:
.. autodata:: opveclib.expression.int8
    :annotation:
.. autodata:: opveclib.expression.int16
    :annotation:
.. autodata:: opveclib.expression.int32
    :annotation:
.. autodata:: opveclib.expression.int64
    :annotation:
.. autodata:: opveclib.expression.uint8
    :annotation:
.. autodata:: opveclib.expression.uint16
    :annotation:
.. autodata:: opveclib.expression.uint32
    :annotation:
.. autodata:: opveclib.expression.uint64
    :annotation:
.. autoclass:: opveclib.TensorType
    :members:
    :undoc-members:
    :exclude-members: as_proto, from_proto, as_cstr, as_ctypes, as_numpy

Expressions
-----------

.. autoclass:: opveclib.Scalar
    :members:
    :undoc-members:
    :special-members:
    :exclude-members: __init__, __bool__, __module__, __radd__,__rdiv__,__rmod__,__rmul__,__rsub__, as_proto, from_proto, gen_c

.. autoclass:: opveclib.Variable
    :members:
    :undoc-members:
    :special-members:
    :exclude-members: __init__, __bool__, __module__, __radd__,__rdiv__,__rmod__,__rmul__,__rsub__, as_proto, from_proto, gen_c

.. autoclass:: opveclib.InputTensor
    :members:
    :undoc-members:
    :special-members:
    :inherited-members:
    :exclude-members: __init__, __module__, __class__, __delattr__, __dict__, __format__, __getattribute__, __hash__, __ilshift__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__, __weakref__, as_proto, from_proto, gen_c, gen_ptr

.. autoclass:: opveclib.OutputTensor
    :members:
    :undoc-members:
    :special-members:
    :inherited-members:
    :exclude-members: __init__, __module__, __class__, __delattr__, __dict__, __format__, __getattribute__, __hash__, __ilshift__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__, __weakref__, as_proto, from_proto, gen_c, gen_ptr

.. autoclass:: opveclib.PositionTensor
    :members:
    :undoc-members:
    :special-members:
    :inherited-members:
    :exclude-members: __init__, __module__, __class__, __delattr__, __dict__, __format__, __getattribute__, __hash__, __ilshift__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__, __weakref__, as_proto, from_proto, gen_c, gen_ptr

.. autoclass:: opveclib.LocalTensor
    :members:
    :undoc-members:
    :special-members:
    :inherited-members:
    :exclude-members: __init__, __module__, __class__, __delattr__, __dict__, __format__, __getattribute__, __hash__, __ilshift__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__, __weakref__, as_proto, from_proto, gen_c, gen_ptr

Tensor functions
----------------

.. autofunction:: opveclib.position_in

.. autofunction:: opveclib.output

.. autofunction:: opveclib.output_like

.. autofunction:: opveclib.zeros

.. autofunction:: opveclib.ones

Scalar functions
----------------

Utility
~~~~~~~

.. autofunction:: opveclib.variable

.. autofunction:: opveclib.cast

Numeric limits
~~~~~~~~~~~~~~

.. autofunction:: opveclib.min_value

.. autofunction:: opveclib.max_value

.. autofunction:: opveclib.epsilon

Unary math
~~~~~~~~~~

.. autofunction:: opveclib.arccos

.. autofunction:: opveclib.arcsin

.. autofunction:: opveclib.arctan

.. autofunction:: opveclib.cos

.. autofunction:: opveclib.cosh

.. autofunction:: opveclib.sin

.. autofunction:: opveclib.sinh

.. autofunction:: opveclib.tan

.. autofunction:: opveclib.tanh

.. autofunction:: opveclib.exp

.. autofunction:: opveclib.log

.. autofunction:: opveclib.log10

.. autofunction:: opveclib.sqrt

.. autofunction:: opveclib.ceil

.. autofunction:: opveclib.absolute

.. autofunction:: opveclib.floor

.. autofunction:: opveclib.logical_not

.. autofunction:: opveclib.isinf

.. autofunction:: opveclib.isfinite

.. autofunction:: opveclib.isnan

Binary math
~~~~~~~~~~~

.. autofunction:: opveclib.minimum

.. autofunction:: opveclib.maximum

.. autofunction:: opveclib.power

.. autofunction:: opveclib.arctan2

.. autofunction:: opveclib.logical_and

.. autofunction:: opveclib.logical_or

Control flow
------------

.. autofunction:: opveclib.arange

.. autofunction:: opveclib.if_

.. autofunction:: opveclib.elif_

.. autofunction:: opveclib.else_

Operator functions
------------------

.. autofunction:: opveclib.operator

.. autofunction:: opveclib.gradient

.. autofunction:: opveclib.evaluate

.. autofunction:: opveclib.profile

.. autofunction:: opveclib.as_tensorflow

Local runtime environment functions
-----------------------------------

.. autodata:: opveclib.local.version
    :annotation:
.. autodata:: opveclib.local.logger
    :annotation:
.. autodata:: opveclib.local.cuda_enabled
    :annotation:
.. autodata:: opveclib.local.cache_directory
    :annotation:
.. autofunction:: opveclib.clear_op_cache