vector_utils.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// Antioch - A Gas Dynamics Thermochemistry Library
//
// Copyright (C) 2014-2016 Paul T. Bauman, Benjamin S. Kirk,
//                         Sylvain Plessis, Roy H. Stonger
//
// Copyright (C) 2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This 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 library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef ANTIOCH_VECTOR_UTILS_H
#define ANTIOCH_VECTOR_UTILS_H

#ifdef ANTIOCH_METAPROGRAMMING_H
#  ifndef ANTIOCH_VECTOR_UTILS_DECL_H
#    error vector_utils_decl.h must be included before metaprogramming.h
#  endif
#endif

// Antioch
#include "antioch/metaprogramming.h"

// C++
#include <cmath>
#include <iostream>
#include <vector>

// Add some overloads

namespace std
{

template <typename T>
inline
std::ostream&
operator<< (std::ostream& output, const std::vector<T>& a)
{
  output << '{';
  const std::size_t size = a.size();
  if (size)
    output << a[0];
  for (std::size_t i=1; i<size; ++i)
    output << ',' << a[i];
  output << '}';
  return output;
}

template <typename T>
inline
std::vector<T>
operator* (const std::vector<T>& src, const T & mul)
{
  std::vector<T> output(src);
  const std::size_t size = src.size();
  for (std::size_t i=1; i<size; ++i)
    output[i] = src[i] * mul;

  return output;
}

template <typename T>
inline
std::vector<T>
operator/ (const std::vector<T>& src, const T & mul)
{
  std::vector<T> output(src);
  const std::size_t size = src.size();
  for (std::size_t i=1; i<size; ++i)
    output[i] = src[i] / mul;

  return output;
}

} // end namespace std

namespace Antioch
{

template <typename T, typename NewScalar>
struct rebind<std::vector<T>, NewScalar>
{
  typedef std::vector<NewScalar> type;
};

template <typename T>
struct has_size<std::vector<T> >
{
  static const bool value = true;
};

template <typename T>
struct return_auto<std::vector<T> >
{
  static const bool value = true;
};

template <typename T>
struct size_type<std::vector<T> >
{
  typedef typename std::vector<T>::size_type type;
};

template <typename T>
struct value_type<std::vector<T> >
{
  typedef T type;
};

template <typename T>
struct raw_value_type<std::vector<T> >
{
  typedef typename raw_value_type<T>::type type;
};

template <typename T>
inline
std::vector<T>
zero_clone(const std::vector<T>& example)
{
  if (example.size())
    return std::vector<T>(example.size(),zero_clone(example[0]));

  return std::vector<T>();
}

template <typename T1, typename T2>
inline
void
zero_clone(std::vector<T1>& output, const std::vector<T2>& example)
{
  const std::size_t sz = example.size();
  output.resize(sz);
  for (std::size_t i=0; i != sz; ++i)
    Antioch::zero_clone(output[i], example[i]);
}

template <typename T, typename Scalar>
inline
std::vector<T>
zero_clone(const std::vector<T>& example, const Scalar& value)
{
  if (example.size())
    return std::vector<T>(example.size(),value);

  return std::vector<T>();
}

// A function for zero-setting vectorized numeric types
template <typename T>
inline
void set_zero(std::vector<T>& a)
{
  if (a.size())
    std::fill(a.begin(), a.end(), zero_clone(a[0]));
}

template <typename T, typename VectorScalar>
inline
std::vector<T> custom_clone(const std::vector<T> & /*vec*/, const VectorScalar & vecsrc, std::vector<unsigned int> & indexes)
{
  std::vector<T> returnval;
  returnval.resize(indexes.size());
  for (std::size_t i=0; i != indexes.size(); ++i)
    returnval[i] = vecsrc[indexes[i]];
  return returnval;
}

} // end namespace Antioch


#endif //ANTIOCH_VECTOR_UTILS_H