point-nd 0.5.0

A simple and flexible no-std struct to model points on axes of any dimensions
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

#![no_std]

//!
//! A simple and flexible no-std struct, based on an array, used to model points on axes of any dimensions.
//!
//! See the `PointND` struct for basic usage
//!
//! # Compatibility
//!
//! This crate was designed to be `no_std` and `wasm` compatible, and has been tested in those environments.
//!
//! `PointND` uses constant generics, it is recommended for use with a Rust version of **at least 1.51**
//!
//! # Features
//!
//! - `conv_methods`
//!
//!     - **Enabled by default**
//!
//!     - Methods which access and transform the values contained by **1..=4** dimensional points.
//!
//!     - Enables the following sub-features (each of which can be enabled individually if needed):
//!
//!         - `x`: Convenience methods for `1D` points
//!
//!         - `y`: Convenience methods for `2D` points
//!
//!         - `z`: Convenience methods for `3D` points
//!
//!         - `w`: Convenience methods for `4D` points
//!
//! - `appliers`
//!
//!     - **Enabled by default**
//!
//!     - Methods which allow function pointers to be passed to points in order to transform values.
//!
//!     - If this and the `var-dims` feature are disabled, this crate will include zero dependencies
//!
//! - `var-dims`
//!
//!     - Methods which append or remove values from points.
//!
//!     - If this and the `appliers` feature are disabled, this crate will include zero dependencies
//!

mod point;
mod utils;

pub use point::PointND;

#[cfg(feature = "appliers")]
pub use utils::{ApplyFn, ApplyDimsFn, ApplyValsFn, ApplyPointFn};