binaryai.function
=================

.. py:module:: binaryai.function


Classes
-------

.. autoapisummary::

   binaryai.function.Function
   binaryai.function.MatchedFunction


Module Contents
---------------

.. py:class:: Function(name: str, offset: int, pseudocode: str, embedding: Optional[List[float]] = None)

   Bases: :py:obj:`object`


   A function entity that represents a decompiled function.


   .. py:attribute:: name


   .. py:attribute:: offset


   .. py:attribute:: pseudocode


   .. py:attribute:: embedding
      :value: None



.. py:class:: MatchedFunction(score: float, code: str)

   Bases: :py:obj:`object`


   Matched function entity by using similarity search.
   Differ from Function class, this class is a matched function result
   with only score, code and other fields, but no bytes and fileoffset
   which represents an function in a executable binary.
   So this is rather not an actual decompiled function.

   Note that this class is experiment and maybe changed in the future.


   .. py:attribute:: score


   .. py:attribute:: code