catenary 0.2.0

A library for catenary curves
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


# Catenary

Catenary is a Rust library for calculating catenary curves. It provides tools to model the shape of a hanging flexible chain or cable under its own weight.

## Features

- Calculate catenary curves from given parameters
- Easy to integrate with other Rust projects

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
catenary = "0.1.0"
```

## Generate coefficient table
In order to quickly find catenary, with 2 points and a length, we can interpolate between catenaries that have been saved into a table. To regenerate this table, do:

```sh
cargo run --bin generate_table -- --help
```

Getting the desired catenary by interpolation from the table is done with this function:
```rust
let cat = table.get_catenary::<f64>(&p0, &p1, &l).unwrap();
```

## Or just download them

```rust
let path = get_dataset_path().await.unwrap();
```

## Usage

Here is a simple example of how to use Catenary:

```rust
extern crate catenary;

use catenary::Catenary;

fn main() {
    let catenary = Catenary::new(1.1, 2.2, 3.3, -4.4, 5.5);
    let (p0, p1) = catenary.end_points();

    let solved = Catenary64::from_points_length(&p0, &p1, catenary.length()).unwrap();

    assert_relative_eq!(catenary.a, solved.a, epsilon = 1e-5);
    assert_relative_eq!(catenary.c, solved.c, epsilon = 1e-5);
    assert_relative_eq!(catenary.h, solved.h, epsilon = 1e-5);
}
```

## License

This project is licensed under the MIT or Apache-2.0 Licenses.

## Contribution

Contributions are welcome! Please open an issue or submit a pull request on GitLab.