.. _reference:

Analytical Engine API Reference
============================================

.. default-domain:: cpp

.. contents::
    :local:
    :class: this-will-duplicate-information-and-it-is-still-useful-here

Analytical Engine
-----------------

.. doxygenclass:: gs::GrapeEngine
    :members:
    :undoc-members:

.. doxygenclass:: gs::GrapeInstance
    :members:
    :undoc-members:

.. doxygenclass:: gs::GSObject
    :members:
    :undoc-members:

.. doxygenclass:: gs::ObjectManager
    :members:
    :undoc-members:

.. doxygenclass:: gs::rpc::AnalyticalServer
    :members:
    :undoc-members:

.. doxygenstruct:: gs::EngineConfig
    :members:
    :undoc-members:

.. doxygenclass:: gs::Dispatcher
    :members:
    :undoc-members:

.. doxygenclass:: gs::DispatchResult
    :members:
    :undoc-members:

Fragments in GraphScope
-----------------------

.. doxygenclass:: gs::FragmentWrapper
    :members:
    :undoc-members:

.. doxygenclass:: gs::ArrowProjectedFragment
    :members:
    :undoc-members:

.. doxygenclass:: gs::ArrowProjectedVertexMap
    :members:
    :undoc-members:

.. doxygenclass:: gs::ArrowFragmentLoader
    :members:
    :undoc-members:

.. doxygenclass:: gs::ArrowFragmentAppender
    :members:
    :undoc-members:

Analytical Apps
---------------

.. doxygenclass:: gs::AppBase
    :members:
    :undoc-members:

.. doxygenclass:: gs::PropertyAppBase
    :members:
    :undoc-members:

.. doxygenclass:: gs::PropertyAutoAppBase
    :members:
    :undoc-members:

.. doxygenclass:: gs::DefaultWorker
    :members:
    :undoc-members:

.. doxygenclass:: gs::ParallelPropertyWorker
    :members:
    :undoc-members:

.. doxygenclass:: gs::PropertyAutoWorker
    :members:
    :undoc-members:

.. doxygenclass:: gs::AppEntry
    :members:
    :undoc-members:

.. doxygenstruct:: gs::ArgsNum
    :members:
    :undoc-members:

.. doxygenstruct:: gs::ArgsUnpacker
    :members:
    :undoc-members:

.. doxygenstruct:: gs::ArgTypeAt
    :members:
    :undoc-members:

Analytical Workers
------------------

.. doxygenclass:: gs::DefaultWorker
    :members:
    :undoc-members:

.. doxygenclass:: gs::DefaultPropertyWorker
    :members:
    :undoc-members:

.. doxygenclass:: gs::ParallelPropertyWorker
    :members:
    :undoc-members:

.. doxygenclass:: gs::PropertyAutoWorker
    :members:
    :undoc-members:

App's Context
-------------

.. doxygenstruct:: gs::CtxWrapperBuilder
    :members:
    :undoc-members:

.. doxygenclass:: gs::VertexPropertyContext
    :members:
    :undoc-members:

.. doxygenclass:: gs::VertexDataContextWrapper
    :members:
    :undoc-members:

.. doxygenclass:: gs::TensorContext
    :members:
    :undoc-members:

.. doxygenclass:: gs::TensorContextWrapper
    :members:
    :undoc-members: