augmented_vector.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef AUGMENTED_VECTOR_HPP
#define AUGMENTED_VECTOR_HPP
#include "exceptions.hpp" // for THROW_ASSERT
#include <cmath>          // for sqrtl
#include <cstddef>        // for size_t, ptrdiff_t
#include <string>         // for string
#include <vector>         // for vector

template <class T>
class AugmentedVector
{
 private:
   std::vector<T> internal_vector;

 public:
   AugmentedVector<T>() = default;

   AugmentedVector<T>(const size_t _size, T element) : internal_vector(_size, element)
   {
   }

   explicit AugmentedVector<T>(const size_t _size) : internal_vector(_size)
   {
   }

   explicit AugmentedVector<T>(const std::vector<T>& vector) : internal_vector(vector)
   {
   }

   T& operator[](size_t position)
   {
      return internal_vector[position];
   }

   const T& operator[](size_t position) const
   {
      return internal_vector[position];
   }

   T operator*(const AugmentedVector<T>& other) const
   {
      T return_value = 0;
      THROW_ASSERT(internal_vector.size() == other.size(),
                   "Different size in operands: " + std::to_string(internal_vector.size()) + " vs " +
                       std::to_string(other.size()));
      for(size_t i = 0; i < internal_vector.size(); i++)
      {
         return_value += internal_vector[i] * other[i];
      }
      return return_value;
   }

   AugmentedVector<T> operator-(const AugmentedVector<T>& other) const
   {
      AugmentedVector<T> return_value;
      THROW_ASSERT(internal_vector.size() == other.size(),
                   "Different size in operands: " + std::to_string(internal_vector.size()) + " vs " +
                       std::to_string(other.size()));
      for(size_t i = 0; i < internal_vector.size(); i++)
      {
         return_value.internal_vector[i] = internal_vector[i] - other.internal_vector[i];
      }
      return return_value;
   }

   size_t size() const
   {
      return internal_vector.size();
   }

   T Norm2() const
   {
      T return_value = 0;
      for(size_t i = 0; i < internal_vector.size(); i++)
      {
         return_value += internal_vector[i] * internal_vector[i];
      }
      return sqrtl(return_value);
   }

   void get_min(size_t& min) const
   {
      min = 0;
      const size_t _size = this->size();
      for(size_t index = 0; index < _size; index++)
      {
         if(this->internal_vector[index] < this->internal_vector[min])
         {
            min = index;
         }
      }
   }

   void get_min_max(size_t& min, size_t& max) const
   {
      min = 0;
      max = 0;
      const size_t _size = this->size();
      for(size_t index = 0; index < _size; index++)
      {
         if(this->internal_vector[index] > this->internal_vector[max])
         {
            max = index;
         }
         if(this->internal_vector[index] < this->internal_vector[min])
         {
            min = index;
         }
      }
   }

   T get_sum() const
   {
      T return_value = 0;
      const size_t _size = this->size();
      for(size_t index = 0; index < _size; index++)
      {
         return_value += this->internal_vector[index];
      }
      return return_value;
   }

   T get_mean() const
   {
      return this->get_sum() / this->size();
   }

   void remove(const size_t index)
   {
      typename std::vector<T>::iterator it = internal_vector.begin();
      it += static_cast<ptrdiff_t>(index);
      internal_vector.erase(it);
   }

   void clear()
   {
      this->internal_vector.clear();
   }

   void push_back(const T& elem)
   {
      this->internal_vector.push_back(elem);
   }

   void resize(size_t n, T t = T())
   {
      this->internal_vector.resize(n, t);
   }

   void normalize()
   {
      const T sum = get_sum();
      const size_t _size = this->size();
      for(size_t index = 0; index < _size; index++)
      {
         this->internal_vector[index] /= sum;
      }
   }

   void Clear()
   {
      this->internal_vector.clear();
   }
};
#endif