Initial commit

Author: Iteron-dev

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [master]
+
+
+permissions:
+  contents: write
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          sudo apt-get install -y doxygen graphviz
+          pip install sphinx breathe furo
+
+      - name: Build documentation
+        working-directory: ./docs
+        run: |
+          sphinx-build -b html . _build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build
+          force_orphan: true

.gitignore

@@ -0,0 +1 @@
+build

CMakeLists.txt

@@ -0,0 +1,26 @@
+cmake_minimum_required(VERSION 3.12)
+project(gate LANGUAGES C)
+
+set(CMAKE_C_STANDARD 17)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+set(CMAKE_C_EXTENSIONS ON)
+
+include_directories(${PROJECT_SOURCE_DIR})
+
+add_compile_options(
+        -Wall
+        -Wextra
+        -Wno-implicit-fallthrough
+        -fPIC
+)
+
+if (CMAKE_BUILD_TYPE STREQUAL "Release")
+    add_compile_options(-march=native -O3)
+else ()
+    add_compile_options(-O2)
+endif()
+
+add_library(gate SHARED src/gate.c src/vector.c src/gate.h src/vector.h)
+
+add_executable(example example.c)
+target_link_libraries(example PRIVATE gate)

README.md

@@ -0,0 +1,66 @@
+# Logic gates library
+
+## Overview
+
+A fast and space-efficient library for handling combinational Boolean circuits composed of the following types of gates:
+- NAND, AND, OR, NOR, XOR, XNOR
+
+
+## Gate implementation details
+
+- A gate has a non-negative integer number of fan-ins (inputs) and one fan-out (output).
+- A gate with no fan-ins always outputs a signal with the value false.
+- For a positive n, the fan-ins of an n-input gate are numbered from 0 to n - 1.
+- A Boolean signal with values false or true can be supplied to the fan-ins of a gate.
+- The fan-out signal from a gate can be connected to multiple fan-ins of other gates.
+- Each fan-in of a gate can have only one signal source connected to it.
+
+## API Reference
+
+You can find the API reference for this library at the following link: [API Reference](link).
+
+## Building and Running
+
+### Prerequisites:
+To build and use this library, you need:
+
+- CMake version 3.12 or higher.
+- A supported compiler, such as GCC or Clang, with support for the C17 standard.
+
+### Compilation
+
+1. Download or clone the repository.
+ 
+2. Build the library and example program by executing the following commands in the root of the repository:
+
+```bash
+cmake -B build/
+make -C build/
+```
+
+This will create two binaries in `build/` directory: 
+- `libgate.so` - the shared library file.
+- `example` -  an example program demonstrating the usage of the library.
+
+You can now link `libgate.so` to your own program.
+
+#### Release Build
+For potentially better performance, build in Release mode to enable `-O3` and `-march=native`:
+```bash
+cmake -B build/ -DCMAKE_BUILD_TYPE=Release
+make -C build/
+```
+
+
+### Example
+For demonstration purposes, you can refer to and modify the `example.c` file. It showcases a sample usage of this library.
+
+Gate from `example.c`:
+
+![image info](./example_gate.svg)
+
+
+## License
+
+This project is licensed under the **GNU General Public License v3.0**.  
+See [LICENSE](LICENSE.md) for the full terms.

docs/Doxyfile

@@ -0,0 +1,5 @@
+INPUT                  = ../src/gate.c ../src/gate.h ../src/vector.c ../src/vector.h
+OUTPUT_DIRECTORY       = doxygen
+GENERATE_XML           = YES
+PROJECT_NAME           = "Logic gates library"
+PROJECT_BRIEF          = "Logic gates library"

docs/conf.py

@@ -0,0 +1,13 @@
+from datetime import datetime
+from subprocess import call
+
+extensions = ["breathe"]
+html_theme = "furo"
+html_title = "Logic gates library"
+
+call("doxygen", shell=True)
+
+breathe_projects = {"Logic gates library": "doxygen/xml"}
+breathe_default_project = "Logic gates library"
+
+copyright = f'{datetime.now().year} Iteron-dev. Licensed under the GNU GPLv3.'

docs/index.rst

@@ -0,0 +1,7 @@
+API Reference
+=============
+.. note::
+   The full README is available on `GitHub <https://github.com/iteron-dev/logic-gates-library/blob/main/README.md>`_.
+
+.. doxygenfile:: src/gate.h
+   :project: Logic gates library

example.c

@@ -0,0 +1,45 @@
+#ifdef NDEBUG
+#undef NDEBUG
+#endif
+
+#include "src/gate.h"
+#include <assert.h>
+#include <stdbool.h>
+
+static int example(void) {
+    gate_t *g0 = gate_new(AND, 2);
+    gate_t *g1 = gate_new(NAND, 2);
+    gate_t *g2 = gate_new(NAND, 2);
+
+    bool b0 = 0;
+    bool b1 = 1;
+    bool b = 1;
+
+    gate_connect_gate(g1, g0, 0);
+    gate_connect_gate(g2, g0, 1);
+
+    gate_connect_signal(&b0, g1, 0);
+    gate_connect_signal(&b0, g1, 1);
+    gate_connect_signal(&b0, g2, 0);
+    gate_connect_signal(&b1, g2, 1);
+
+
+    assert(gate_evaluate(&g0, &b, 1) == 2);
+    assert(b == 1);
+
+    gate_t *g4 = gate_new(XNOR, 2);
+    gate_connect_gate(g1, g4, 0);
+    gate_connect_gate(g0, g4, 1);
+    assert(gate_evaluate(&g4, &b, 1) == 3);
+    assert(b == 1);
+
+    gate_delete(g0);
+    gate_delete(g1);
+    gate_delete(g2);
+
+    return 0;
+}
+
+int main(void) {
+    return example();
+}