summaryrefslogtreecommitdiffstats
path: root/src/vZ/Vector.hpp
blob: 0f5cf49c69dd97529fd98f7292def428045e6f4e (plain)
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/*************************************************************************
 * Copyright (C) 2010 Tavian Barnes <tavianator@gmail.com>               *
 *                                                                       *
 * This file is part of The vZ Library.                                  *
 *                                                                       *
 * The vZ Library is free software; you can redistribute it and/or       *
 * modify it under the terms of the GNU Lesser General Public License as *
 * published by the Free Software Foundation; either version 3 of the    *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The vZ Library is distributed in the hope that it will be useful, but *
 * WITHOUT ANY WARRANTY; without even the implied warranty of            *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 * Lesser General Public License for more details.                       *
 *                                                                       *
 * You should have received a copy of the GNU Lesser General Public      *
 * License along with this program.  If not, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

#ifndef VZ_VECTOR_HPP
#define VZ_VECTOR_HPP

#include <algorithm>
#include <cmath>
#include <cstddef>
#include <ostream>

namespace vZ
{
  // An N-dimensional vector
  template <std::size_t N, typename T = double>
  class Vector
  {
  public:
    typedef typename Traits<T>::Scalar Scalar;

    Vector()              { }
    explicit Vector(T x)  { m_values[0] = x; }
    Vector(T x, T y)      { m_values[0] = x; m_values[1] = y; }
    Vector(T x, T y, T z) { m_values[0] = x; m_values[1] = y; m_values[2] = z; }
    // Vector(const Vector& v);
    // ~Vector();

    // Vector& operator=(const Vector& v);

    // Component access

    T&       operator[](std::size_t i)       { return m_values[i]; }
    const T& operator[](std::size_t i) const { return m_values[i]; }

    T x() const { return m_values[0]; }
    T y() const { return m_values[1]; }
    T z() const { return m_values[2]; }

    // Operators
    inline Vector& operator+=(const Vector& rhs);
    inline Vector& operator-=(const Vector& rhs);
    inline Vector& operator*=(Scalar rhs);
    inline Vector& operator/=(Scalar rhs);

  private:
    T m_values[N];
  };

  // Disallow 0-sized Vectors
  template <typename T>
  class Vector<0, T>;

  // Traits specialization
  template <std::size_t N, typename T>
  class Traits<Vector<N, T> >
  {
  public:
    typedef typename Traits<T>::Scalar Scalar;

  private:
    Traits();
  };

  // Unary operators

  template <std::size_t N, typename T>
  inline Vector<N, T>
  operator+(const Vector<N, T>& rhs)
  {
    return rhs;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>
  operator-(const Vector<N, T>& rhs)
  {
    Vector<N, T> res;
    for (std::size_t i = 0; i < N; ++i) {
      res[i] = -rhs[i];
    }
    return res;
  }

  template <std::size_t N, typename T>
  inline typename Vector<N, T>::Scalar
  norm(const Vector<N, T>& v)
  {
    using std::sqrt;
    return sqrt(dot(v, v));
  }

  template <std::size_t N, typename T>
  inline typename Vector<N, T>::Scalar
  abs(const Vector<N, T>& v)
  {
    return norm(v);
  }

  // Binary operators

  template <std::size_t N, typename T>
  inline Vector<N, T>
  operator+(const Vector<N, T>& lhs, const Vector<N, T>& rhs)
  {
    Vector<N, T> res = lhs;
    res += rhs;
    return res;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>
  operator-(const Vector<N, T>& lhs, const Vector<N, T>& rhs)
  {
    Vector<N, T> res = lhs;
    res -= rhs;
    return res;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>
  operator*(typename Vector<N, T>::Scalar lhs,
            const Vector<N, T>& rhs)
  {
    Vector<N, T> res = rhs;
    res *= lhs;
    return res;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>
  operator*(const Vector<N, T>& lhs,
            typename Vector<N, T>::Scalar rhs)
  {
    Vector<N, T> res = lhs;
    res *= rhs;
    return res;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>
  operator/(const Vector<N, T>& lhs,
            typename Vector<N, T>::Scalar rhs)
  {
    Vector<N, T> res = lhs;
    res /= rhs;
    return res;
  }

  template <std::size_t N, typename T>
  inline typename Vector<N, T>::Scalar
  dot(const Vector<N, T>& lhs, const Vector<N, T>& rhs)
  {
    typename Vector<N, T>::Scalar res(0);
    for (std::size_t i = 0; i < N; ++i) {
      res += lhs[i]*rhs[i];
    }
    return res;
  }

  template <typename T>
  inline Vector<3, T>
  cross(const Vector<3, T>& lhs, const Vector<3, T>& rhs)
  {
    return Vector<3, T>(lhs.y()*rhs.z() - lhs.z()*rhs.y(),
                        lhs.z()*rhs.x() - lhs.x()*rhs.z(),
                        lhs.x()*rhs.y() - lhs.y()*rhs.x());
  }

  // Stream output

  template <std::size_t N, typename T>
  std::ostream&
  operator<<(std::ostream& ostr, const Vector<N, T>& v)
  {
    ostr << "(" << v[0];
    for (std::size_t i = 1; i < N; ++i) {
      ostr << ", " << v[i];
    }
    return ostr << ")";
  }

  // Implementation

  template <std::size_t N, typename T>
  inline Vector<N, T>&
  Vector<N, T>::operator+=(const Vector<N, T>& rhs)
  {
    for (std::size_t i = 0; i < N; ++i) {
      m_values[i] += rhs.m_values[i];
    }
    return *this;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>&
  Vector<N, T>::operator-=(const Vector<N, T>& rhs)
  {
    for (std::size_t i = 0; i < N; ++i) {
      m_values[i] -= rhs.m_values[i];
    }
    return *this;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>&
  Vector<N, T>::operator*=(typename Vector<N, T>::Scalar rhs)
  {
    for (std::size_t i = 0; i < N; ++i) {
      m_values[i] *= rhs;
    }
    return *this;
  }

  template <std::size_t N, typename T>
  inline Vector<N, T>&
  Vector<N, T>::operator/=(typename Vector<N, T>::Scalar rhs)
  {
    for (std::size_t i = 0; i < N; ++i) {
      m_values[i] /= rhs;
    }
    return *this;
  }
}

#endif // VZ_VECTOR_HPP