..
    SPDX-FileCopyrightText: 2015-2023 Tanguy Fardet
    SPDX-License-Identifier: CC-BY-SA-4.0
    doc/modules/generation.rst.in

=================
Generation module
=================

.. currentmodule:: nngt.generation

.. automodule:: nngt.generation
    :no-members:


Content
=======

Generation functions
--------------------

.. autosummary::

    nngt.generation.all_to_all
    nngt.generation.circular
    nngt.generation.distance_rule
    nngt.generation.erdos_renyi
    nngt.generation.fixed_degree
    nngt.generation.from_degree_list
    nngt.generation.gaussian_degree
    nngt.generation.newman_watts
    nngt.generation.price_scale_free
    nngt.generation.random_scale_free
    nngt.generation.sparse_clustered
    nngt.generation.watts_strogatz



Connectors
----------

.. autosummary::

    nngt.generation.connect_nodes
    nngt.generation.connect_groups
    nngt.generation.connect_neural_types


Rewiring functions
------------------

.. autosummary::

    nngt.generation.random_rewire
    nngt.generation.lattice_rewire


Details
=======


.. autofunction:: all_to_all

.. autofunction:: circular

.. autofunction:: connect_groups

.. autofunction:: connect_neural_groups

.. autofunction:: connect_neural_types

.. autofunction:: connect_nodes

.. autofunction:: distance_rule

.. autofunction:: erdos_renyi

.. autofunction:: fixed_degree

.. autofunction:: from_degree_list

.. autofunction:: gaussian_degree

.. autofunction:: lattice_rewire

.. autofunction:: newman_watts

.. autofunction:: price_scale_free

.. autofunction:: random_rewire

.. autofunction:: random_scale_free

.. autofunction:: sparse_clustered

.. autofunction:: watts_strogatz