vecstasy 0.1.10

vecstasy is a library for SIMD-enabled floating-point operations on vectors.
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

# vecstasy

Minimal and fast Rust library for high-dimensional vector arithmetic.

[![crates.io](https://img.shields.io/crates/v/vecstasy)](https://crates.io/crates/vecstasy) [![docs.rs](https://docs.rs/vecstasy/badge.svg)](https://docs.rs/vecstasy) ![gitlab.epfl.ch](https://gitlab.epfl.ch/randl/vecstasy/badges/main/coverage.svg)
![gitlab.epfl.ch](https://gitlab.epfl.ch/randl/vecstasy/badges/main/pipeline.svg)

---

## Features

* **`VecLike` trait** defining:

  * `l2_dist_squared` (squared Euclidean distance)
  * `dot` (inner product)
  * `normalized` (unit‑length copy)
* **Always-on SIMD‑backed implementation** for `&[f32]` slices via Rust’s unstable portable SIMD APIs
* **`HashVec` wrapper**: stable hashing & equality by IEEE‑754 bit patterns

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
vecstasy = "0.1"
```
or `cargo add vecstasy`

## Usage

### Core trait (`VecLike`)

```rust
use vecstasy::VecLike;

let a: &[f32] = &[1.0; 8];  // length should be multiple of SIMD_LANECOUNT, which is 8 by default
let b: &[f32] = &[2.0; 8];

let dist2 = a.l2_dist_squared(&b);
let dot    = a.dot(&b);
let normed: Vec<f32> = a.normalized();
```

### Stable hashing (`HashVec`)

```rust
use vecstasy::HashVec;
use std::collections::hash_map::DefaultHasher;
use std::hash::{Hash, Hasher};

let data: &[f32] = &[0.0; 8];
let hv = HashVec::from(data);

let mut hasher = DefaultHasher::new();
hv.hash(&mut hasher);
let hash_value = hasher.finish();
```

## Requirements

* **Nightly Rust** with the `portable_simd` feature enabled

## Documentation

API docs are available on [docs.rs](https://docs.rs/vecstasy).

## License

MIT. See [LICENSE](LICENSE) for details.