Fix typos

Author: cedricchevalier19

src/lib.rs

@@ -152,7 +152,7 @@ unsafe fn slice_to_mut_ptr<T>(slice: &[T]) -> *mut T {
     slice.as_ptr() as *mut T
 }
 
-/// Builder structure to setup a graph partition computation.
+/// Builder structure to set up a graph partition computation.
 ///
 /// This structure holds the required arguments for METIS to compute a
 /// partition.  It also offers methods to easily set any optional argument.
@@ -284,7 +284,7 @@ impl<'a> Graph<'a> {
     /// The following invariants must be held, otherwise this function returns
     /// an error:
     ///
-    /// - all of the arrays have a length that can be held by an [`Idx`],
+    /// - all the arrays have a length that can be held by an [`Idx`],
     /// - `ncon` is strictly greater than zero,
     /// - `nparts` is strictly greater than zero,
     /// - `xadj` has at least one element (its length is the one more than the
@@ -375,7 +375,7 @@ impl<'a> Graph<'a> {
     /// - `ncon` is not strictly greater than zero, or
     /// - `nparts` is not strictly greater than zero, or
     /// - `xadj` is empty, or
-    /// - the length of `adjncy` is different than the last element of `xadj`.
+    /// - the length of `adjncy` is different from the last element of `xadj`.
     ///
     /// # Mutability
     ///
@@ -411,7 +411,7 @@ impl<'a> Graph<'a> {
 
     /// Sets the computational weights of the vertices.
     ///
-    /// By default all vertices have the same weight.
+    /// By default, all vertices have the same weight.
     ///
     /// The `ncon` weights of the `i`th vertex must be located in
     /// `vwgt[i*ncon..(i+1)*ncon]`, and all elements of `vwgt` must be positive.
@@ -429,7 +429,7 @@ impl<'a> Graph<'a> {
 
     /// Sets the communication weights of the vertices.
     ///
-    /// By default all vertices have the same communication weight.
+    /// By default, all vertices have the same communication weight.
     ///
     /// Vertices can only have one communication weight. The length of `vsize`
     /// does not depend on `ncon`.
@@ -447,7 +447,7 @@ impl<'a> Graph<'a> {
 
     /// Sets the weights of the edges.
     ///
-    /// By default all edges have the same weight.
+    /// By default, all edges have the same weight.
     ///
     /// All elements of `adjwgt` must be positive.
     ///
@@ -464,7 +464,7 @@ impl<'a> Graph<'a> {
 
     /// Sets the target partition weights for each part and constraint.
     ///
-    /// By default the graph is divided equally.
+    /// By default, the graph is divided equally.
     ///
     /// The target partition weight for the `i`th part and `j`th constraint is
     /// specified at `tpwgts[i*ncon+j]`. For each constraint `j`, the sum of the
@@ -484,7 +484,7 @@ impl<'a> Graph<'a> {
 
     /// Sets the load imbalance tolerance for each constraint.
     ///
-    /// By default it equals to 1.001 if `ncon` equals 1 and 1.01 otherwise.
+    /// By default, it equals to 1.001 if `ncon` equals 1 and 1.01 otherwise.
     ///
     /// For the `i`th partition and `j`th constraint the allowed weight is the
     /// `ubvec[j]*tpwgts[i*ncon+j]` fraction of the `j`th's constraint total
@@ -779,7 +779,7 @@ fn check_mesh_structure(eptr: &[Idx], eind: &[Idx]) -> StdResult<(Idx, Idx), New
     Ok((ne, max_node + 1))
 }
 
-/// Builder structure to setup a mesh partition computation.
+/// Builder structure to set up a mesh partition computation.
 ///
 /// This structure holds the required arguments for METIS to compute a
 /// partition.  It also offers methods to easily set any optional argument.
@@ -886,7 +886,7 @@ impl<'a> Mesh<'a> {
     /// - `nn` is not strictly greater than zero, or
     /// - `nparts` is not strictly greater than zero, or
     /// - `eptr` is empty, or
-    /// - the length of `eind` is different than the last element of `eptr`.
+    /// - the length of `eind` is different from the last element of `eptr`.
     ///
     /// # Mutability
     ///
@@ -921,7 +921,7 @@ impl<'a> Mesh<'a> {
 
     /// Sets the computational weights of the elements.
     ///
-    /// By default all elements have the same weight.
+    /// By default, all elements have the same weight.
     ///
     /// All elements of `vwgt` must be positive.
     ///
@@ -938,7 +938,7 @@ impl<'a> Mesh<'a> {
 
     /// Sets the communication weights of the elements.
     ///
-    /// By default all elements have the same communication weight.
+    /// By default, all elements have the same communication weight.
     ///
     /// # Panics
     ///
@@ -953,7 +953,7 @@ impl<'a> Mesh<'a> {
 
     /// Sets the target partition weights for each part.
     ///
-    /// By default the mesh is divided equally.
+    /// By default, the mesh is divided equally.
     ///
     /// The sum of the target partition weights must be 1.0.
     ///

src/option.rs

@@ -30,7 +30,7 @@ pub trait Opt: private::Sealed {
 
 /// Specifies the partitioning method.
 pub enum PType {
-    /// Multilevel recursive bisectioning.
+    /// Multilevel recursive bisection.
     Rb,
 
     /// Multilevel k-way partitioning.
@@ -149,8 +149,8 @@ impl Opt for RType {
     }
 }
 
-/// Specifies the number of different partitionings that it will compute. The
-/// final partitioning is the one that achieves the best edgecut or
+/// Specifies the number of different partitions that it will compute. The
+/// final partition is the one that achieves the best edge cut or
 /// communication volume. Default is 1.
 pub struct NCuts(pub Idx);
 
@@ -244,7 +244,7 @@ impl Opt for MinConn {
     }
 }
 
-/// Specifies that the coarsening will not perform any 2-hop matchings when the
+/// Specifies that the coarsening will not perform any 2-hop matching when the
 /// standards matching approach fails to sufficiently coarsen the graph.
 ///
 /// The 2-hop matching is very effective for graphs with power-law degree
@@ -275,7 +275,7 @@ impl Opt for Contig {
     }
 }
 
-/// Specifies that the graph should be compressed by combining together vertices
+/// Specifies that the graph should be compressed by combining vertices
 /// that have identical adjacency lists.
 pub struct Compress(pub bool);
 
@@ -307,14 +307,14 @@ impl Opt for CCOrder {
 /// than `0.1*x*(average degree)` are removed from the graph, an ordering of the
 /// rest of the vertices is computed, and an overall ordering is computed by
 /// ordering the removed vertices at the end of the overall ordering.  For
-/// example if `x == 40`, and the average degree is 5, then the algorithmwill
+/// example if `x == 40`, and the average degree is 5, then the algorithm will
 /// remove all vertices with degree greater than 20. The vertices that are
 /// removed are ordered last (i.e., they are automatically placed in the
 /// top-level separator). Good values are often in the range of 60 to 200 (i.e.,
 /// 6 to 20 times more than the average). Default value is 0, indicating that no
 /// vertices are removed.
 ///
-/// Used to control whether or not the ordering algorithm should remove any
+/// Used to control whether the ordering algorithm should remove any
 /// vertices with high degree (i.e., dense columns). This is particularly
 /// helpful for certain classes of LP matrices, in which there a few vertices
 /// that are connected to many other vertices. By removing these vertices prior
@@ -335,7 +335,7 @@ impl Opt for PFactor {
 ///
 /// A value of `x` indicates that the allowed load imbalance is `(1 + x)/1000`.
 /// The load imbalance for the `j`th constraint is defined to be
-/// `max_i(w[j,i])/t[j,i])`, where `w[j,i]` is the fraction of the overall
+/// `max_i(w[j,i]/t[j,i])`, where `w[j,i]` is the fraction of the overall
 /// weight of the `j`th constraint that is assigned to the`i`th partition and
 /// `t[j,i]` is the desired target weight of the `j`th constraint for the `i`th
 /// partition (i.e., that specified via `-tpwgts`). For `-ptype=rb`, the default