.. Boolean-Cayley-graphs documentation master file, created by
   sphinx-quickstart on Sun Jun 11 19:07:49 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

*************************************************************
Boolean-Cayley-graphs: Python package reference documentation
*************************************************************

Boolean-Cayley-graphs is a collection of Sage and Python software for the investigation of bent Boolean functions,
their Cayley graphs, and associated structures.

This is the reference documentation for the ``boolean_cayley_graphs`` Python package:
a set of Python classes and utility functions that forms the core of the Boolean-Cayley-graphs collection.

The documentation is organized into a thematic index and other indices and tables.

See also the ``README.md`` file for Boolean-Cayley-graphs, as well as the accompanying paper [Leo2017]_.

Thematic index
==============

Classifications of bent functions
---------------------------------

* :doc:`Classification of bent functions by their Cayley graphs <boolean_cayley_graphs.bent_function_cayley_graph_classification>`
* :doc:`Classification of bent functions by their weight <boolean_cayley_graphs.weight_class>`

Classification of boolean functions
-----------------------------------

* :doc:`Classification of boolean functions within an extended translation class <boolean_cayley_graphs.boolean_function_extended_translate_classification>`

Boolean functions
-----------------

* :doc:`An improved boolean function class <boolean_cayley_graphs.boolean_function_improved>`
* :doc:`A general linear equivalence class of boolean functions <boolean_cayley_graphs.boolean_function_general_linear_class>`
* :doc:`Bent boolean functions <boolean_cayley_graphs.bent_function>`

Graphs
------

* :doc:`An improved Graph class <boolean_cayley_graphs.graph_improved>`
* :doc:`Boolean graphs <boolean_cayley_graphs.boolean_graph>`
* :doc:`Boolean linear code graphs <boolean_cayley_graphs.boolean_linear_code_graph>`
* :doc:`Cayley graph of a boolean function <boolean_cayley_graphs.boolean_cayley_graph>`
* :doc:`Strongly regular graphs <boolean_cayley_graphs.strongly_regular_graph>`
* :doc:`The Royle X graph <boolean_cayley_graphs.royle_x_graph>`

Linear codes
------------

* :doc:`Boolean linear codes <boolean_cayley_graphs.boolean_linear_code>`
* :doc:`Some binary projective two weight codes <boolean_cayley_graphs.binary_projective_two_weight_codes>`

Parallel algorithms
-------------------

* :doc:`Classification in parallel using fork <boolean_cayley_graphs.classify_in_parallel>`
* :doc:`Classification in parallel using MPI <boolean_cayley_graphs.classify_in_mpi_parallel>`

Database interfaces
-------------------

* :doc:`Interface to a classification database using psycopg2 <boolean_cayley_graphs.classification_database_psycopg2>`
* :doc:`Interface to a classification database using sqlite3 <boolean_cayley_graphs.classification_database_sqlite3>`

Utilities
---------

* :doc:`Bit-level properties of integers <boolean_cayley_graphs.integer_bits>`
* :doc:`Controls for timing and tracing <boolean_cayley_graphs.cayley_graph_controls>`
* :doc:`Improved container classes <boolean_cayley_graphs.containers>`
* :doc:`Tests for GF(2) linear algebra <boolean_cayley_graphs.linear>`
* :doc:`Load and save Sage objects with standardized names <boolean_cayley_graphs.saveable>`

References
----------

* :doc:`Reference generation <boolean_cayley_graphs.references>`
* :doc:`References <references>`

Indices and tables
==================

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