{"id":27027212,"url":"https://github.com/crissyro/library-for-working-with-matrices","last_synced_at":"2025-04-04T23:17:33.467Z","repository":{"id":258656150,"uuid":"866349048","full_name":"crissyro/library-for-working-with-matrices","owner":"crissyro","description":"coursework on programming basics on C++ in BSTU named after V.G. Shukhov","archived":false,"fork":false,"pushed_at":"2025-03-10T08:36:10.000Z","size":222,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-10T09:41:06.703Z","etag":null,"topics":["bstu","cplusplus-17","linux","matrix","matrix-library"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crissyro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-02T05:02:09.000Z","updated_at":"2025-03-10T08:36:14.000Z","dependencies_parsed_at":"2025-03-10T09:31:55.809Z","dependency_job_id":"03205098-576f-4fcf-960e-17230ffaf0e6","html_url":"https://github.com/crissyro/library-for-working-with-matrices","commit_stats":null,"previous_names":["crissyro/library-for-working-with-matrices"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crissyro%2Flibrary-for-working-with-matrices","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crissyro%2Flibrary-for-working-with-matrices/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crissyro%2Flibrary-for-working-with-matrices/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crissyro%2Flibrary-for-working-with-matrices/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crissyro","download_url":"https://codeload.github.com/crissyro/library-for-working-with-matrices/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247261563,"owners_count":20910109,"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":["bstu","cplusplus-17","linux","matrix","matrix-library"],"created_at":"2025-04-04T23:17:32.921Z","updated_at":"2025-04-04T23:17:33.461Z","avatar_url":"https://github.com/crissyro.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# library-for-working-with-matrices\nCoursework on programming basics in C++ at BSTU named after V.G. Shukhov\n\n## Matrix Library\n\nThis project is a C++ library for working with various types of matrices, sparse, and block matrices. The library provides a wide range of functionalities for matrix operations, manipulation, and analysis. It aims to facilitate efficient handling of matrix data structures, especially in applications where sparsity is a significant factor.\n\n### Features\n\n- **Dense Matrix Operations**: Support for standard matrix operations such as addition, subtraction, multiplication, and transposition.\n- **Sparse Matrix Representation**: Efficient storage and manipulation of sparse matrices, including operations tailored for sparse data.\n- **Block Matrix Support**: Capabilities to handle block matrices, allowing for more advanced matrix manipulations and computations.\n- **Comprehensive Testing**: Includes unit tests to ensure the reliability and correctness of the implemented functionalities. Note that tests for block matrices are currently not implemented due to time constraints.\n- **Documentation**: Automatically generated documentation using Doxygen.\n\n### Student Errors\n\nPlease note that this project may contain some student errors as it is part of a coursework assignment. Users are encouraged to review the code and contribute improvements.\n\n## Getting Started\n\n### Prerequisites\n\n- C++17 compiler (e.g., g++)\n- Make\n- Doxygen (for documentation generation)\n- Google Test (for testing)\n\n### Building the Library\n\nTo build the library and run the tests, follow these steps:\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/crissyro/library-for-working-with-matrices.git\n   cd library-for-working-with-matrices\n   ```\n\n2. Use `make` to build the project:\n   ```bash\n   make\n   ```\n\n3. Run tests:\n   ```bash\n   make test\n   ```\n\n4. Generate a code coverage report (optional):\n   ```bash\n   make gcov_report\n   ```\n\n### Makefile Targets\n\n- `all`: The default target that builds the library and runs the tests.\n- `test`: Compiles and runs the tests without coverage.\n- `gcov_report`: Compiles and runs the tests with coverage, generating coverage reports using lcov and genhtml.\n- `format`: Checks and formats all `.hpp` and `.cpp` files using clang-format.\n- `doxygen`: Generates documentation using Doxygen based on the provided configuration file.\n- `clean`: Cleans up object files, test binaries, coverage reports, and generated documentation.\n- `clean_doxygen`: Cleans up the generated Doxygen documentation.\n- `rebuild`: Cleans the project and rebuilds it from scratch.\n\n## Usage\n\nTo use the library, include the headers in your C++ project as follows:\n\n```cpp\n#include \"matrix/matrix.hpp\"\n#include \"sparse_matrix/sparse_matrix.hpp\"\n#include \"block_matrix/block_matrix.hpp\"\n```\n\n### Example\n\nHere is a simple example of how to create a dense matrix and perform some operations:\n\n```cpp\n#include \"matrix/matrix.hpp\"\n\nint main() {\n    int arr5[5][5] = {\n        {1, 2, 3, 4, 5},\n        {5, 4, 3, 2, 1},\n        {1, 3, 5, 2, 4},\n        {4, 5, 2, 1, 3},\n        {2, 1, 4, 5, 3}\n    };\n\n    Matrix\u003cint\u003e mat(arr5);\n\n    mat.printMatrix();\n    \n    return 0;\n}\n```\n\n## Documentation\n\nTo generate the documentation for the library, you can run the following command:\n\n```bash\nmake doxygen\n```\n\nThe generated documentation will be available in the `docs` directory.\n\n## Contributing\n\nContributions are welcome! If you have suggestions for improvements or features, please create an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the GNU GENERAL PUBLIC LICENSE. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrissyro%2Flibrary-for-working-with-matrices","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrissyro%2Flibrary-for-working-with-matrices","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrissyro%2Flibrary-for-working-with-matrices/lists"}