docs: grammar: "Constrains ... to be"
(Also pick up a small typo in a non-doc comment in the same area of code.)
This commit is contained in:
parent
706caf52c3
commit
8f59f4dcf6
|
@ -6,7 +6,7 @@ use crate::base::dimension::{Dim, DimName, Dyn};
|
||||||
#[derive(Copy, Clone, Debug)]
|
#[derive(Copy, Clone, Debug)]
|
||||||
pub struct ShapeConstraint;
|
pub struct ShapeConstraint;
|
||||||
|
|
||||||
/// Constraints `C1` and `R2` to be equivalent.
|
/// Constrains `C1` and `R2` to be equivalent.
|
||||||
pub trait AreMultipliable<R1: Dim, C1: Dim, R2: Dim, C2: Dim>: DimEq<C1, R2> {}
|
pub trait AreMultipliable<R1: Dim, C1: Dim, R2: Dim, C2: Dim>: DimEq<C1, R2> {}
|
||||||
|
|
||||||
impl<R1: Dim, C1: Dim, R2: Dim, C2: Dim> AreMultipliable<R1, C1, R2, C2> for ShapeConstraint where
|
impl<R1: Dim, C1: Dim, R2: Dim, C2: Dim> AreMultipliable<R1, C1, R2, C2> for ShapeConstraint where
|
||||||
|
@ -14,7 +14,7 @@ impl<R1: Dim, C1: Dim, R2: Dim, C2: Dim> AreMultipliable<R1, C1, R2, C2> for Sha
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Constraints `D1` and `D2` to be equivalent.
|
/// Constrains `D1` and `D2` to be equivalent.
|
||||||
pub trait DimEq<D1: Dim, D2: Dim> {
|
pub trait DimEq<D1: Dim, D2: Dim> {
|
||||||
/// This is either equal to `D1` or `D2`, always choosing the one (if any) which is a type-level
|
/// This is either equal to `D1` or `D2`, always choosing the one (if any) which is a type-level
|
||||||
/// constant.
|
/// constant.
|
||||||
|
@ -35,7 +35,7 @@ impl<D: DimName> DimEq<Dyn, D> for ShapeConstraint {
|
||||||
|
|
||||||
macro_rules! equality_trait_decl(
|
macro_rules! equality_trait_decl(
|
||||||
($($doc: expr, $Trait: ident),* $(,)*) => {$(
|
($($doc: expr, $Trait: ident),* $(,)*) => {$(
|
||||||
// XXX: we can't do something like `DimEq<D1> for D2` because we would require a blancket impl…
|
// XXX: we can't do something like `DimEq<D1> for D2` because we would require a blanket impl…
|
||||||
#[doc = $doc]
|
#[doc = $doc]
|
||||||
pub trait $Trait<D1: Dim, D2: Dim>: DimEq<D1, D2> + DimEq<D2, D1> {
|
pub trait $Trait<D1: Dim, D2: Dim>: DimEq<D1, D2> + DimEq<D2, D1> {
|
||||||
/// This is either equal to `D1` or `D2`, always choosing the one (if any) which is a type-level
|
/// This is either equal to `D1` or `D2`, always choosing the one (if any) which is a type-level
|
||||||
|
@ -58,17 +58,17 @@ macro_rules! equality_trait_decl(
|
||||||
);
|
);
|
||||||
|
|
||||||
equality_trait_decl!(
|
equality_trait_decl!(
|
||||||
"Constraints `D1` and `D2` to be equivalent. \
|
"Constrains `D1` and `D2` to be equivalent. \
|
||||||
They are both assumed to be the number of \
|
They are both assumed to be the number of \
|
||||||
rows of a matrix.",
|
rows of a matrix.",
|
||||||
SameNumberOfRows,
|
SameNumberOfRows,
|
||||||
"Constraints `D1` and `D2` to be equivalent. \
|
"Constrains `D1` and `D2` to be equivalent. \
|
||||||
They are both assumed to be the number of \
|
They are both assumed to be the number of \
|
||||||
columns of a matrix.",
|
columns of a matrix.",
|
||||||
SameNumberOfColumns
|
SameNumberOfColumns
|
||||||
);
|
);
|
||||||
|
|
||||||
/// Constraints D1 and D2 to be equivalent, where they both designate dimensions of algebraic
|
/// Constrains D1 and D2 to be equivalent, where they both designate dimensions of algebraic
|
||||||
/// entities (e.g. square matrices).
|
/// entities (e.g. square matrices).
|
||||||
pub trait SameDimension<D1: Dim, D2: Dim>:
|
pub trait SameDimension<D1: Dim, D2: Dim>:
|
||||||
SameNumberOfRows<D1, D2> + SameNumberOfColumns<D1, D2>
|
SameNumberOfRows<D1, D2> + SameNumberOfColumns<D1, D2>
|
||||||
|
|
Loading…
Reference in New Issue