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

//
// GLSL Mathematics for Rust.
//
// Copyright (c) 2015 The glm-rs authors.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

use basenum::{ BaseNum, BaseFloat, Primitive };
use traits::{ GenBType, GenFloat, GenNum };
use std::ops::{ Index, IndexMut };

/// Generic vector type.
pub trait GenVec<T: Primitive>
: Copy
+ Index<usize, Output = T>
+ IndexMut<usize, Output = T>
{
    /// Returns the dimension of the vector.
    ///
    /// # Example
    ///
    /// ```
    /// use glm::GenVec;    // bring the method into scope.
    /// assert_eq!(glm::IVec4::dim(), 4);
    /// ```
    fn dim() -> usize;

    // XXX: swap(i, j)
}

/// Trait of all vector types that are GenNum.
pub trait GenNumVec<T: BaseNum>: GenNum<T> + GenVec<T> {

    /// Returns the sum of all components.
    //
    /// # Example
    ///
    /// ```
    /// use glm::GenNumVec;     // bring the method into scope.
    /// let v = glm::vec3(1., 2., 3.);
    /// assert_eq!(v.sum(), 6.0);
    /// ```
    fn sum(&self) -> T;

    /// Multiplies all components.
    ///
    /// # Example
    ///
    /// ```
    /// use glm::GenNumVec;     // bring the method into scope.
    /// let v = glm::vec3(2., 3., 4.);
    /// assert_eq!(v.product(), 24.);
    /// ```
    fn product(&self) -> T;

    /// Returns the minimal value of all components.
    ///
    /// # Example
    ///
    /// ```
    /// use glm::GenNumVec;     // bring the method into scope.
    /// let v = glm::vec3(1.0, 2.0, 3.0);
    /// assert_eq!(v.min(), 1.0);
    /// ```
    fn min(&self) -> T;

    /// Returns the maximal value of all components.
    ///
    /// # Example
    ///
    /// ```
    /// use glm::GenNumVec;     // bring the method into scope.
    ///
    /// let v = glm::vec3(1.0, 2.0, 3.0);
    /// assert_eq!(v.max(), 3.0);
    /// ```
    fn max(&self) -> T;
}

/// Generic type of vectors of float number.
pub trait GenFloatVec<T: BaseFloat>: GenNumVec<T> + GenFloat<T> {}

/// Generic boolean vector type.
pub trait GenBVec: GenVec<bool> + GenBType {

    /// Returns `true` if there is any component of the receiver is `true`.
    ///
    /// # Example
    ///
    /// ```
    /// use glm::{ GenBVec, bvec2 };
    ///
    /// assert!(bvec2(true, false).any());
    /// assert_eq!(bvec2(false, false).all(), false);
    /// ```
    fn any(&self) -> bool;

    /// Returns `true` if all components of the receiver are `true`.
    ///
    /// # Example
    ///
    /// ```
    /// use glm::{ GenBVec, bvec2 };
    ///
    /// assert_eq!(bvec2(true, false).all(), false);
    /// assert_eq!(bvec2(true, true).all(), true);
    /// ```
    fn all(&self) -> bool;

    /// Returns the component-wise logical complement of the receiver.
    ///
    /// # Example
    ///
    /// ```
    /// use glm::{ GenBVec, bvec2 };
    ///
    /// assert_eq!(bvec2(true, false).not(), bvec2(false, true));
    /// ```
    fn not(&self) -> Self;
}