smplx 0.0.1

smplx focuses on the simplex and its applications in mathematics, topology, and other fields.
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

# smplx


[![crates.io](https://img.shields.io/crates/v/smplx.svg)](https://crates.io/crates/smplx)
[![docs.rs](https://docs.rs/smplx/badge.svg)](https://docs.rs/smplx)
[![license](https://img.shields.io/crates/l/smplx.svg)](https://crates.io/crates/smplx)

[![clippy](https://github.com/FL03/smplx/actions/workflows/clippy.yml/badge.svg)](https://github.com/FL03/smplx/actions/workflows/clippy.yml)
[![rust](https://github.com/FL03/smplx/actions/workflows/rust.yml/badge.svg)](https://github.com/FL03/smplx/actions/workflows/rust.yml)

***

_**The library is currently in the early stages of development and is not yet ready for production use.**_

Welcome to smplx, a topologically oriented crate focused on simplexes and their complexes.

## Features


- [x] Simplex

## Background


A simplex describes the smallest (and simplest) polytope in any dimension. More specifically, $n$-simplex $\Delta^n$ is defined to be the $n$-dimensional polytope formed from the convex hull $C$ of its $n+1$ verices where the vertices are affinely independent points $u_0, u_1, \ldots, u_n \in \mathbb{R}^n$.

$C = \biggl\{ \sum_{i=0}^{k} \lambda_i v_i : \lambda_i\geq{0} \text{ for all } j \text{ and }\sum_{i=0}^{k} \lambda_i = 1 \biggr\}$

## Getting Started


### Building from the source


Start by cloning the repository

```bash
git clone https://github.com/FL03/smplx.git
cd smplx
```

#### _Build the workspace_


```bash
cargo build --all-features -r --workspace
```

#### _Run an exmple_


```bash
cargo run -p smplx --example {basic|complex|...|etc.}
```

## Usage


Add this to your `Cargo.toml`:

```toml
[dependencies.smplx]
features = ["full"]
version = "0.0.1"
```

### Examples


#### _Simplex_


```rust
    extern crate smplx;

    use smplx::Simplex;

    fn main() -> Result<(), Box<dyn std::error::Error>> {
        tracing_subscriber::fmt::init();
        tracing::info!("Welcome to smplx!");

        let simplex = Simplex::new().dim(2).with_vertices([0, 1, 2]).build()?;

        Ok(())
    }
```

## Contributing


Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.