Vectora is a library for n-dimensional vector computation. It currently supports scalar integer and floating point data. The main library entry point is the Vector struct. Please see the Gettting Started Guide for a detailed library API overview with examples.
User documentation is available at https://docs.rs/vectora.
This project parameterizes generics by constants and relies on the constant generics feature support that was stabilized in Rust v1.51.0.
The minimum supported rustc version is believed to be v1.51.0.
Import the library in the [dependencies] section of your Cargo.toml file:
Cargo.toml
toml
[dependencies]
vectora = "0.1.3"
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.
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.
txt
git clone https://github.com/chrissimpkins/vectora.git
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:
txt
cargo test
Run clippy lints with:
txt
cargo clippy -- -D warnings
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:
txt
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.
Vectora is released under the Apache License, v2.0.
