vectora 0.8.1

A vector computation library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

<img src="https://raw.githubusercontent.com/chrissimpkins/vectora/img/img/vectora.png" width="350">

## A Rust library for vector computation

[![Crates.io](https://img.shields.io/crates/v/vectora)](https://crates.io/crates/vectora)
[![docs.rs](https://img.shields.io/docsrs/vectora)](https://docs.rs/vectora)
[![GitHub](https://img.shields.io/github/license/chrissimpkins/vectora)](LICENSE)

## Test Status

[![stable toolchain unit tests](https://github.com/chrissimpkins/vectora/actions/workflows/stable-unittests.yml/badge.svg)](https://github.com/chrissimpkins/vectora/actions/workflows/stable-unittests.yml)
[![beta toolchain unit tests](https://github.com/chrissimpkins/vectora/actions/workflows/beta-unittests.yml/badge.svg)](https://github.com/chrissimpkins/vectora/actions/workflows/beta-unittests.yml)
[![clippy lints](https://github.com/chrissimpkins/vectora/actions/workflows/lints.yml/badge.svg)](https://github.com/chrissimpkins/vectora/actions/workflows/lints.yml)
[![rustfmt check](https://github.com/chrissimpkins/vectora/actions/workflows/fmt.yml/badge.svg)](https://github.com/chrissimpkins/vectora/actions/workflows/fmt.yml)

## About

Vectora is a library for n-dimensional vector computation with real and complex scalar types. The main library entry point is the [`Vector`](https://docs.rs/vectora/latest/vectora/types/vector/struct.Vector.html) struct.  Please see the [Gettting Started Guide](https://docs.rs/vectora/latest/vectora/#getting-started) for a detailed library API overview with examples.

## User documentation

User documentation is available at https://docs.rs/vectora.

### Minimum Rust Version Compatibility Policy

This project parameterizes generics by constants and relies on the [constant generics feature support stabilized in Rust v1.51.0](https://github.com/rust-lang/rust/pull/79135).   

The minimum supported `rustc` version is believed to be v1.51.0.

### Include Vectora in Your Project

Import the library in the `[dependencies]` section of your `Cargo.toml` file:

**Cargo.toml**

```toml
[dependencies]
vectora = "0.8.1"
```

## Developer documentation

### Contributing

#### ![L4 Header](https://via.placeholder.com/12/B01721/000000?text=+) Issues

The [issue tracker](https://github.com/chrissimpkins/vectora/issues) is available on the GitHub repository. Don't be shy. Please report any issues that you identify so that we can address them.

#### ![L4 Header](https://via.placeholder.com/12/B01721/000000?text=+) Source contributions

Contributions are welcomed.  Submit your changes as a GitHub pull request. Please add new tests for source contributions that our current test suite does not cover.

#### ![L4 Header](https://via.placeholder.com/12/B01721/000000?text=+) Clone the repository

```txt
git clone https://github.com/chrissimpkins/vectora.git
```

#### ![L4 Header](https://via.placeholder.com/12/B01721/000000?text=+) Testing

The project is tested with the latest GitHub Actions macOS, Linux (Ubuntu), and Windows environment runners using the stable and beta `rustc` toolchains.

##### Unit and doc test suite

Edit the source files, then run the unit and doc test suite locally with the command:

```txt
cargo test
```

##### Unit tests only

```txt
cargo test --lib
```

##### Doc tests only

```txt
cargo test --doc
```

##### Clippy lints

Clippy lints are not executed with the above commands.  Use the following to lint Rust source files with clippy:

```txt
cargo clippy -- -D warnings
```

##### Fuzzing

This crate supports [`cargo fuzz`](https://github.com/rust-fuzz/cargo-fuzz) + [`libFuzzer`](https://llvm.org/docs/LibFuzzer.html) based fuzzing with the nightly rustc toolchain in supported environments.

[Install the `rustc` nightly toolchain](https://rust-lang.github.io/rustup/concepts/channels.html#working-with-nightly-rust).

Then, install `cargo-fuzz` with:

```
cargo +nightly install -f cargo-fuzz
```

Edit the fuzz target source in the `fuzz/fuzz_vectora.rs` file and begin fuzzing with the command:

```
cargo +nightly fuzz run fuzz_vectora
```

Please see the [Fuzzing with cargo-fuzz chapter](https://rust-fuzz.github.io/book/cargo-fuzz.html) of the Rust Fuzz book for additional documentation.

#### ![L4 Header](https://via.placeholder.com/12/B01721/000000?text=+) 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:

```txt
cargo doc
```

The documentation `index.html` page can be found on the following relative path from the repository's root: `target/doc/vectora/index.html`.

Submit your doc edits as a GitHub pull request.

## Changes

Please see [CHANGELOG.md](CHANGELOG.md).

## License

Vectora is released under the [Apache License, v2.0](LICENSE).