aboutsummaryrefslogtreecommitdiffstats
path: root/meowpp/math/Vector.h
blob: f72b043fbd268d4a58782aa1317a1a6c38a30bed (plain) (blame)
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
#ifndef   math_Vector_H__
#define   math_Vector_H__

#include "../Self.h"
#include "Matrix.h"

#include <vector>

#include <cmath>

namespace meow {

/*!
 * @brief \b vector
 *
 * @author cat_leopard
 */
template<class Scalar>
class Vector {
public:
  typedef typename Matrix<Scalar>::EntryRefK ScalarRefK;
  typedef typename Matrix<Scalar>::EntryRef  ScalarRef ;
private:
  Matrix<Scalar> matrix_;
public:
  /*!
   * @brief constructor
   *
   * With \b dimension=0, which means \b invalid.
   */
  Vector() {
  }

  /*!
   * @brief constructor
   *
   * Copy from another vector
   *
   * @param [in] v another vector
   */
  Vector(Vector const& v): matrix_(v.matrix_) {
  }

  /*!
   * @brief constructor
   *
   * From matrix's first column
   *
   * @param [in] m matrix
   */
  Vector(Matrix<Scalar> const& m): matrix_(m.col(0)) {
  }

  /*!
   * @brief constructor
   *
   * Copy from another std::vector
   *
   * @param [in] v vector
   */
  Vector(std::vector<Scalar> const& v): matrix_(v.size(), 1, Scalar(0)) {
    for (size_t i = 0, I = v.size(); i < I; i++) {
      matrix_.entry(i, 0, v[i]);
    }
  }

  /*!
   * @brief constructor
   *
   * setup dimension and inital value
   *
   * @param [in] d dimension
   * @param [in] e inital value
   */
  Vector(size_t d, Scalar const& e): matrix_(d, 1, e) {
  }

  //! @brief destructor
  ~Vector() {
  }

  //! @brief copy from ...
  Vector& copyFrom(Vector const& v) {
    matrix_.copyFrom(v.matrix_);
    return *this;
  }

  //! @brief reference from ...
  Vector& referenceFrom(Vector const& v) {
    matrix_.referenceFrom(v.matrix_);
    return *this;
  }

  //! @brief Return a \a dimension x 1 matrix form of it
  Matrix<Scalar> matrix() const {
    return matrix_;
  }

  //! @brief return dimension
  size_t dimension() const {
    return matrix_.rows();
  }

  /*!
   * @brief resize the dimension
   *
   * @param [in] d new dimension
   * @param [in] s inital entry
   * @return new dimension
   */
  size_t dimension(size_t d, Scalar const& s) {
    matrix_.rows(d, s);
    return dimension();
  }

  /*!
   * @brief Return whether \c dimension>0 is true or not
   * @return \c true/false
   */
  bool valid() const {
    return (dimension() > 0);
  }

  //! @brief return \a i -th scalar
  Scalar scalar(size_t i) const {
    return matrix_.entry(i, 0);
  }

  /*!
   * @brief change \a i -th scalar
   *
   * @param [in] i i-th
   * @param [in] s new value
   */
  Scalar scalar(size_t i, Scalar const& s) {
    matrix_.entry(i, 0, s);
    return scalar(i);
  }

  //! @brief return \a i -th scalar with non-constant type
  ScalarRef scalarGet(size_t i) {
    return matrix_.entryGet(i);
  }

  /*!
   * @brief change \a i -th to \a j -th scalars
   *
   * @param [in] i i-th
   * @param [in] j j-th
   * @param [in] s new value
   */
  void scalars(size_t i, size_t j, Scalar const& s) {
    for (size_t it = i; it <= j; ++it) {
      matrix_.entry(it, 0, s);
    }
  }

  //! @brief subvector form i-th to j-th
  Vector subVector(size_t i, size_t j) {
    return Vector(matrix_.subMatrix(i, 0, j, 0));
  }

  //! @brief return +\a (*this)
  Vector positive() const {
    return *this;
  }

  //! @brief return -\a (*this)
  Vector negative() const {
    return Vector(matrix_.negative());
  }

  //! @brief return \a (*this)+v
  Vector add(Vector const& v) const {
    return Vector(matrix_.add(v.matrix_));
  }

  //! @brief return \a (*this)-v
  Vector sub(Vector const& v) const {
    return Vector(matrix_.sub(v.matrix_));
  }

  //! @brief return \a (*this)*s , where s is a scalar
  Vector mul(Scalar const& s) const {
    return Vector(matrix_.mul(s));
  }

  //! @brief return \a (*this)/s , where s is a scalar
  Vector div(Scalar const& s) const {
    return Vector(matrix_.div(s));
  }

  //! @brief dot
  Scalar dot(Vector const& v) const {
    return matrix_.transpose().mul(v.matrix_).entry(0, 0);
  }

  //! @brief sqrt of \a length2
  Scalar length() const {
    return Scalar(sqrt((double)length2()));
  }

  //! @brief same as \a (*this).dot(*this)
  Scalar length2() const {
    return dot(*this);
  }

  //! @brief return a normalize form of itself
  Vector normalize() const {
    return div(length());
  }

  //! @brief Let itself be normalize form
  Vector& normalized() {
    copyFrom(normalize());
    return *this;
  }

  //! @brief same as copyFrom
  Vector& operator=(Vector const& v) {
    return copyFrom(v);
  }

  //! @brief same as entry(i)
  Scalar operator()(size_t i) const {
    return scalar(i);
  }

  //! @brief same as positive()
  Vector operator+() const {
    return positive();
  }

  //! @brief same as negative()
  Vector operator-() const {
    return negative();
  }

  //! @brief same as add(v)
  Vector operator+(Vector const& v) const {
    return add(v);
  }

  //! @brief same as sub(v)
  Vector operator-(Vector const& v) const {
    return sub(v);
  }

  //! @brief same as dot(v)
  Scalar operator*(Vector const& v) const {
    return dot(v);
  }

  //! @brief same as mul(s)
  Vector operator*(Scalar const& s) const {
    return mul(s);
  }

  //! @brief same as div(s)
  Vector operator/(Scalar const& s) const {
    return div(s);
  }
};

} // meow

#endif // math_Vector_H__