LINE Solver MATLAB API Documentation
====================================

Welcome to the LINE Solver MATLAB documentation. LINE is an open source package
for analyzing queueing models via analytical methods and simulation.

The API reference below is generated statically from ``matlab/src`` with
sphinxcontrib-matlabdomain -- it stays in sync with the sources automatically,
on every build.

API Documentation
------------------

- :doc:`generated/lang` -- Networks, nodes, classes, distributions, solvers
- :doc:`generated/api.cache` -- Cache performance analysis
- :doc:`generated/api.lossn` -- Analysis of networks with blocking
- :doc:`generated/api.lsn` -- Layered queueing network analysis
- :doc:`generated/api.mc` -- CTMC and DTMC analysis tools
- :doc:`generated/api.mam` -- QBD processes and matrix-analytic solutions
- :doc:`generated/api.npfqn` -- Approximations for intractable queueing networks
- :doc:`generated/api.polling` -- Analysis of gated, exhaustive, and k-limited polling
- :doc:`generated/api.pfqn` -- MVA, convolution, and normalizing constant methods
- :doc:`generated/api.qsys` -- Single-station queueing system analysis
- :doc:`generated/api.sn` -- Network analysis and transformation utilities
- :doc:`generated/lang.constant` -- Helper functions, constants, and enumerations

Module Locations
-----------------

.. list-table::
   :header-rows: 1

   * - Category
     - MATLAB Path
     - Description
   * - Cache API
     - ``matlab/src/api/cache/``
     - Cache analysis algorithms
   * - Constants
     - ``matlab/src/lang/constant/``
     - Enumerations and global constants
   * - Core
     - ``matlab/src/lang/``
     - Network, Node, and JobClass definitions
   * - Distributions
     - ``matlab/src/lang/processes/``
     - Exp, Erlang, PH, MAP, etc.
   * - Layered Networks
     - ``matlab/src/lang/layered/``
     - LayeredNetwork, Task, Activity
   * - LossN API
     - ``matlab/src/api/lossn/``
     - Loss network algorithms
   * - LSN API
     - ``matlab/src/api/lsn/``
     - Layered stochastic network utilities
   * - MAM API
     - ``matlab/src/api/mam/``
     - Matrix-analytic methods
   * - MC API
     - ``matlab/src/api/mc/``
     - Markov chain analysis
   * - Nodes
     - ``matlab/src/lang/nodes/``
     - Queue, Source, Sink, etc.
   * - NPFQN API
     - ``matlab/src/api/npfqn/``
     - Non-product-form network approximations
   * - PFQN API
     - ``matlab/src/api/pfqn/``
     - Product-form queueing network algorithms
   * - Polling API
     - ``matlab/src/api/polling/``
     - Polling system algorithms
   * - Qsys API
     - ``matlab/src/api/qsys/``
     - Single queueing system formulas
   * - SN API
     - ``matlab/src/api/sn/``
     - Stochastic network utilities
   * - Solvers
     - ``matlab/src/solvers/``
     - MVA, CTMC, Fluid, MAM, etc.

License
-------

`BSD-3 License <../web/license.html>`_

Copyright (c) 2012-2026, `QORE Lab <https://qore.doc.ic.ac.uk/>`_, Imperial College London.
All rights reserved.

External Links
---------------

`Project Website <http://line-solver.sourceforge.io/>`_

Guides
======

.. toctree::
   :maxdepth: 1

   pages/installation
   pages/quickstart
   pages/choosing_solver
   pages/solver_reference
   pages/examples
   pages/core_reference
   pages/constants_reference

API Reference
=============

.. toctree::
   :maxdepth: 2

   generated/index

Indices
=======

* :ref:`genindex`
* :ref:`search`