Skip to content

Commit

Permalink
fixed typo in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanAellen committed Jun 24, 2024
1 parent db9eced commit c927e7f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -367,13 +367,14 @@ class DiscreteLowRankGaussianProcess[D: NDSpace, DDomain[DD] <: DiscreteDomain[D
*
* @param ids
* these define the parts of the domain that are aligned to. Depending on the withExtendedBasis parameter has a
* minimum length requirements (default basis extension in 3D should be used with >=4 provided ids)
* minimum length requirements (default basis extension in 3D should be used with >=4 provided ids for example)
* @param withExtendedBasis
* True if the extended basis should be included. By default this uses a rotation extension. False makes the
* realignment only over translation. Translational alignment can be done exactly.
* realignment only over translation. Translational alignment can be done exactly. For more information see
* [[RealignExtendedBasis]].
* @param diagonalize
* True if a diagonal basis should be returned. In general, it is strongly recommended to use a orthonormal basis -
* here referred to as diagonal. This is not increase complexity and is a more intuitive formulation of the model.
* here referred to as diagonal. This does not increase complexity and is a more intuitive formulation of the model.
* If internal fields are accessed diagonalize should be set to true. This option can be set to false to make the
* same coefficient lead to very similar shapes in the pre- and after realignment model (or exactly the same shapes
* if withExtendedBasis = false).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ trait RealignExtendedBasis[D, Value]:

/**
* whether or not the default translation basis should also be used. that means false does not perform a translation
* realignment.
* realignment. This in combination with getBasis allows for complete control of the projection matrix.
*/
def useTranslation: Boolean

/**
* basis to span the kernel of the projection. as example, a translation alignment here could span that space with
* constant vectors for each cardinal direction.
* basis to span the kernel of the projection. for example, a translation alignment could be performed by spanning
* that space with constant vectors for each cardinal direction.
*/
def getBasis[DDomain[DD] <: DiscreteDomain[DD]](model: DiscreteLowRankGaussianProcess[D, DDomain, Value],
center: Point[D]
Expand All @@ -41,7 +41,7 @@ trait RealignExtendedBasisRotation[D, Value] extends RealignExtendedBasis[D, Val

object RealignExtendedBasis:
/**
* returns a projection basis for rotation. that is the tangential speed for the rotations around the three cardinal
* returns a projection basis for rotation - the tangential speed for the rotations around the three cardinal
* directions.
*/
given realignBasis3D: RealignExtendedBasisRotation[_3D, EuclideanVector[_3D]] with
Expand Down Expand Up @@ -69,7 +69,7 @@ object RealignExtendedBasis:
}

/**
* returns a projection basis for rotation. that is the tangential speed for the single 2d rotation.
* returns a projection basis for rotation - the tangential speed for the single 2d rotation.
*/
given realignBasis2D: RealignExtendedBasisRotation[_2D, EuclideanVector[_2D]] with
def useTranslation: Boolean = true
Expand Down

0 comments on commit c927e7f

Please sign in to comment.