Skip to content

Commit

Permalink
doc: Documentation fixes and dependency updates
Browse files Browse the repository at this point in the history
  • Loading branch information
acgetchell committed Jul 27, 2024
1 parent 9538214 commit 3ca481d
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 73 deletions.
68 changes: 34 additions & 34 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
nalgebra = "0.32.6"
nalgebra = "0.33.0"
num-traits = "0.2.19"
serde = { version = "1.0.203", features = ["derive"] }
serde_json = "1.0.117"
serde = { version = "1.0.204", features = ["derive"] }
serde_json = "1.0.120"
serde_test = "1.0.176"
uuid = { version = "1.8.0", features = ["v4", "fast-rng", "macro-diagnostics", "serde"] }
uuid = { version = "1.10.0", features = ["v4", "fast-rng", "macro-diagnostics", "serde"] }

[lints.rust]
unsafe_code = "forbid"
Expand Down
16 changes: 8 additions & 8 deletions src/delaunay_core/cell.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ use uuid::Uuid;
/// # Properties:
///
/// * `vertices`: A container of vertices. Each [Vertex] has a type T, optional
/// data U, and a constant D representing the number of dimensions.
/// data U, and a constant D representing the number of dimensions.
/// * `uuid`: The `uuid` property is of type [Uuid] and represents a
/// universally unique identifier for a [Cell] in order to identify
/// each instance.
/// universally unique identifier for a [Cell] in order to identify
/// each instance.
/// * `neighbors`: The `neighbors` property is an optional container of [Uuid]
/// values. It represents the [Uuid]s of the neighboring cells that are connected
/// to the current [Cell], indexed such that the `i-th` neighbor is opposite the
/// `i-th`` [Vertex].
/// values. It represents the [Uuid]s of the neighboring cells that are connected
/// to the current [Cell], indexed such that the `i-th` neighbor is opposite the
/// `i-th`` [Vertex].
/// * `data`: The `data` property is an optional field that can hold a value of
/// type `V`. It allows storage of additional data associated with the [Cell];
/// the data must implement [Eq], [Hash], [Ord], [PartialEq], and [PartialOrd].
/// type `V`. It allows storage of additional data associated with the [Cell];
/// the data must implement [Eq], [Hash], [Ord], [PartialEq], and [PartialOrd].
pub struct Cell<T, U, V, const D: usize>
where
T: Clone + Copy + Default + PartialEq + PartialOrd,
Expand Down
8 changes: 4 additions & 4 deletions src/delaunay_core/point.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
/// # Properties:
///
/// * `coords`: `coords` is a public property of the [Point]. It is an array of
/// type `T` with a length of `D`. The type `T` is a generic type parameter,
/// which means it can be any type. The length `D` is a constant unsigned
/// integer known at compile time.
/// type `T` with a length of `D`. The type `T` is a generic type parameter,
/// which means it can be any type. The length `D` is a constant unsigned
/// integer known at compile time.
pub struct Point<T, const D: usize>
where
T: Clone + Copy + Default + PartialEq + PartialOrd,
Expand Down Expand Up @@ -45,7 +45,7 @@ where
/// # Arguments:
///
/// * `coords`: The `coords` parameter is an array of type `T` with a
/// length of `D`.
/// length of `D`.
///
/// # Returns:
///
Expand Down
18 changes: 9 additions & 9 deletions src/delaunay_core/triangulation_data_structure.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,21 @@ use uuid::Uuid;
/// # Properties:
///
/// * `vertices`: A [HashMap] that stores vertices with their corresponding
/// [Uuid]s as keys. Each [Vertex] has a [Point] of type T, vertex data of type
/// U, and a constant D representing the dimension.
/// [Uuid]s as keys. Each [Vertex] has a [Point] of type T, vertex data of type
/// U, and a constant D representing the dimension.
/// * `cells`: The `cells` property is a [HashMap] that stores [Cell] objects.
/// Each [Cell] has one or more [Vertex] objects with cell data of type V.
/// Note the dimensionality of the cell may differ from D, though the [Tds]
/// only stores cells of maximal dimensionality D and infers other lower
/// dimensional cells (cf. [Facet]) from the maximal cells and their vertices.
/// Each [Cell] has one or more [Vertex] objects with cell data of type V.
/// Note the dimensionality of the cell may differ from D, though the [Tds]
/// only stores cells of maximal dimensionality D and infers other lower
/// dimensional cells (cf. [Facet]) from the maximal cells and their vertices.
///
/// For example, in 3 dimensions:
///
/// * A 0-dimensional cell is a [Vertex].
/// * A 1-dimensional cell is an `Edge` given by the `Tetrahedron` and two
/// [Vertex] endpoints.
/// [Vertex] endpoints.
/// * A 2-dimensional cell is a [Facet] given by the `Tetrahedron` and the
/// opposite [Vertex].
/// opposite [Vertex].
/// * A 3-dimensional cell is a `Tetrahedron`, the maximal cell.
///
/// A similar pattern holds for higher dimensions.
Expand Down Expand Up @@ -86,7 +86,7 @@ where
/// # Arguments:
///
/// * `points`: A container of [Point]s with which to initialize the
/// triangulation.
/// triangulation.
///
/// # Returns:
///
Expand Down
8 changes: 4 additions & 4 deletions src/delaunay_core/utilities.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ pub fn make_uuid() -> Uuid {
/// # Arguments:
///
/// * `vertices`: A [HashMap] containing [Vertex] objects, where the key is a
/// [Uuid] and the value is a [Vertex].
/// [Uuid] and the value is a [Vertex].
/// * `ordering`: The `ordering` parameter is of type [Ordering] and is used to
/// specify whether the function should find the minimum or maximum
/// coordinates. [Ordering] is an enum with three possible values: `Less`,
/// `Equal`, and `Greater`.
/// specify whether the function should find the minimum or maximum
/// coordinates. [Ordering] is an enum with three possible values: `Less`,
/// `Equal`, and `Greater`.
///
/// # Returns:
///
Expand Down
20 changes: 10 additions & 10 deletions src/delaunay_core/vertex.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ use uuid::Uuid;
/// # Properties:
///
/// * `point`: A generic [Point] representing the coordinates of
/// the vertex in a D-dimensional space.
/// the vertex in a D-dimensional space.
/// * `uuid`: A [Uuid] representing a universally unique identifier for the
/// for the [Vertex]. This can be used to uniquely
/// identify the vertex in a graph or any other data structure.
/// for the [Vertex]. This can be used to uniquely
/// identify the vertex in a graph or any other data structure.
/// * `incident_cell`: The `incident_cell` property is an optional [Uuid] that
/// represents a `Cell` containing the [Vertex]. This is
/// calculated by the `delaunay_core::triangulation_data_structure::Tds`.
/// represents a `Cell` containing the [Vertex]. This is
/// calculated by the `delaunay_core::triangulation_data_structure::Tds`.
/// * `data`: The `data` property is an optional field that can hold any
/// type `U`. It is used to store additional data associated with the vertex.
/// type `U`. It is used to store additional data associated with the vertex.
///
/// Data type T is in practice f64 which does not implement Eq, Hash, or Ord.
///
Expand Down Expand Up @@ -54,8 +54,8 @@ where
/// # Arguments:
///
/// * `point`: A generic [Point], representing a point in a
/// multi-dimensional space, where the coordinates are of type `T` and the
/// dimensionality is `D`.
/// multi-dimensional space, where the coordinates are of type `T` and the
/// dimensionality is `D`.
///
/// # Returns:
///
Expand Down Expand Up @@ -88,8 +88,8 @@ where
/// # Arguments:
///
/// * `point`: A generic [Point] representing a point in a
/// multi-dimensional space, where the coordinates are of type `T` and the
/// dimensionality is `D`.
/// multi-dimensional space, where the coordinates are of type `T` and the
/// dimensionality is `D`.
/// * `data`: The `data` parameter is of type `U`.
///
/// # Returns:
Expand Down

0 comments on commit 3ca481d

Please sign in to comment.