{"id":19129101,"url":"https://github.com/teleprint-me/fixed-point","last_synced_at":"2025-08-26T19:26:21.788Z","repository":{"id":217367149,"uuid":"743684742","full_name":"teleprint-me/fixed-point","owner":"teleprint-me","description":"A lightweight Digital Signal Processing library written in pure C","archived":false,"fork":false,"pushed_at":"2024-09-05T06:55:55.000Z","size":258,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-03T10:45:48.535Z","etag":null,"topics":["digital-signal-processing","fixed-point","floating-point","ieee-754","quantization"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teleprint-me.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-15T19:05:48.000Z","updated_at":"2024-09-05T06:55:58.000Z","dependencies_parsed_at":"2024-01-16T01:34:44.508Z","dependency_job_id":"5aa621fa-8760-4b30-83f3-5f2a51dcca69","html_url":"https://github.com/teleprint-me/fixed-point","commit_stats":null,"previous_names":["teleprint-me/fixed-point"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teleprint-me%2Ffixed-point","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teleprint-me%2Ffixed-point/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teleprint-me%2Ffixed-point/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teleprint-me%2Ffixed-point/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teleprint-me","download_url":"https://codeload.github.com/teleprint-me/fixed-point/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240199229,"owners_count":19763825,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-signal-processing","fixed-point","floating-point","ieee-754","quantization"],"created_at":"2024-11-09T06:06:32.918Z","updated_at":"2025-02-22T16:15:52.032Z","avatar_url":"https://github.com/teleprint-me.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fixed-Point\n\n## Overview\n\nFixed-Point is a lightweight Digital Signal Processing library written in pure\nC, focusing on fixed-point precision, floating-point precision, and\nquantization.\n\n## Key Features\n\n- **Comprehensive Header Files**: Provides essential fixed-point data types and\n  arithmetic functions.\n- **Practical Examples**: Demonstrative projects showcasing the use and benefits\n  of fixed-point arithmetic.\n\n## Getting Started\n\n### Clone the Repository\n\nClone the repository with all submodules:\n\n```sh\ngit clone --recurse-submodules -j$(nproc) \\\n    https://github.com/teleprint-me/fixed-point.git\ncd fixed-point\n```\n\n### Update Submodules\n\nTo ensure all submodules are up to date, run:\n\n```sh\ngit submodule update --init --recursive\n```\n\n### Build the Project\n\nYou can choose between automated and manual builds.\n\n#### Automated Build\n\n1. Make the build script executable:\n\n   ```sh\n   chmod +x auto_build.sh\n   ```\n\n2. Run the script to build, compile, and test:\n\n   ```sh\n   ./auto_build.sh\n   ```\n\n#### Manual Build\n\n1. **Create the Build Environment:**\n\n   ```sh\n   cmake -B build -DCMAKE_BUILD_TYPE=Debug\n   ```\n\n2. **Compile the Code:**\n\n   ```sh\n   cmake --build build --config Debug -j$(nproc)\n   ```\n\n3. **Run Tests:**\n\n   ```sh\n   ctest --rerun-failed --output-on-failure --test-dir build\n   ```\n\n## Exploring the Codebase\n\nAfter cloning, explore the `fixed-point` directory to understand the library's\nstructure:\n\n- **Header Files**: Located in the `include` directory.\n- **Examples**: Sample projects demonstrating usage in the `examples` directory.\n\n```sh\nls include\nls examples\n```\n\n## Usage\n\nTo integrate the library into your C/C++ projects, include the header files:\n\n```c\n#include \"fixed_point.h\"\n```\n\nRefer to the example projects for guidance on using the library functions\neffectively.\n\n## References\n\n### Mathematical Background\n\n- [Calculus](https://leanpub.com/apexcalculus)\n- [Discrete Mathematics](https://discrete.openmathbooks.org/dmoi3.html)\n- [Statistics and Probability](https://stats.libretexts.org/Courses/Las_Positas_College/Math_40%3A_Statistics_and_Probability)\n- [Linear Algebra](https://understandinglinearalgebra.org/home.html)\n- [Digital Signal Processing](https://www.dspguide.com/)\n\n### Programming References\n\n- [C Programming Language Standard](https://www.open-std.org/JTC1/SC22/WG14/)\n- [C Reference](https://en.cppreference.com/w/c)\n- [CMake Reference](https://cmake.org/cmake/help/latest/)\n- [Bash Reference](https://www.gnu.org/software/bash/manual/html_node/index.html)\n\n## License\n\nThis project is licensed under the AGPL License. See the [LICENSE](LICENSE) file\nfor details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteleprint-me%2Ffixed-point","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteleprint-me%2Ffixed-point","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteleprint-me%2Ffixed-point/lists"}