vectors 0.3.0

Sparse & dense vectors for use in high dimensional vector spaces.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

//! Vector representations for use in high dimensional vector spaces.

#![cfg_attr(not(feature = "std"), no_std)]

#![cfg_attr(feature = "missing_mpl", feature(plugin))]
#![cfg_attr(feature = "missing_mpl", plugin(missing_mpl))]
#![cfg_attr(feature = "missing_mpl", deny(missing_mpl))]

#![warn(missing_docs)]

#[cfg(not(feature = "std"))]
extern crate core as std;

#[cfg(not(feature = "std"))]
#[macro_use]
extern crate std;

#[cfg(test)]
#[macro_use(expect)]
extern crate expectest;

extern crate num_traits;
extern crate ordered_iter;
extern crate arrayvec;

pub mod dense;
pub mod sparse;

use std::ops::{Add, AddAssign, Sub, SubAssign, Mul, MulAssign, Div, DivAssign};

use num_traits::{MulAdd, MulAddAssign, real::Real};

/// The crate's prelude
pub mod prelude {
    pub use super::{
        VectorOps, VectorAssignOps,
        Vector, VectorRef,
        VectorAssign, VectorAssignRef,
        Dot, Distance
    };
}

/// The trait for vector types implementing basic numeric operations.
pub trait VectorOps<Vector, Scalar>: Sized
    + Add<Vector, Output = Self>
    + Sub<Vector, Output = Self>
    + Mul<Scalar, Output = Self>
    + Div<Scalar, Output = Self>
    + MulAdd<Scalar, Vector, Output = Self>
{}

/// The trait for vector types implementing numeric assignment operators (like `+ = `).
pub trait VectorAssignOps<Vector, Scalar>: Sized
    + AddAssign<Vector>
    + SubAssign<Vector>
    + MulAssign<Scalar>
    + DivAssign<Scalar>
    + MulAddAssign<Scalar, Vector>
{}

/// The base trait for vector types, covering comparisons,
/// basic numeric operations, and the dot product.
pub trait Vector<Scalar>: PartialEq + VectorOps<Self, Scalar> {
    /// The type of the `Vector`'s scalar components.
    type Scalar;

    // /// Calculates the dot-product between `self` and `rhs`.
    // fn dot(self, rhs: &Self) -> Self::Scalar;
    //
    // /// Calculates the squared euclidian distance between `self` and `rhs`.
    // fn squared_distance(&self, rhs: &Self) -> Self::Scalar;
    //
    // /// Calculates the euclidian distance between `self` and `rhs`.
    // fn distance(&self, rhs: &Self) -> Self::Scalar
    // where
    //     Self::Scalar: Real,
    // {
    //     self.squared_distance(rhs).sqrt()
    // }
}

/// The trait for `Vector` types which also implement numeric operations
// taking the second operand by reference.
pub trait VectorRef<Scalar>: Vector<Scalar> + for<'a> VectorOps<&'a Self, Scalar> { }

impl<T, S> VectorRef<S> for T
where
    T: Vector<S> + for<'a> VectorOps<&'a T, S>
{}

/// The trait for `Vector` types which also implement assignment operators.
pub trait VectorAssign<Scalar>: Vector<Scalar> + VectorAssignOps<Self, Scalar> {}

impl<T, S> VectorAssign<S> for T
where
    T: Vector<S> + VectorAssignOps<Self, S>
{}

/// The trait for `VectorAssign` types which also implement
/// assignment operations taking the second operand by reference.
pub trait VectorAssignRef<Scalar>: VectorAssign<Scalar> + for<'a> VectorAssignOps<&'a Self, Scalar> { }

impl<T, S> VectorAssignRef<S> for T
where
    T: VectorAssign<S> + for<'a> VectorAssignOps<&'a T, S>
{}

/// The trait for types supporting the calculation of the dot product
pub trait Dot: Sized {
    /// The scalar type returned by `self`'s dot product
    type Scalar;

    /// Calculates the dot-product between `self` and `rhs`.
    fn dot(&self, rhs: &Self) -> Self::Scalar;
}

/// The trait for types supporting the calculation of distance
pub trait Distance: Sized {
    /// The scalar type returned by `self`'s distance
    type Scalar;

    /// Calculates the squared euclidian distance between `self` and `rhs`.
    fn squared_distance(&self, rhs: &Self) -> Self::Scalar;

    /// Calculates the euclidian distance between `self` and `rhs`.
    fn distance(&self, rhs: &Self) -> Self::Scalar
    where
        Self::Scalar: Real,
    {
        self.squared_distance(rhs).sqrt()
    }
}