M-Labs/nalgebra
3
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add getter for reflection bias. Fix typos.

Browse Source
This commit is contained in:
Rouven Spreckels 2021-07-27 15:17:30 +02:00
parent a01365456c
commit 06e20b4b95
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/geometry/reflection.rs
View File

@ -22,7 +22,7 @@ impl<T: ComplexField, S: Storage<T, Const<D>>, const D: usize> Reflection<T, Con
} }
impl<T: ComplexField, D: Dim, S: Storage<T, D>> Reflection<T, D, S> { impl<T: ComplexField, D: Dim, S: Storage<T, D>> Reflection<T, D, S> {
/// Creates a new reflection wrt the plane orthogonal to the given axis and bias. /// Creates a new reflection wrt. the plane orthogonal to the given axis and bias.
/// ///
/// The bias is the position of the plane on the axis. In particular, a bias equal to zero /// The bias is the position of the plane on the axis. In particular, a bias equal to zero
/// represents a plane that passes through the origin. /// represents a plane that passes through the origin.
@ -33,12 +33,21 @@ impl<T: ComplexField, D: Dim, S: Storage<T, D>> Reflection<T, D, S> {
} }
} }
/// The reflexion axis. /// The reflection axis.
#[must_use] #[must_use]
pub fn axis(&self) -> &Vector<T, D, S> { pub fn axis(&self) -> &Vector<T, D, S> {
&self.axis &self.axis
} }
/// The reflection bias.
///
/// The bias is the position of the plane on the axis. In particular, a bias equal to zero
/// represents a plane that passes through the origin.
#[must_use]
pub fn bias(&self) -> T {
self.bias
}
// TODO: naming convention: reflect_to, reflect_assign ? // TODO: naming convention: reflect_to, reflect_assign ?
/// Applies the reflection to the columns of `rhs`. /// Applies the reflection to the columns of `rhs`.
pub fn reflect<R2: Dim, C2: Dim, S2>(&self, rhs: &mut Matrix<T, R2, C2, S2>) pub fn reflect<R2: Dim, C2: Dim, S2>(&self, rhs: &mut Matrix<T, R2, C2, S2>)