Loading [MathJax]/extensions/tex2jax.js
CPP Linear Algebra ToolBox  0.1.0
•All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vector.h
Go to the documentation of this file.
1 
10 #ifndef VECTOR_H
11 #define VECTOR_H
12 
13 #include "utils.h"
14 
25 class Vector {
26  public:
27  /* CONSTRUCTORS */
28  Vector();
29  Vector(uint16_t );
30  Vector(double * , uint16_t );
31  Vector(const Vector & );
32 
33  /* DESTRUCTOR */
34  ~Vector();
35 
36  /* ACCESSORS */
37  uint16_t get_dim() const;
38 
39  /* OEPRATORS */
40  double & operator[](uint16_t ) const;
41  double & operator()(uint16_t ) const;
42 
43  Vector & operator=(const Vector & );
44  Vector & operator+=(const Vector & );
45  Vector & operator-=(const Vector & );
46 
47  Vector operator-() const;
48 
49  friend bool operator==(const Vector & , const Vector & );
50  friend double operator*(const Vector & , const Vector & );
51  friend Vector operator*(const double , const Vector & );
52  friend Vector operator*(const Vector & , const double );
53  friend Vector operator+(const Vector & , const Vector & );
54  friend Vector operator+(const double , const Vector & );
55  friend Vector operator+(const Vector & , const double );
56  friend Vector operator-(const Vector & , const Vector & );
57  friend Vector operator-(const double , const Vector & );
58  friend Vector operator-(const Vector & , const double );
59  friend Vector operator/(const Vector & , const double );
60  friend std::ostream & operator<<(std::ostream & , const Vector & );
61 
62  /* METHODS */
63  double norm(uint8_t );
64  double norm1();
65  double norm2();
66  double normp(uint8_t );
67  double normInf();
68  void sort();
69  std::vector<double> to_std_vector();
70 
71  /* STATIC METHODS */
72  static Vector basis(uint16_t , uint16_t );
73  static Vector zeros(uint16_t );
74  static Vector ones(uint16_t );
75  static Vector rand(uint16_t );
76  static Vector randn(uint16_t );
77  static Vector randn(uint16_t , double , double );
78  static Vector linspace(double , double , uint16_t );
79 
80  /* FRIEND METHODS */
81  friend Vector abs(const Vector & );
82  friend Vector pow2(const Vector & );
83  friend double prod(const Vector & );
84  friend Vector prod(const Vector & , const Vector & );
85  friend Vector sqrt(const Vector & );
86  friend double sum(const Vector & );
87 
88  private:
89  uint16_t dim;
90  double * data;
92  /* METHODS */
93  uint16_t partition(int , int );
94  void quicksort(int , int );
95 
96  /* STATIC METHODS */
97  static void swap(double *, double * );
98 };
99 
100 #endif
Vector
A lightweight class describing a Vector object. Vectors are array with size n (>0) of doubles.
Definition: vector.h:25
Vector::operator()
double & operator()(uint16_t) const
Access the n-th value of a Vector object. Same as operator [].
Definition: vector.cpp:98
Vector::zeros
static Vector zeros(uint16_t)
Construct a Vector object of length n filled with zeros.
Definition: vector.cpp:469
Vector::basis
static Vector basis(uint16_t, uint16_t)
Construct vector of the canonical basis of .
Definition: vector.cpp:458
Vector::~Vector
~Vector()
Destroy the Vector object.
Definition: vector.cpp:62
Vector::norm1
double norm1()
Compute the norm of a Vector object.
Definition: vector.cpp:379
Vector::operator==
friend bool operator==(const Vector &, const Vector &)
Overload of the equality operator for Vector objects. Two vectors are said to be equal if and only if...
Definition: vector.cpp:175
Vector::norm2
double norm2()
Compute the Euclidean norm of a Vector object.
Definition: vector.cpp:392
Vector::operator[]
double & operator[](uint16_t) const
Access the n-th value of a Vector object.
Definition: vector.cpp:85
Vector::operator/
friend Vector operator/(const Vector &, const double)
Operator to divide a Vector by a scalar.
Definition: vector.cpp:325
Vector::abs
friend Vector abs(const Vector &)
Elementwise absolute value of a vector.
Definition: vector.cpp:559
Vector::rand
static Vector rand(uint16_t)
Construct a Vector object of length filled with random values sampled from 0. to 1.
Definition: vector.cpp:494
Vector::norm
double norm(uint8_t)
A general method to compute the norm of a Vector object.
Definition: vector.cpp:356
Vector::randn
static Vector randn(uint16_t)
Construct a Vector object of length filled with random values sampled from the Gaussian random numbe...
Definition: vector.cpp:508
Vector::operator+=
Vector & operator+=(const Vector &)
Overload operator += for vectors objects.
Definition: vector.cpp:131
Vector::operator<<
friend std::ostream & operator<<(std::ostream &, const Vector &)
Overload output stream operator for Vector object.
Definition: vector.cpp:340
Vector::Vector
Vector()
Construct a new Vector object. Default constructor. Return an empty vector of 0 dimension.
Definition: vector.cpp:10
Vector::sum
friend double sum(const Vector &)
Compute the sum of the element of a vector.
Definition: vector.cpp:627
Vector::sort
void sort()
Sort the vector with the quickSort algorithm.
Definition: vector.cpp:432
Vector::operator-
Vector operator-() const
Operator to get the opposite vector.
Definition: vector.cpp:159
Vector::pow2
friend Vector pow2(const Vector &)
Elementwise square of a vector.
Definition: vector.cpp:572
Vector::normInf
double normInf()
Compute the norm of a Vector object.
Definition: vector.cpp:419
Vector::sqrt
friend Vector sqrt(const Vector &)
Elementwise square root of a vector.
Definition: vector.cpp:612
Vector::to_std_vector
std::vector< double > to_std_vector()
Conversion to a standard library vector object.
Definition: vector.cpp:440
Vector::get_dim
uint16_t get_dim() const
Get the dimension of a Vector object.
Definition: vector.cpp:72
Vector::ones
static Vector ones(uint16_t)
Construct a Vector object of length n filled with ones.
Definition: vector.cpp:480
Vector::normp
double normp(uint8_t)
Compute the norm of a Vector object.
Definition: vector.cpp:406
Vector::operator-=
Vector & operator-=(const Vector &)
Overload operator -= for vectors objects.
Definition: vector.cpp:146
Vector::prod
friend double prod(const Vector &)
Compute the product of the element of a vector.
Definition: vector.cpp:582
Vector::operator*
friend double operator*(const Vector &, const Vector &)
Dot product between vectors.
Definition: vector.cpp:195
Vector::operator+
friend Vector operator+(const Vector &, const Vector &)
Addition of two vector objects.
Definition: vector.cpp:238
Vector::operator=
Vector & operator=(const Vector &)
Overload the assignement operator. Acts like a copy constructor.
Definition: vector.cpp:109
Vector::linspace
static Vector linspace(double, double, uint16_t)
Construct a Vector object of length n filled with equally points spaced between t0 and t1 included.
Definition: vector.cpp:541