nalgebra/src/structs/vectorn_macros.rs

#![macro_use]

macro_rules! vecn_dvec_common_impl(
    ($vecn: ident $(, $param: ident)*) => (
        /*
         *
         * Zero.
         *
         */
        impl<N: Zero + Copy + Clone $(, $param: ArrayLength<N>)*> $vecn<N $(, $param)*> {
            /// Tests if all components of the vector are zeroes.
            #[inline]
            pub fn is_zero(&self) -> bool {
                self.as_ref().iter().all(|e| e.is_zero())
            }
        }

        /*
         *
         * AsRef/AsMut
         *
         */
        impl<N $(, $param: ArrayLength<N>)*> AsRef<[N]> for $vecn<N $(, $param)*> {
            #[inline]
            fn as_ref(&self) -> &[N] {
                &self.at[.. self.len()]
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> AsMut<[N]> for $vecn<N $(, $param)*> {
            #[inline]
            fn as_mut(&mut self) -> &mut [N] {
                let len = self.len();
                &mut self.at[.. len]
            }
        }

        /*
         *
         * Shape.
         *
         */
        impl<N $(, $param: ArrayLength<N>)*> Shape<usize> for $vecn<N $(, $param)*> {
            #[inline]
            fn shape(&self) -> usize {
                self.len()
            }
        }

        /*
         *
         * Index et. al.
         *
         */
        impl<N: Copy $(, $param : ArrayLength<N>)*> Indexable<usize, N> for $vecn<N $(, $param)*> {
            #[inline]
            fn swap(&mut self, i: usize, j: usize) {
                assert!(i < self.len());
                assert!(j < self.len());
                self.as_mut().swap(i, j);
            }

            #[inline]
            unsafe fn unsafe_at(&self, i: usize) -> N {
                *self[..].get_unchecked(i)
            }

            #[inline]
            unsafe fn unsafe_set(&mut self, i: usize, val: N) {
                *self[..].get_unchecked_mut(i) = val
            }

        }

        impl<N, T $(, $param: ArrayLength<N>)*> Index<T> for $vecn<N $(, $param)*> where [N]: Index<T> {
            type Output = <[N] as Index<T>>::Output;

            fn index(&self, i: T) -> &<[N] as Index<T>>::Output {
                &self.as_ref()[i]
            }
        }

        impl<N, T $(, $param: ArrayLength<N>)*> IndexMut<T> for $vecn<N $(, $param)*> where [N]: IndexMut<T> {
            fn index_mut(&mut self, i: T) -> &mut <[N] as Index<T>>::Output {
                &mut self.as_mut()[i]
            }
        }

        /*
         *
         * Iterable et al.
         *
         */
        impl<N $(, $param : ArrayLength<N>)*> Iterable<N> for $vecn<N $(, $param)*> {
            #[inline]
            fn iter(&self) -> Iter<N> {
                self.as_ref().iter()
            }
        }

        impl<N $(, $param : ArrayLength<N>)*> IterableMut<N> for $vecn<N $(, $param)*> {
            #[inline]
            fn iter_mut(&mut self) -> IterMut<N> {
                self.as_mut().iter_mut()
            }
        }

        /*
         *
         * Axpy
         *
         */
        impl<N: Copy + Add<N, Output = N> + Mul<N, Output = N> $(, $param : ArrayLength<N>)*>
            Axpy<N> for $vecn<N $(, $param)*> {
            fn axpy(&mut self, a: &N, x: &$vecn<N $(, $param)*>) {
                assert!(self.len() == x.len());

                for i in 0 .. x.len() {
                    unsafe {
                        let self_i = self.unsafe_at(i);
                        self.unsafe_set(i, self_i + *a * x.unsafe_at(i))
                    }
                }
            }
        }

        /*
         *
         * Mul
         *
         */
        impl<N: Copy + Mul<N, Output = N> + Zero $(, $param : ArrayLength<N>)*>
            Mul<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn mul(self, right: $vecn<N $(, $param)*>) -> $vecn<N $(, $param)*> {
                assert!(self.len() == right.len());

                let mut res = self;

                for (left, right) in res.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left = *left * *right
                }

                res
            }
        }

        impl<N: Copy + Mul<N, Output = N> + Zero $(, $param : ArrayLength<N>)*>
            Mul<N> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn mul(self, right: N) -> $vecn<N $(, $param)*> {
                let mut res = self;

                for e in res.as_mut().iter_mut() {
                    *e = *e * right
                }

                res
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> MulAssign<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*>
            where N: Copy + MulAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn mul_assign(&mut self, right: $vecn<N $(, $param)*>) {
                assert!(self.len() == right.len());

                for (left, right) in self.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left *= *right
                }
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> MulAssign<N> for $vecn<N $(, $param)*>
            where N: Copy + MulAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn mul_assign(&mut self, right: N) {
                for e in self.as_mut().iter_mut() {
                    *e *= right
                }
            }
        }

        impl<$($param : ArrayLength<f32>),*> Mul<$vecn<f32 $(, $param)*>> for f32 {
            type Output = $vecn<f32 $(, $param)*>;

            #[inline]
            fn mul(self, right: $vecn<f32 $(, $param)*>) -> $vecn<f32 $(, $param)*> {
                let mut res = right;

                for e in res.as_mut().iter_mut() {
                    *e = self * *e;
                }

                res
            }
        }

        impl<$($param : ArrayLength<f64>),*> Mul<$vecn<f64 $(, $param)*>> for f64 {
            type Output = $vecn<f64 $(, $param)*>;

            #[inline]
            fn mul(self, right: $vecn<f64 $(, $param)*>) -> $vecn<f64 $(, $param)*> {
                let mut res = right;

                for e in res.as_mut().iter_mut() {
                    *e = self * *e;
                }

                res
            }
        }

        /*
         *
         * Div.
         *
         */
        impl<N: Copy + Div<N, Output = N> + Zero $(, $param : ArrayLength<N>)*>
            Div<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn div(self, right: $vecn<N $(, $param)*>) -> $vecn<N $(, $param)*> {
                assert!(self.len() == right.len());

                let mut res = self;

                for (left, right) in res.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left = *left / *right
                }

                res
            }
        }

        impl<N: Copy + Div<N, Output = N> + Zero $(, $param : ArrayLength<N>)*> Div<N> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn div(self, right: N) -> $vecn<N $(, $param)*> {
                let mut res = self;

                for e in res.as_mut().iter_mut() {
                    *e = *e / right
                }

                res
            }
        }

        impl<'a, N: Copy + Div<N, Output = N> + Zero $(, $param : ArrayLength<N>)*> Div<$vecn<N $(, $param)*>> for &'a $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn div(self, right: $vecn<N $(, $param)*>) -> $vecn<N $(, $param)*> {
                self.clone() / right
            }
        }

        impl<'a, N: Copy + Div<N, Output = N> + Zero $(, $param : ArrayLength<N>)*> Div<N> for &'a $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn div(self, right: N) -> $vecn<N $(, $param)*> {
                self.clone() / right
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> DivAssign<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*>
            where N: Copy + DivAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn div_assign(&mut self, right: $vecn<N $(, $param)*>) {
                assert!(self.len() == right.len());

                for (left, right) in self.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left /= *right
                }
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> DivAssign<N> for $vecn<N $(, $param)*>
            where N: Copy + DivAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn div_assign(&mut self, right: N) {
                for e in self.as_mut().iter_mut() {
                    *e /= right
                }
            }
        }

        /*
         *
         * Add.
         *
         */
        impl<N: Copy + Add<N, Output = N> + Zero $(, $param : ArrayLength<N>)*>
            Add<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn add(self, right: $vecn<N $(, $param)*>) -> $vecn<N $(, $param)*> {
                assert!(self.len() == right.len());

                let mut res = self;

                for (left, right) in res.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left = *left + *right
                }

                res
            }
        }

        impl<N: Copy + Add<N, Output = N> + Zero $(, $param : ArrayLength<N>)*> Add<N> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn add(self, right: N) -> $vecn<N $(, $param)*> {
                let mut res = self;

                for e in res.as_mut().iter_mut() {
                    *e = *e + right
                }

                res
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> AddAssign<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*>
            where N: Copy + AddAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn add_assign(&mut self, right: $vecn<N $(, $param)*>) {
                assert!(self.len() == right.len());

                for (left, right) in self.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left += *right
                }
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> AddAssign<N> for $vecn<N $(, $param)*>
            where N: Copy + AddAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn add_assign(&mut self, right: N) {
                for e in self.as_mut().iter_mut() {
                    *e += right
                }
            }
        }

        impl<$($param : ArrayLength<f32>),*> Add<$vecn<f32 $(, $param)*>> for f32 {
            type Output = $vecn<f32 $(, $param)*>;

            #[inline]
            fn add(self, right: $vecn<f32 $(, $param)*>) -> $vecn<f32 $(, $param)*> {
                let mut res = right;

                for e in res.as_mut().iter_mut() {
                    *e = self + *e;
                }

                res
            }
        }

        impl<$($param : ArrayLength<f64>),*> Add<$vecn<f64 $(, $param)*>> for f64 {
            type Output = $vecn<f64 $(, $param)*>;

            #[inline]
            fn add(self, right: $vecn<f64 $(, $param)*>) -> $vecn<f64 $(, $param)*> {
                let mut res = right;

                for e in res.as_mut().iter_mut() {
                    *e = self + *e;
                }

                res
            }
        }

        /*
         *
         * Sub.
         *
         */
        impl<N: Copy + Sub<N, Output = N> + Zero $(, $param : ArrayLength<N>)*>
            Sub<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn sub(self, right: $vecn<N $(, $param)*>) -> $vecn<N $(, $param)*> {
                assert!(self.len() == right.len());

                let mut res = self;

                for (left, right) in res.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left = *left - *right
                }

                res
            }
        }

        impl<N: Copy + Sub<N, Output = N> + Zero $(, $param : ArrayLength<N>)*> Sub<N> for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn sub(self, right: N) -> $vecn<N $(, $param)*> {
                let mut res = self;

                for e in res.as_mut().iter_mut() {
                    *e = *e - right
                }

                res
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> SubAssign<$vecn<N $(, $param)*>> for $vecn<N $(, $param)*>
            where N: Copy + SubAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn sub_assign(&mut self, right: $vecn<N $(, $param)*>) {
                assert!(self.len() == right.len());

                for (left, right) in self.as_mut().iter_mut().zip(right.as_ref().iter()) {
                    *left -= *right
                }
            }
        }

        impl<N $(, $param: ArrayLength<N>)*> SubAssign<N> for $vecn<N $(, $param)*>
            where N: Copy + SubAssign<N> + Zero $(, $param : ArrayLength<N>)* {
            #[inline]
            fn sub_assign(&mut self, right: N) {
                for e in self.as_mut().iter_mut() {
                    *e -= right
                }
            }
        }

        impl<$($param : ArrayLength<f32>),*> Sub<$vecn<f32 $(, $param)*>> for f32 {
            type Output = $vecn<f32 $(, $param)*>;

            #[inline]
            fn sub(self, right: $vecn<f32 $(, $param)*>) -> $vecn<f32 $(, $param)*> {
                let mut res = right;

                for e in res.as_mut().iter_mut() {
                    *e = self - *e;
                }

                res
            }
        }

        impl<$($param : ArrayLength<f64>),*> Sub<$vecn<f64 $(, $param)*>> for f64 {
            type Output = $vecn<f64 $(, $param)*>;

            #[inline]
            fn sub(self, right: $vecn<f64 $(, $param)*>) -> $vecn<f64 $(, $param)*> {
                let mut res = right;

                for e in res.as_mut().iter_mut() {
                    *e = self - *e;
                }

                res
            }
        }

        /*
         *
         * Neg.
         *
         */
        impl<N: Neg<Output = N> + Zero + Copy $(, $param : ArrayLength<N>)*> Neg for $vecn<N $(, $param)*> {
            type Output = $vecn<N $(, $param)*>;

            #[inline]
            fn neg(mut self) -> $vecn<N $(, $param)*> {
                for e in self.as_mut().iter_mut() {
                    *e = -*e;
                }

                self
            }
        }

        /*
         *
         * Dot.
         *
         */
        impl<N: BaseNum $(, $param : ArrayLength<N>)*> Dot<N> for $vecn<N $(, $param)*> {
            #[inline]
            fn dot(&self, other: &$vecn<N $(, $param)*>) -> N {
                assert!(self.len() == other.len());
                let mut res: N = ::zero();
                for i in 0 .. self.len() {
                    res = res + unsafe { self.unsafe_at(i) * other.unsafe_at(i) };
                }
                res
            }
        }

        /*
         *
         * Norm.
         *
         */
        impl<N: BaseFloat $(, $param : ArrayLength<N>)*> Norm for $vecn<N $(, $param)*> {
            type NormType = N;

            #[inline]
            fn norm_squared(&self) -> N {
                ::dot(self, self)
            }

            #[inline]
            fn normalize(&self) -> $vecn<N $(, $param)*> {
                let mut res : $vecn<N $(, $param)*> = self.clone();
                let _ = res.normalize_mut();
                res
            }

            #[inline]
            fn normalize_mut(&mut self) -> N {
                let n = ::norm(self);
                *self /= n;

                n
            }

            #[inline]
            fn try_normalize(&self, min_norm: N) -> Option<$vecn<N $(, $param)*>> {
                let n = ::norm(self);

                if n <= min_norm {
                    None
                }
                else {
                    Some(self / n)
                }
            }

            #[inline]
            fn try_normalize_mut(&mut self, min_norm: N) -> Option<N> {
                let n = ::norm(self);

                if n <= min_norm {
                    None
                }
                else {
                    *self /= n;
                    Some(n)
                }
            }
        }

        /*
         *
         * Mean.
         *
         */
        impl<N: BaseFloat + Cast<f64> $(, $param : ArrayLength<N>)*> Mean<N> for $vecn<N $(, $param)*> {
            #[inline]
            fn mean(&self) -> N {
                let normalizer = ::cast(1.0f64 / self.len() as f64);
                self.iter().fold(::zero(), |acc, x| acc + *x * normalizer)
            }
        }

        /*
         *
         * ApproxEq
         *
         */
        impl<N: ApproxEq<N> $(, $param : ArrayLength<N>)*> ApproxEq<N> for $vecn<N $(, $param)*> {
            #[inline]
            fn approx_epsilon() -> N {
                <N as ApproxEq<N>>::approx_epsilon()
            }

            #[inline]
            fn approx_ulps() -> u32 {
                <N as ApproxEq<N>>::approx_ulps()
            }

            #[inline]
            fn approx_eq_eps(&self, other: &$vecn<N $(, $param)*>, epsilon: &N) -> bool {
                let mut zip = self.as_ref().iter().zip(other.as_ref().iter());
                zip.all(|(a, b)| ApproxEq::approx_eq_eps(a, b, epsilon))
            }

            #[inline]
            fn approx_eq_ulps(&self, other: &$vecn<N $(, $param)*>, ulps: u32) -> bool {
                let mut zip = self.as_ref().iter().zip(other.as_ref().iter());
                zip.all(|(a, b)| ApproxEq::approx_eq_ulps(a, b, ulps))
            }
        }
    )
);