A Rust vector computation library
Test Status
User documentation
User documentation is available at https://docs.rs/vectora.
Vectora is a library for n-dimensional vector computation. The main library entry point is the Vector struct. Please see the Gettting Started guide for a detailed library API overview with examples.
Developer documentation
Contributing
Issues
The issue tracker is available on the GitHub repository. Don't be shy. Please report any issues that you identify so that we can address them.
Source contributions
Contributions are welcomed. Submit your changes as a GitHub pull request. Please add new tests for source contributions that are not covered by our current test suite.
Clone the repository
git clone https://github.com/chrissimpkins/vectora.git
Testing
The project is tested with the latest GitHub Actions macOS, Linux (Ubuntu), and Windows environment runners using the stable and beta rustc toolchains.
Edit the source files, then run the unit and doc test suite locally with the command:
cargo test
Run clippy lints with:
cargo clippy -- -D warnings
Documentation contributions
The docs.rs documentation is authored in the Rust source files. Edit the text and build a local version of the project documentation for review with the command:
cargo doc
The documentation index.html page can be found on the following relative path from the root of the repository: target/doc/vectora/index.html.
Submit your doc edits as a GitHub pull request.
License
Vectora is released under the Apache License, v2.0.