.. listools documentation master file, created by
   sphinx-quickstart on Mon Dec  3 00:15:26 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to listools's documentation!
====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:



The listools package
====================

.. automodule:: listools



flatools module
===============

.. automodule:: listools.flatools

flatten
-------
.. autofunction:: listools.flatools.flatten

flatten_choice
-------------
.. autofunction:: listools.flatools.flatten_choice

flatten_index
-------------
.. autofunction:: listools.flatools.flatten_index

flatten_join
------------
.. autofunction:: listools.flatools.flatten_join

flatten_len
-----------
.. autofunction:: listools.flatools.flatten_len

flatten_max
-----------
.. autofunction:: listools.flatools.flatten_max

flatten_min
-----------
.. autofunction:: listools.flatools.flatten_min

flatten_mixed_type
------------------
.. autofunction:: listools.flatools.flatten_mixed_type

flatten_reverse
---------------
.. autofunction:: listools.flatools.flatten_reverse

flatten_single_type
-------------------
.. autofunction:: listools.flatools.flatten_single_type

flatten_sorted
--------------
.. autofunction:: listools.flatools.flatten_sorted

flatten_sum
-----------
.. autofunction:: listools.flatools.flatten_sum

flatten_zip_cycle
-----------------
.. autofunction:: listools.flatools.flatten_zip_cycle

pflatten
--------
.. autofunction:: listools.flatools.pflatten



iterz module
============

.. automodule:: listools.iterz

cycle_until_index
-----------------
.. autofunction:: listools.iterz.cycle_until_index

inf_cycle
---------
.. autofunction:: listools.iterz.inf_cycle

iter_mask
---------
.. autofunction:: listools.iterz.iter_mask

ncycle
------
.. autofunction:: listools.iterz.ncycle

zip_cycle
---------
.. autofunction:: listools.iterz.zip_cycle

zip_inf_cycle
-------------
.. autofunction:: listools.iterz.zip_inf_cycle

zip_longest
-----------
.. autofunction:: listools.iterz.zip_longest

zip_syzygy
----------
.. autofunction:: listools.iterz.zip_syzygy



listutils module
================

.. automodule:: listools.listutils

list_gcd
--------
.. autofunction:: listools.listutils.list_gcd

list_lcm
--------
.. autofunction:: listools.listutils.list_lcm

list_mask
---------
.. autofunction:: listools.listutils.list_mask

list_mask_cycle
---------------
.. autofunction:: listools.listutils.list_mask_cycle

period_len
----------
.. autofunction:: listools.listutils.period_len

shuffle
-------
.. autofunction:: listools.listutils.shuffle



llogic module
=============

.. automodule:: listools.llogic

difference
----------
.. autofunction:: listools.llogic.difference

intersection
------------
.. autofunction:: listools.llogic.intersection

is_ascending
------------
.. autofunction:: listools.llogic.is_ascending

is_contained
------------
.. autofunction:: listools.llogic.is_contained

is_descending
-------------
.. autofunction:: listools.llogic.is_descending

mixed_type
----------
.. autofunction:: listools.llogic.mixed_type

single_type
-----------
.. autofunction:: listools.llogic.single_type

symmetric_difference
--------------------
.. autofunction:: listools.llogic.symmetric_difference

union
-----
.. autofunction:: listools.llogic.union