Optimisers Submodule: Main use case
===================================


recursiveRouteChoice.optimisers.optimisers\_file
------------------------------------------------
Main user access point to optimisers module, note that important pieces are already directly
imported into the optimisers module namespace. The main class of interest is :code:`ScipyOptimiser`
which provides an interface to the SciPy optimisation algorithms for the recursive logit.

.. automodule:: recursiveRouteChoice.optimisers.optimisers_file
   :members:
   :undoc-members:
   :show-inheritance:

Optimisers Submodule: Other files with minimal public API
=========================================================

recursiveRouteChoice.optimisers.extra\_optim module
---------------------------------------------------

.. automodule:: recursiveRouteChoice.optimisers.extra_optim
   :members:
   :undoc-members:
   :show-inheritance:

recursiveRouteChoice.optimisers.hessian\_approx module
------------------------------------------------------

.. automodule:: recursiveRouteChoice.optimisers.hessian_approx
   :members:
   :undoc-members:
   :show-inheritance:

recursiveRouteChoice.optimisers.line\_search module
---------------------------------------------------

.. automodule:: recursiveRouteChoice.optimisers.line_search
   :members:
   :undoc-members:
   :show-inheritance:

..
    Module contents
    ---------------

    .. automodule:: recursiveRouteChoice.optimisers
       :members:
       :undoc-members:
       :show-inheritance: