Skip to main content

A Python package for group action.

Project description

README

QUESTION

When you have to design a standard cell libray, you need to choose a number of combinatorial cells. You can simply ask a friend and start from an existing list or build your own from scratch. But how? More specifically, how many n-input Boolean functions are there?

This latter question connects to the mathematical concept of group action that is a pivotal part of Algebra. If you like Rubyk's cube, you should not feel too uncomfortable.

It can be reformulated in this context as follows. What are the orbits in the action of the symmetric group $S_n$ on the set of n-input Boolean functions $X_n=B^{B^n}$?

DESCRIPTION

The name of this package is group_action. The version of this package is 0.1.6. It contains a library module named library and an application named orbits.

It computes the orbits in the action of the symmetric group $S_n$ on the set of n-input Boolean functions $X_n=B^{B^n}$.

The result is basically a list of signatures that is presented in 2 formats and 2 levels of details. Here, a signature is a non negative integer representing a Boolean function.

For instance, what 2-input Boolean function does 12 represent? I use Big Endian format for binary words. 12 = 0101 This gives the following truth table

x0 x1 f(x0, x1)
0  0  0
1  0  1
0  1  0
1  1  1

and the following expression f(x0, x1) = x0 & ~x1 | x0 & x1 = x0

Note: x1 does not figure in this expression.

So 12 represents a 1-input Boolean function. It gives a standard cell called buffer.

To move forward, is 12 the only signature representing a buffer cell? Actually this answer is no! If you permut x0 and x1, you get the following truth table.

x0 x1 f(x0, x1)
0  0  0
1  0  0
0  1  1
1  1  1

It corresponds to f(x0, x1) = ~x0 & x1 | x0 & x1 = x1, another instance of the buffer cell.

This is what the group action concept is all about, and behyond :-)

HOW DOES IT WORK?

Each permutation of $S_n$ is applied to each n-input Boolean function f of $X_n$, computing a new n-input Boolean function g. These computations are gathered into chunks and run in parallel on a number of cores.

Each pair $\lbrace f, g \rbrace$ forms an edge of a graph that is latter analyzed. The orbits we are looking for are the connected parts of the obtained graph.

From this analysis, one can get the number of orbits, a list of representatives, and the detailed contents of each orbit. Boolean functions are represented by their signatures as non negative integers.

The results are printed out to the screen or stored into a json file named data.json. Binary data is considered as Big Endian throughout the code.

INSTALL

Run pip install group_action. This application orbits is installed automatically. You are ready to go :-)

USAGE

orbits [-h] [--n N] [--c C] [--r] [--v] [--j]

Brut force computation of orbits of n-input 1-output Boolean functions under the action of the symmetric group Sn.

options:
  -h, --help  show this help message and exit
  --n N       Number of inputs
  --c C       Number of cores
  --v         Output every element of each orbit
  --j         Output data.json file

EXAMPLE

After installation, run orbits --n 3 --c 12 in order to run on 12 cores and to get the number of orbits and a representative of each orbit as an integer signature for 3-input, 1-output Boolean functions.

TEST

n=0      2 orbits
n=1      4 orbits
n=2     12 orbits
n=3     80 orbits
n=4  3 984 orbits

KNOWN BUGS AND LIMITATIONS

  1. The $n=5$ step requires a lot of memory. Let me know if you go through :-)
  2. The group action is concrete and set up to $G=S_n$ and $X=B^{B^n}$ in this version.
  3. The default number of cores could be set up automatically.
  4. The packaging is managed through PyPI, not yet synchronized to GitHub.
  5. The documentation for the library has not been generated yet.

FEEDBACK

Any comment and/or improvement whether on optimization, packaging, documentation, or on any other appropriate topic is welcome :-)

CONTACT

You can reach me antoine AT sirianni DOT ai.

DOCUMENTATION

Check OR Conf 2024 paper titled "Open Source Standard Cell Library Design" by Antoine Sirianni once published.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

group_action-0.1.6.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

group_action-0.1.6-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file group_action-0.1.6.tar.gz.

File metadata

  • Download URL: group_action-0.1.6.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for group_action-0.1.6.tar.gz
Algorithm Hash digest
SHA256 71fcc72f93fcc77ee16052249fd913b1980c22018125a932f6f4086850265adc
MD5 45830f427bed9ffb8bff0cb150f0bf21
BLAKE2b-256 f7738dc382e2d7148f52851288b9d86cda4922fc1377c13cc72b43cb28b49b46

See more details on using hashes here.

File details

Details for the file group_action-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for group_action-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4a97c2875e269ca03c5352597a13ee70cbf72667d265929b35e0881e70d84a95
MD5 3b8566c8cc7148a7f7bd3bbef6839eec
BLAKE2b-256 30c54701b90d93b1e1cbde547edb1057580bd4a9bf03addef2cd3fb5f5a44c5b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page