COXave 1.0.9

Instruments for codings
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

![Greenfield](https://img.shields.io/badge/Greenfield-0fc908.svg)
[![Deps](https://deps.rs/repo/github/xavetar/COXave/status.svg)](https://deps.rs/repo/github/xavetar/COXave)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# COXave

![COXave Logo](res/coxave-header.png)

<div style="display: flex; justify-content: center; gap: 20px;">
    <a href="https://nowpayments.io/donation?api_key=NRH28QG-ABRM7CC-J7NVGXN-F8FTRS1&source=lk_donation&medium=referral" target="_blank">
        <img src="https://nowpayments.io/images/embeds/donation-button-black.svg" alt="Crypto donation button by NOWPayments" style="height: 60px !important; width: 217px !important;">
    </a>
</div>

## About

The library is hosted on [crates.io](https://crates.io/crates/COXave/).

## Add library

CLI:

```shell
cargo add COXave
```

Cargo.toml:

```toml
[dependencies]
COXave = { version = "*" }
```

## Features

Add feature to Cargo.toml to use universal functors (without SIMD-accelerated):

```toml
[dependencies]
COXave = { version = "*", features = ["universal"] }
```

## Build

### Specify target instruction set

#### ARM/AARCH64

##### V7/NEON

```shell
export RUSTFLAGS="-C target-feature=+neon,+v7"
```

##### V8/NEON

```shell
export RUSTFLAGS="-C target-feature=+neon"
```

#### x86/x86_64

##### SSE/SSE2

```shell
export RUSTFLAGS="-C target-feature=+sse,+sse2"
```

##### SSE/SSE2 (+SSSE3)

```shell
export RUSTFLAGS="-C target-feature=+sse,+sse2,+ssse3"
```

##### AVX/AVX2

```shell
export RUSTFLAGS="-C target-feature=+avx,+avx2"
```

##### AVX-512F/AVX-512BW

```shell
export RUSTFLAGS="-C target-feature=+avx512f,+avx512bw"
```

Before using unstable features you need to run this:

```shell
rustup default nightly || rustup toolchain install nightly
```

### Usage with Python

```shell
maturin build -m api/Cargo.toml --release --features python && pip install --force-reinstall target/wheels/COXave-*.whl
```

## License

COXave is primarily distributed under the terms of three the Anti-Virus license and MIT license and the Apache License (Version 2.0)

See [LICENSE-ANTI-VIRUS](LICENSE) and [LICENSE-APACHE](LICENSE) and [LICENSE-MIT](LICENSE) for details.