diff --git a/src/lib.rs b/src/lib.rs index cc311dc3..7bfc1e53 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -42,6 +42,7 @@ fn main() { and keeps an optimized set of tools for computational graphics and physics. Those features include: * Vectors with static sizes: `Vec0`, `Vec1`, `Vec2`, `Vec3`, `Vec4`, `Vec5`, `Vec6`. +* Points with static sizes: `Pnt0`, `Pnt1`, `Pnt2`, `Pnt3`, `Pnt4`, `Pnt5`, `Pnt6`. * Square matrices with static sizes: `Mat1`, `Mat2`, `Mat3`, `Mat4`, `Mat5`, `Mat6 `. * Rotation matrices: `Rot2`, `Rot3`, `Rot4`. * Isometries: `Iso2`, `Iso3`, `Iso4`. @@ -87,7 +88,7 @@ Feel free to add your project to this list if you happen to use **nalgebra**! * [nphysics](https://github.com/sebcrozet/nphysics): a real-time physics engine. * [ncollide](https://github.com/sebcrozet/ncollide): a collision detection library. * [kiss3d](https://github.com/sebcrozet/kiss3d): a minimalistic graphics engine. -* [frog](https://github.com/natal/frog): a machine learning library. +* [nrays](https://github.com/sebcrozet/nrays): a ray tracer. */ #![deny(non_camel_case_types)] diff --git a/src/structs/pnt_macros.rs b/src/structs/pnt_macros.rs index 5e1b0e93..bc7a0b4c 100644 --- a/src/structs/pnt_macros.rs +++ b/src/structs/pnt_macros.rs @@ -55,6 +55,7 @@ macro_rules! pnt_sub_vec_impl( macro_rules! pnt_as_vec_impl( ($t: ident, $tv: ident, $comp0: ident $(,$compN: ident)*) => ( impl $t { + /// Converts this point to its associated vector. #[inline] pub fn to_vec(self) -> $tv { $tv::new( @@ -63,6 +64,7 @@ macro_rules! pnt_as_vec_impl( ) } + /// Converts a reference to this point to a reference to its associated vector. #[inline] pub fn as_vec<'a>(&'a self) -> &'a $tv { unsafe { diff --git a/src/traits/operations.rs b/src/traits/operations.rs index 35b79f30..63901be9 100644 --- a/src/traits/operations.rs +++ b/src/traits/operations.rs @@ -361,7 +361,7 @@ impl> ScalarDiv for T { } } -/// Trait of objects implementing the $$y = ax + y$$ operation. +/// Trait of objects implementing the `y = ax + y` operation. pub trait Axpy { /// Adds $$a * x$$ to `self`. fn axpy(&mut self, a: &N, x: &Self);